Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

General - Make type syntax in header more consitent #10681

Open
wants to merge 13 commits into
base: master
Choose a base branch
from
2 changes: 1 addition & 1 deletion addons/ai/functions/fnc_garrison.sqf
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Garrison function used to garrison AI inside buildings.
*
* Arguments:
* 0: The building(s) nearest this position are used <POSITION>
* 0: The building(s) nearest this position are used <ARRAY>
* 1: Limit the building search to those type of building <ARRAY>
* 2: Units that will be garrisoned <ARRAY>
* 3: Radius to fill building(s) <NUMBER> (default: 50)
Expand Down
4 changes: 2 additions & 2 deletions addons/ai/functions/fnc_garrisonMove.sqf
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
*
* Arguments:
* 0: Array of arrays <ARRAY>
* 0: Unit needing to be placed <UNIT>
* 1: Position the unit need to be placed at <POSITION>
* 0: Unit needing to be placed <OBJECT>
* 1: Position the unit need to be placed at <ARRAY>
*
* Return Value:
* Nothing
Expand Down
4 changes: 2 additions & 2 deletions addons/arsenal/functions/fnc_addAction.sqf
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@
* 0: Tabs to add action to <ARRAY>
* 1: Action class (unique string for each action) <STRING>
* 2: Title <STRING>
* 3: Actions <ARRAY of ARRAYS>
* 3: Actions <ARRAY of ARRAYs>
* 4: Condition <CODE> (default: {true})
* 5: Scope editor <NUMBER> (default: 2)
* 6: Update when cargo content changes <BOOL> (default: false)
*
* Return Value:
* 0: Array of IDs <ARRAY of STRINGS>
* 0: Array of IDs <ARRAY of STRINGs>
*
* Example:
* [[0, 5], "TAG_myActions", "My Actions", [
Expand Down
2 changes: 1 addition & 1 deletion addons/arsenal/functions/fnc_addDefaultLoadout.sqf
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
/*
* Author: 654wak654, johnb43
* Adds a loadout to the "Default Loadouts" list.
* If a loadout with a similar name exists (case insensitve), it is overwritten.
* If a loadout with a similar name exists (case insensitive), it is overwritten.
*
* Arguments:
* 0: Name of loadout <STRING>
Expand Down
2 changes: 1 addition & 1 deletion addons/arsenal/functions/fnc_addRightPanelButton.sqf
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
* Adds a right panel button for uniforms, vests and backpacks with defined misc. items.
*
* Arguments:
* 0: Items, must be misc items <ARRAY of STRINGS>
* 0: Items, must be misc items <ARRAY of STRINGs>
* 1: Tooltip <STRING> (default: "")
* 2: Picture path <STRING> (default: QPATHTOF(data\iconCustom.paa))
* 3: Override a specific button (0-9) <NUMBER> (default: -1)
Expand Down
6 changes: 3 additions & 3 deletions addons/arsenal/functions/fnc_addSort.sqf
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
*
* Arguments:
* 0: Tabs to add sort to <ARRAY>
* - 0: Left Tab Indexes <ARRAY of NUMBERS>
* - 1: Right Tab Indexes <ARRAY of NUMBERS>
* - 0: Left Tab Indexes <ARRAY of NUMBERs>
* - 1: Right Tab Indexes <ARRAY of NUMBERs>
* 1: Sort class (a unique string for each algorithm) <STRING>
* 2: Title <STRING>
* 3: Algorithm <CODE>
* 4: Condition <CODE> (default: {true})
*
* Return Value:
* 0: Array of IDs <ARRAY of STRINGS>
* 0: Array of IDs <ARRAY of STRINGs>
*
* Example:
* [[[0, 1], []], "fireRateSort", "Sort by fire rate", {
Expand Down
12 changes: 6 additions & 6 deletions addons/arsenal/functions/fnc_addStat.sqf
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
* Adds a stat to ACE Arsenal.
*
* Arguments:
* 0: Tabs to add the stat to <ARRAY of ARRAYS>
* - 0: Left tab indexes <ARRAY of NUMBERS>
* - 1: Right tab indexes <ARRAY of NUMBERS>
* 0: Tabs to add the stat to <ARRAY of ARRAYs>
* - 0: Left tab indexes <ARRAY of NUMBERs>
* - 1: Right tab indexes <ARRAY of NUMBERs>
* 1: Stat class (unique string for each stat) <STRING>
* 2: Config entries to pass <ARRAY of STRINGS>
* 2: Config entries to pass <ARRAY of STRINGs>
* 3: Title <STRING>
* 4: Show bar / show text bools <ARRAY of BOOLS>
* 4: Show bar / show text bools <ARRAY of BOOLs>
* - 0: Show bar <BOOL> (default: false)
* - 1: Show text <BOOL> (default: false)
* 5: Array of statements <ARRAY of CODE>
Expand All @@ -20,7 +20,7 @@
* 6: Priority <NUMBER> (default: 0)
*
* Return Value:
* 0: Array of IDs <ARRAY of STRINGS>
* 0: Array of IDs <ARRAY of STRINGs>
*
* Example:
* [[[0, 1, 2], [7]], "scopeStat", ["scope"], "Scope", [false, true], [{}, {
Expand Down
2 changes: 1 addition & 1 deletion addons/arsenal/functions/fnc_addVirtualItems.sqf
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
*
* Arguments:
* 0: Target <OBJECT>
* 1: Items <ARRAY of STRINGS> <BOOL>
* 1: Items <ARRAY of STRINGs> <BOOL>
* 2: Add globally <BOOL> (default: false)
*
* Return Value:
Expand Down
2 changes: 1 addition & 1 deletion addons/arsenal/functions/fnc_removeAction.sqf
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Remove a custom action button from ACE Arsenal.
*
* Arguments:
* 0: Array of IDs <ARRAY of STRINGS>
* 0: Array of IDs <ARRAY of STRINGs>
*
* Return Value:
* None
Expand Down
2 changes: 1 addition & 1 deletion addons/arsenal/functions/fnc_removeSort.sqf
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Remove a sort from ACE Arsenal.
*
* Arguments:
* 0: Array of IDs <ARRAY of STRINGS>
* 0: Array of IDs <ARRAY of STRINGs>
*
* Return Value:
* None
Expand Down
2 changes: 1 addition & 1 deletion addons/arsenal/functions/fnc_removeStat.sqf
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Remove a stat from ACE Arsenal.
*
* Arguments:
* 0: Array of IDs <ARRAY of STRINGS>
* 0: Array of IDs <ARRAY of STRINGs>
*
* Return Value:
* None
Expand Down
2 changes: 1 addition & 1 deletion addons/arsenal/functions/fnc_removeVirtualItems.sqf
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
*
* Arguments:
* 0: Target <OBJECT>
* 1: Items <ARRAY of STRINGS> <BOOL>
* 1: Items <ARRAY of STRINGs> <BOOL>
* 2: Remove globally <BOOL> (default: false)
*
* Return Value:
Expand Down
2 changes: 1 addition & 1 deletion addons/arsenal/functions/fnc_replaceUniqueItemsLoadout.sqf
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
* 0: CBA extended loadout or getUnitLoadout array <ARRAY>
*
* Return Value:
* Sanitised loadout <ARRAY> (getUnitLoadout array)
* Sanitized loadout <ARRAY> (getUnitLoadout array)
*
* Example:
* [getUnitLoadout player] call ace_arsenal_fnc_replaceUniqueItemsLoadout
Expand Down
4 changes: 2 additions & 2 deletions addons/arsenal/functions/fnc_statBarStatement_accuracy.sqf
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
* 0: Not used
* 1: Item config path <CONFIG>
* 2: Args <ARRAY>
* - 0: Stat limits <ARRAY of BOOLS>
* - 1: Bar limits <ARRAY of NUMBERS>
* - 0: Stat limits <ARRAY of BOOLs>
* - 1: Bar limits <ARRAY of NUMBERs>
*
* Return Value:
* <NUMBER>
Expand Down
4 changes: 2 additions & 2 deletions addons/arsenal/functions/fnc_statBarStatement_default.sqf
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
* 0: Stat <STRING>
* 1: Item config path <CONFIG>
* 2: Args for configExtreme <ARRAY>
* - 0: Stat limits <ARRAY of BOOLS>
* - 1: Bar limits <ARRAY of NUMBERS>
* - 0: Stat limits <ARRAY of BOOLs>
* - 1: Bar limits <ARRAY of NUMBERs>
* - 2: Evaluate as a logarithmic number <BOOL>
*
* Return Value:
Expand Down
4 changes: 2 additions & 2 deletions addons/arsenal/functions/fnc_statBarStatement_impact.sqf
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
* 0: Stats array <ARRAY>
* 1: Item config path <CONFIG>
* 2: Args for configExtreme <ARRAY>
* - 0: Stats limits <ARRAY of BOOLS>
* - 1: Bar limits <ARRAY of NUMBERS>
* - 0: Stats limits <ARRAY of BOOLs>
* - 1: Bar limits <ARRAY of NUMBERs>
*
* Return Value:
* Number
Expand Down
4 changes: 2 additions & 2 deletions addons/arsenal/functions/fnc_statBarStatement_rateOfFIre.sqf
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
* 0: Not used
* 1: Item config path <CONFIG>
* 2: Args <ARRAY>
* - 0: Stat limits <ARRAY of BOOLS>
* - 1: Bar limits <ARRAY of NUMBERS>
* - 0: Stat limits <ARRAY of BOOLs>
* - 1: Bar limits <ARRAY of NUMBERs>
*
* Return Value:
* Number
Expand Down
2 changes: 1 addition & 1 deletion addons/artillerytables/functions/fnc_rangeTableUpdate.sqf
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Called when listbox selection changes. Updates the rangetable with new values.
*
* Arguments:
* 0: Elevation Mode (true = high,false=low) <BOOL><OPTIONAL>
* 0: Elevation Mode (true = high,false=low) <BOOL> (optional)
*
* Return Value:
* None
Expand Down
6 changes: 3 additions & 3 deletions addons/atragmx/functions/fnc_change_gun.sqf
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
* Selects a new gun profile and updates the gun column and the result input/output fields
*
* Arguments:
* gunID <number>
* restore workingMemory from gunList <BOOL>
* update display <BOOL>
* 0: GunID <NUMBER>
* 1: Restore workingMemory from gunList <BOOL>
* 2: Update display <BOOL>
*
* Return Value:
* None
Expand Down
4 changes: 2 additions & 2 deletions addons/atragmx/functions/fnc_evaluate_option_menu_input.sqf
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
#include "..\script_component.hpp"
/*
* Author: Ruthberg
* Evalutes input from the option menu
* Evaluates input from the option menu
*
* Arguments:
* option menu id <number>
* 0: Option menu id <NUMBER>
*
* Return Value:
* None
Expand Down
6 changes: 3 additions & 3 deletions addons/backpacks/functions/fnc_backpackOpened.sqf
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
* Someone opened your backpack. Play sound and camshake. Execute locally.
*
* Arguments:
* 0: Who accessed your inventory? <Object>
* 1: Unit that wields the backpack <Object>
* 2: The backpack object <Object>
* 0: Who accessed your inventory? <OBJECT>
* 1: Unit that wields the backpack <OBJECT>
* 2: The backpack object <OBJECT>
*
* Return Value:
* None
Expand Down
2 changes: 1 addition & 1 deletion addons/backpacks/functions/fnc_isBackpack.sqf
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Check if the given backpack is an actual backpack that can store items. Parachute, static weapon packs, etc. will return false.
*
* Arguments:
* 0: Backpack <OBJECT, STRING>
* 0: Backpack <OBJECT or STRING>
*
* Return Value:
* Boolean <BOOL>
Expand Down
2 changes: 1 addition & 1 deletion addons/captives/functions/fnc_moduleSettings.sqf
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
* 0: The module logic <OBJECT>
*
* Return Value:
* None <NIL>
* None
*
* Example:
* [LOGIC] call ace_captives_fnc_moduleSettings
Expand Down
4 changes: 2 additions & 2 deletions addons/cargo/functions/fnc_getDelayItem.sqf
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
* Gets the delay duration an item should take to load/unload.
*
* Arguments:
* 0: Item <OBJECT> or <TEXT>
* 1: If delay is for paradrop context <BOOLEAN>
* 0: Item <OBJECT or STRING>
* 1: If delay is for paradrop context <BOOL>
*
* Return Value:
* Item load/unload duration <NUMBER>
Expand Down
4 changes: 2 additions & 2 deletions addons/common/functions/fnc_addActionEventHandler.sqf
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
* Arguments:
* 0: Unit the action should be assigned to <OBJECT>
* 1: Name of the action, e.g. "DefaultAction" <STRING>
* 2: Condition <CODE, STRING>
* 3: Code to execute <CODE, STRING>
* 2: Condition <CODE or STRING>
* 3: Code to execute <CODE or STRING>
*
* Return Value:
* ID of the action (used to remove it later) <NUMBER>
Expand Down
8 changes: 4 additions & 4 deletions addons/common/functions/fnc_addActionMenuEventHandler.sqf
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@
* 0: Unit the action should be assigned to <OBJECT>
* 1: Menu title of the action <STRING>
* 2: Name of the action, e.g. "DefaultAction" <STRING>
* 3: Condition <CODE, STRING>
* 4: Code to execute by the action <CODE, STRING>
* 5: Condition for the menu action <CODE, STRING>
* 6: Code to execute from the menu <CODE, STRING>
* 3: Condition <CODE or STRING>
* 4: Code to execute by the action <CODE or STRING>
* 5: Condition for the menu action <CODE or STRING>
* 6: Code to execute from the menu <CODE or STRING>
* 7: Priority of the action (default: 0) <NUMBER>
*
* Return Value:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Add a map marker creation event handler.
*
* Arguments:
* 0: Code to execute <CODE, STRING>
* 0: Code to execute <CODE or STRING>
*
* Return Value:
* ID of the event script (used to remove it later). <NUMBER>
Expand Down
2 changes: 1 addition & 1 deletion addons/common/functions/fnc_addSwayFactor.sqf
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
* 2: Factor ID, unique to type <STRING>
*
* Return Value:
* Factor added <BOOLEAN>
* Factor added <BOOL>
*
* Example:
* ["baseline", {1}, "ace_common"] call ace_common_fnc_addSwayFactor
Expand Down
2 changes: 1 addition & 1 deletion addons/common/functions/fnc_addSyncedEventHandler.sqf
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
* Arguments:
* 0: Name <STRING>
* 1: Handler <CODE>
* 2: TTL (optional: 0) <NUMBER, CODE>
* 2: TTL <NUMBER or CODE> (default: 0)
*
* Return Value:
* Boolean of success <BOOL>
Expand Down
2 changes: 1 addition & 1 deletion addons/common/functions/fnc_arithmeticGetResult.sqf
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Returns the arithmetic result of performing the given operation on a set.
*
* Arguments:
* 0: Namespace <OBJECT|LOCATION|NAMESPACE>
* 0: Namespace <OBJECT or LOCATION or NAMESPACE>
* 1: Number Set ID <STRING>
* 2: Operation (max, min, sum, product, avg) (Case Sensitive) <STRING>
*
Expand Down
2 changes: 1 addition & 1 deletion addons/common/functions/fnc_arithmeticSetSource.sqf
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Adds or removes a source to an arithmetic set.
*
* Arguments:
* 0: Namespace <OBJECT|LOCATION|NAMESPACE>
* 0: Namespace <OBJECT or LOCATION or NAMESPACE>
* 1: Number Set ID <STRING>
* 2: Source <STRING>
* 3: Code that returns a number (can access var _namespace) [use {} to remove] <CODE>
Expand Down
2 changes: 1 addition & 1 deletion addons/common/functions/fnc_blurScreen.sqf
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
*
* Arguments:
* 0: ID <NUMBER>
* 1: Show? <BOOL, NUMBER>
* 1: Show? <BOOL or NUMBER>
*
* Return Value:
* None
Expand Down
2 changes: 1 addition & 1 deletion addons/common/functions/fnc_changeProjectileDirection.sqf
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
* 0: Projectile <OBJECT>
* 1: Adjust azimuth this much. <NUMBER>
* 2: Adjust inclination this much. <NUMBER>
* 3: Adjust projectile speed this much. In m/s. (optional: 0) <NUMBER>
* 3: Adjust projectile speed this much. In m/s. <NUMBER> (default: 0)
*
* Return Value:
* None
Expand Down
2 changes: 1 addition & 1 deletion addons/common/functions/fnc_claim.sqf
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
* Arguments:
* 0: Unit that claims another object. ObjNull to remove claim. <OBJECT>
* 1: The object that gets claimed. <OBJECT>
* 2: Lock the claimed object aswell? (optional: false) <BOOL>
* 2: Lock the claimed object as well? <BOOL> (default: false)
*
* Return Value:
* None
Expand Down
4 changes: 2 additions & 2 deletions addons/common/functions/fnc_claimSafeServer.sqf
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
* Arguments:
* 0: Unit that claims another object. ObjNull to remove claim. <OBJECT>
* 1: The object that gets claimed. <OBJECT>
* 2: Lock the claimed object aswell? (optional: false) <BOOL>
* 3: Target event to trigger for calling machine (called where _unit is local) <STRING>
* 2: Lock the claimed object as well? <BOOL> (default: false)
* 3: Target event to trigger for calling machine (called where _unit is local) <STRING> (default: No event)
*
* Return Value:
* None
Expand Down
2 changes: 1 addition & 1 deletion addons/common/functions/fnc_codeToString.sqf
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Removes the brackets around a code and returns the code as a string. It does nothing if the code is already a string.
*
* Arguments:
* 0: Code <CODE, STRING>
* 0: Code <CODE or STRING>
*
* Return Value:
* Code <STRING>
Expand Down
Loading
Loading