Stuff

Arguments, Return Value, (optional)

addons/advanced_ballistics/functions/fnc_displayProtractor.sqf

@@ -3,10 +3,10 @@
  *
  * Displays a protractor in the top left corner of the screen
  *
- * Argument:
+ * Arguments:
  * None
  *
- * Return value:
+ * Return Value:
  * None
  *
  * Public: No

addons/attach/functions/fnc_getChildrenAttachActions.sqf

@@ -3,11 +3,11 @@
  * Show the ammo counts for a static weapon.
  * Called from "insertChildren" on interact_menu
  *
- * Argument:
+ * Arguments:
  * 0: Target <OBJECT>
  * 1: Player <OBJECT>
  *
- * Return value:
+ * Return Value:
  * ChildActiosn<ARRAY>
  *
  * Example:

addons/captives/functions/fnc_canStopEscorting.sqf

@@ -4,7 +4,6 @@
  *
  * Arguments:
  * 0: caller (player) <OBJECT>
- * 1: target <OBJECT><OPTIONAL>
  *
  * Return Value:
  * The return value <BOOL>

addons/cargo/functions/fnc_canLoad.sqf

@@ -6,7 +6,7 @@
  * 0: Player <OBJECT>
  * 1: Object to load <OBJECT>
  *
- * Return value:
+ * Return Value:
  * Can load <BOOL>
  *
  * Example:

addons/cargo/functions/fnc_canLoadItemIn.sqf

@@ -6,7 +6,7 @@
  * 0: Item <OBJECT or STRING>
  * 1: Holder Object (Vehicle) <OBJECT>
  *
- * Return value:
+ * Return Value:
  * Can load in <BOOL>
  *
  * Example:

addons/cargo/functions/fnc_canUnloadItem.sqf

@@ -5,9 +5,9 @@
  * Arguments:
  * 0: loaded Object <OBJECT>
  * 1: Object <OBJECT>
- * 2: Unloader (player) <OPTIONAL><OBJECT>
+ * 2: Unloader (player) (optional)<OBJECT>
  *
- * Return value:
+ * Return Value:
  * Can be unloaded <BOOL>
  *
  * Example:

addons/cargo/functions/fnc_findNearestVehicle.sqf

@@ -5,7 +5,7 @@
  * Arguments:
  * 0: Unit <OBJECT>
  *
- * Return value:
+ * Return Value:
  * Vehicle in Distance <OBJECT>
  *
  * Example:

addons/cargo/functions/fnc_getCargoSpaceLeft.sqf

@@ -5,7 +5,7 @@
  * Arguments:
  * 0: Object <OBJECT>
  *
- * Return value:
+ * Return Value:
  * Cargo space left <NUMBER>
  *
  * Example:

addons/cargo/functions/fnc_getSizeItem.sqf

@@ -5,7 +5,7 @@
  * Arguments:
  * 0: Item <OBJECT or STRING>
  *
- * Return value:
+ * Return Value:
  * Cargo size <NUMBER> (default: -1)
  *
  * Example:

addons/cargo/functions/fnc_handleDestroyed.sqf

@@ -5,7 +5,7 @@
  * Arguments:
  * 0: Object <OBJECT>
  *
- * Return value:
+ * Return Value:
  * None
  *
  * Example:

addons/cargo/functions/fnc_initObject.sqf

@@ -5,7 +5,7 @@
  * Arguments:
  * 0: Object <OBJECT>
  *
- * Return value:
+ * Return Value:
  * None
  *
  * Example:

addons/cargo/functions/fnc_loadItem.sqf

@@ -7,7 +7,7 @@
  * 0: Item <OBJECT or STRING>
  * 1: Vehicle <OBJECT>
  *
- * Return value:
+ * Return Value:
  * Object loaded <BOOL>
  *
  * Example:

addons/cargo/functions/fnc_makeLoadable.sqf

@@ -7,7 +7,7 @@
  * 1: Set as loadable (default: true) <BOOL><SCALAR>
  * 2: Size. (default: 1) <NUMBER>
  *
- * Return value:
+ * Return Value:
  * None
  *
  * Example:

addons/cargo/functions/fnc_onMenuOpen.sqf

@@ -5,7 +5,7 @@
  * Arguments:
  * 0: Display <DISPLAY>
  *
- * Return value:
+ * Return Value:
  * None
  *
  * Example:

addons/cargo/functions/fnc_startLoadIn.sqf

@@ -6,7 +6,7 @@
  * 0: Player <OBJECT>
  * 1: Object <OBJECT>
  *
- * Return value:
+ * Return Value:
  * Load ProgressBar Started <BOOL>
  *
  * Example:

addons/cargo/functions/fnc_startUnload.sqf

@@ -5,7 +5,7 @@
  * Arguments:
  * None
  *
- * Return value:
+ * Return Value:
  * None
  *
  * Example:

addons/cargo/functions/fnc_unloadItem.sqf

@@ -6,7 +6,7 @@
  * 0: Item <OBJECT or STRING>
  * 1: Vehicle <OBJECT>
  *
- * Return value:
+ * Return Value:
  * Object unloaded <BOOL>
  *
  * Example:

addons/cargo/functions/fnc_validateCargoSpace.sqf

@@ -5,7 +5,7 @@
  * Arguments:
  * 0: Object <OBJECT>
  *
- * Return value:
+ * Return Value:
  * None
  *
  * Example:

addons/common/functions/fnc_codeToString.sqf

@@ -5,7 +5,7 @@
  * Arguments:
  * 0: Code <CODE, STRING>
  *
- * Return value:
+ * Return Value:
  * Code <STRING>
  *
  * Public: Yes

addons/common/functions/fnc_displayTextStructured.sqf

@@ -6,7 +6,7 @@
  * 0: Text <ANY>
  * 1: Size of the textbox <NUMBER> (default: 1.5)
  * 2: Target Unit. Will only display if target is the player controlled object <OBJECT> (default: ACE_player)
- * 3: Custom Width <NUMBER><OPTIONAL>
+ * 3: Custom Width <NUMBER>(optional)
  *
  * Return Value:
  * None

addons/common/functions/fnc_dropBackpack.sqf

@@ -5,7 +5,7 @@
  * Arguments:
  * 0: Unit that has a backpack <OBJECT>
  *
- * Return value:
+ * Return Value:
  * Ground wepaon holder with backpack <OBJECT>
  *
  * Public: Yes

addons/common/functions/fnc_dumpArray.sqf

@@ -4,7 +4,7 @@
  *
  * Arguments:
  * 0: Array to be dumped <ARRAY>
- * 1: Depth <NUMBER><OPTIONAL>
+ * 1: Depth <NUMBER>(optional)
  *
  * Return Value:
  * None

addons/common/functions/fnc_findUnloadPosition.sqf

@@ -6,9 +6,9 @@
  * Arguments:
  * 0: Source Vehicle <OBJECT>
  * 1: Cargo Classname <STRING>
- * 2: Unloader (player) <OBJECT><OPTIONAL>
- * 3: Max Distance (meters) <NUMBER><OPTIONAL>
- * 4: Check Vehicle is Stable <BOOL><OPTIONAL>
+ * 2: Unloader (player) <OBJECT>(optional)
+ * 3: Max Distance (meters) <NUMBER>(optional)
+ * 4: Check Vehicle is Stable <BOOL>(optional)
  *
  * Return Value:
  * Unload PositionAGL (Can Be [] if no valid pos found) <ARRAY>

addons/common/functions/fnc_firedEH.sqf

@@ -2,7 +2,7 @@
  * Author: esteldunedain
  * Unfied handling of weapon fire
  *
- * Argument:
+ * Arguments:
  * 0: unit - Object the event handler is assigned to <OBJECT>
  * 1: weapon - Fired weapon <STRING>
  * 2: muzzle - Muzzle that was used <STRING>
@@ -11,7 +11,7 @@
  * 5: magazine - magazine name which was used <STRING>
  * 6: projectile - Object of the projectile that was shot <OBJECT>
  *
- * Return value:
+ * Return Value:
  * None
  *
  * Public: No

addons/common/functions/fnc_fixPosition.sqf

@@ -3,7 +3,7 @@
  *
  * Fixes position of an object. E.g. moves object above ground and adjusts to terrain slope. Requires local object.
  *
- * Argument:
+ * Arguments:
  * Object <OBJECT>
  *
  * Return Value:

addons/common/functions/fnc_getMGRSdata.sqf

@@ -4,7 +4,7 @@
  * Also gets longitude, latitude and altitude offset for the map.
  * Writes return values to GVAR(MGRS_data) if run on the current map.
  *
- * Argument:
+ * Arguments:
  * 0: Map name (default: worldName) <STRING>
  *
  * Return Value:

addons/common/functions/fnc_isInBuilding.sqf

@@ -5,7 +5,7 @@
  * Arguments:
  * 0: Unit <OBJECT>
  *
- * Return value:
+ * Return Value:
  * Is the unit in a building? <BOOL>
  *
  * Public: Yes

addons/common/functions/fnc_monitor.sqf

@@ -2,7 +2,7 @@
  * Author: commy2
  * hint retun value of given function every frame
  *
- * Argument:
+ * Arguments:
  * <CODE>
  *
  * Return Value:

addons/common/functions/fnc_removeAllEventHandlers.sqf

@@ -2,7 +2,7 @@
  * Author: Nou
  * Remove all events of a certain event type.
  *
- * Argument:
+ * Arguments:
  * 0: Event name <STRING>
  *
  * Return Value:

addons/common/functions/fnc_removeEventHandler.sqf

@@ -2,7 +2,7 @@
  * Author: Nou
  * Remove an event handler.
  *
- * Argument:
+ * Arguments:
  * 0: Event name <STRING>
  * 1: Event code <NUMBER>
  *

addons/common/functions/fnc_runAfterSettingsInit.sqf

@@ -2,11 +2,11 @@
  * Author: PabstMirror
  * Executes code after setting are initilized.
  *
- * Argument:
+ * Arguments:
  * 0: Code to execute <CODE>
  * 1: Parameters to run the code with <ANY>
  *
- * Return value:
+ * Return Value:
  * None
  *
  * Example:

addons/common/functions/fnc_serverEvent.sqf

@@ -2,7 +2,7 @@
  * Author: Nou
  * Execute a event only on the server.
  *
- * Argument:
+ * Arguments:
  * 0: Event name <STRING>
  * 1: Event args <ANY>
  *

addons/common/functions/fnc_setApproximateVariablePublic.sqf

@@ -2,13 +2,13 @@
  * Author: esteldunedain
  * Publish a variable if it's different enough from the previously published value.
  *
- * Argument:
+ * Arguments:
  * 0: Object the variable should be assigned to <OBJECT>
  * 1: Name of the variable <STRING>
  * 2: Value of the variable <ANY>
  * 3: Absolute tolerance <NUMBER>
  *
- * Return value:
+ * Return Value:
  * Nothing.
  *
  * Example:

addons/common/functions/fnc_setVariablePublic.sqf

@@ -2,13 +2,13 @@
  * Author: commy2 and CAA-Picard and joko and PabstMirror
  * Publish a variable, but wait a certain amount of time before allowing it to be published it again.
  *
- * Argument:
+ * Arguments:
  * 0: Object the variable should be assigned to <OBJECT>
  * 1: Name of the variable <STRING>
  * 2: Value of the variable <ANY>
  * 3: Embargo delay <NUMBER> (Optional. Default: 1)
  *
- * Return value:
+ * Return Value:
  * Nothing.
  *
  * Example:

addons/common/functions/fnc_showHud.sqf

@@ -4,8 +4,8 @@
  * Bitwise AND Logic (a single false in a mask will make it false)
  *
  * Arguments:
- * 0: Source ID <STRING><OPTIONAL>
- * 1: Show Hud Bool Array (8 to set, empty to remove) <ARRAY><OPTIONAL>
+ * 0: Source ID <STRING>(optional)
+ * 1: Show Hud Bool Array (8 to set, empty to remove) <ARRAY>(optional)
  * - [hud, info, radar, compass, direction, menu, group, cursors]
  * - hud: Boolean - show scripted HUD (same as normal showHUD true/false)
  * - info: Boolean - show vehicle + soldier info (hides weapon info from the HUD as well)

addons/common/functions/fnc_showUser.sqf

@@ -2,7 +2,7 @@
  * Author: commy2
  * hint the Variable ACE_isUsedBy from the input Object every frame
  *
- * Argument:
+ * Arguments:
  * <OBJECT>
  *
  * Return Value:

addons/common/functions/fnc_unloadPersonLocal.sqf

@@ -5,7 +5,7 @@
  * Arguments:
  * 0: unit to unload <OBJECT>
  * 1: Vehicle <OBJECT>
- * 2: Unloader (player) <OBJECT><OPTIONAL>
+ * 2: Unloader (player) <OBJECT>(optional)
  *
  * Return Value:
  * Returns true if succesfully unloaded person <BOOL>

addons/common/functions/fnc_waitUntilAndExecute.sqf

@@ -2,12 +2,12 @@
  * Author: joko // Jonas
  * Executes a code once with after the Condition is True, using a PFH
  *
- * Argument:
+ * Arguments:
  * 0: Condition <CODE>
  * 1: Code to execute <CODE>
  * 2: Parameters to run the code with <ARRAY,ANY,NIL>
  *
- * Return value:
+ * Return Value:
  * None
  *
  * Example:

addons/disarming/functions/fnc_disarmDropItems.sqf

@@ -7,7 +7,7 @@
  * 0: caller (player) <OBJECT>
  * 1: target <OBJECT>
  * 2: classnamess <ARRAY>
- * 3: Do Not Drop Ammo <BOOL><OPTIONAL>
+ * 3: Do Not Drop Ammo <BOOL>(optional)
  *
  * Return Value:
  * Nothing

addons/dragging/functions/fnc_initObject.sqf

@@ -2,7 +2,7 @@
  * Author: commy2
  * Initialize variables for drag or carryable objects. Called from init EH.
  *
- * Argument:
+ * Arguments:
  * 0: Any object <OBJECT>
  *
  * Return Value:

addons/dragging/functions/fnc_initPerson.sqf

@@ -2,10 +2,10 @@
  * Author: commy2
  * Initialize variables for drag or carryable persons. Called from init EH.
  *
- * Argument:
+ * Arguments:
  * 0: Unit <OBJECT>
  *
- * Return value:
+ * Return Value:
  * None
  *
  * Example:

addons/dragging/functions/fnc_isObjectOnObject.sqf

@@ -2,10 +2,10 @@
  * Author: commy2
  * Check if Object is Overlapping
  *
- * Argument:
+ * Arguments:
  * 0: Object <OBJECT>
  *
- * Return value:
+ * Return Value:
  * <BOOL>
  *
  * Example;

addons/dragging/functions/fnc_setCarryable.sqf

@@ -2,7 +2,7 @@
  * Author: commy2
  * Enable the object to be carried.
  *
- * Argument:
+ * Arguments:
  * 0: Any object <OBJECT>
  * 1: true to enable carrying, false to disable <BOOL>
  * 2: Position offset for attachTo command <ARRAY> (default: [0,1,1])

addons/dragging/functions/fnc_setDraggable.sqf

@@ -2,13 +2,13 @@
  * Author: commy2
  * Enable the object to be dragged.
  *
- * Argument:
+ * Arguments:
  * 0: Any object <OBJECT>
  * 1: true to enable dragging, false to disable <BOOL>
  * 2: Position offset for attachTo command (Array, optinal; default: [0,0,0])
  * 3: Direction in degree to rotate the object after attachTo (Number, optional; default: 0)
  *
- * Return value:
+ * Return Value:
  * None
  *
  * Example:

addons/dragging/functions/fnc_startDrag.sqf

@@ -2,11 +2,11 @@
  * Author: commy2
  * Start the dragging process.
  *
- * Argument:
+ * Arguments:
  * 0: Unit that should do the dragging <OBJECT>
  * 1: Object to drag <OBJECT>
  *
- * Return value:
+ * Return Value:
  * None
  *
  * Example:

addons/explosives/functions/fnc_placeExplosive.sqf

@@ -9,7 +9,7 @@
  * 3: Magazine class <STRING>
  * 4: Config of trigger <STRING>
  * 5: Variables required for the trigger type <ARRAY>
- * 6: Explosive placeholder <OBJECT> <OPTIONAL>
+ * 6: Explosive placeholder <OBJECT> (optional)
  *
  * Return Value:
  * Placed explosive <OBJECT>

addons/explosives/functions/fnc_scriptedExplosive.sqf

@@ -5,7 +5,7 @@
  *
  * Arguments:
  * 0: Explosives objects to detonate <OBJECT or ARRAY>
- * 1: Fuze delay (for each explosive; use negative number for random time up to value) <NUMBER> <OPTIONAL>
+ * 1: Fuze delay (for each explosive; use negative number for random time up to value) <NUMBER> (optional)
  *
  * Return Value:
  * None

addons/fcs/functions/fnc_calculateSolution.sqf

@@ -8,7 +8,7 @@
  * 2: Target distance
  * 3: Azimuth offset
  *
- * Return value:
+ * Return Value:
  * None
  *
  * Public: No

addons/fcs/functions/fnc_canResetFCS.sqf

@@ -2,7 +2,7 @@
  * Author: KoffeinFlummi
  * Called from config. Can player reset FCS?
  *
- * Argument:
+ * Arguments:
  * Nothing
  *
  * Return Value:

addons/fcs/functions/fnc_getRange.sqf

@@ -2,13 +2,13 @@
  * Author: commy2
  * Read laser distance measurement from engine.
  *
- * Argument:
+ * Arguments:
  * 0: Measurement Accuracy (default: 1) <NUMBER>
  * 1: Maximum measure distance (default: 5000) <NUMBER>
  * 2: Minimum measure distance (default: 0) <NUMBER>
  * 3: Blank display on range error (default: false) <BOOL>
  *
- * Return value:
+ * Return Value:
  * Measured distance <NUMBER>
  *
  * Public: No

addons/fcs/functions/fnc_updateRangeHUD.sqf

@@ -2,10 +2,10 @@
  * Author: commy2
  * Update compatible info elements.
  *
- * Argument:
+ * Arguments:
  * None
  *
- * Return value:
+ * Return Value:
  * None
  *
  * Public: No

addons/gforces/functions/fnc_addPFEH.sqf

@@ -2,10 +2,10 @@
  * Author: KoffeinFlummi and esteldunedain
  * Adds the PFEH
  *
- * Argument:
+ * Arguments:
  * None
  *
- * Return value:
+ * Return Value:
  * None
  *
  * Public: No

addons/gforces/functions/fnc_pfhUpdateGForces.sqf

@@ -2,11 +2,11 @@
  * Author: KoffeinFlummi and esteldunedain
  * Calculates average g-forces and triggers g-effects
  *
- * Argument:
+ * Arguments:
  * 0: Arguments <ARRAY>
  * 1: pfh_id <NUMBER>
  *
- * Return value:
+ * Return Value:
  * None
  *
  * Public: No

addons/hearing/functions/fnc_updateVolume.sqf

@@ -4,7 +4,7 @@
  *
  * Arguments:
  * 0: Args <ARRAY>
- * -----0: Just update volume (skip ringing/recovery) <BOOL><OPTIONAL>
+ * -----0: Just update volume (skip ringing/recovery) <BOOL>(optional)
  *
  * Return Value:
  * None

addons/interact_menu/functions/fnc_addActionToClass.sqf

@@ -3,13 +3,13 @@
  * Insert an ACE action to a class, under a certain path
  * Note: This function is NOT global.
  *
- * Argument:
+ * Arguments:
  * 0: TypeOf of the class <STRING>
  * 1: Type of action, 0 for actions, 1 for self-actions <NUMBER>
  * 2: Parent path of the new action <ARRAY>
  * 3: Action <ARRAY>
  *
- * Return value:
+ * Return Value:
  * The entry full path, which can be used to remove the entry, or add children entries <ARRAY>.
  *
  * Example:

addons/interact_menu/functions/fnc_addActionToObject.sqf

@@ -3,13 +3,13 @@
  * Insert an ACE action to an object, under a certain config path
  * Note: This function is NOT global.
  *
- * Argument:
+ * Arguments:
  * 0: Object the action should be assigned to <OBJECT>
  * 1: Type of action, 0 for actions, 1 for self-actions <NUMBER>
  * 2: Parent path of the new action <ARRAY>
  * 3: Action <ARRAY>
  *
- * Return value:
+ * Return Value:
  * The entry full path, which can be used to remove the entry, or add children entries <ARRAY>.
  *
  * Example:

addons/interact_menu/functions/fnc_addMainAction.sqf

@@ -2,11 +2,11 @@
  * Author: Jonpas, PabstMirror
  * Makes sure there is a ACE_MainActions on the object type
  *
- * Argument:
+ * Arguments:
  * 0: Object classname <STRING>
  * 1: Type of action, 0 for actions, 1 for self-actions <NUMBER>
  *
- * Return value:
+ * Return Value:
  * None
  *
  * Example:

addons/interact_menu/functions/fnc_collectActiveActionTree.sqf

@@ -2,13 +2,13 @@
  * Author: esteldunedain
  * Collect a entire tree of active actions
  *
- * Argument:
+ * Arguments:
  * 0: Object <OBJECT>
  * 1: Original action tree <ARRAY>
  * 2: Parent path <ARRAY>
  * 3: Distance to base point (will be 0 for self/zeus/in-vehicle) <NUMBER>
  *
- * Return value:
+ * Return Value:
  * Active children <ARRAY>
  *
  * Public: No

addons/interact_menu/functions/fnc_compileMenu.sqf

@@ -2,10 +2,10 @@
  * Author: NouberNou and esteldunedain
  * Compile the action menu from config for an object's class
  *
- * Argument:
+ * Arguments:
  * 0: Object or class name <OBJECT> or <STRING>
  *
- * Return value:
+ * Return Value:
  * None
  *
  * Public: No

addons/interact_menu/functions/fnc_compileMenuSelfAction.sqf

@@ -2,10 +2,10 @@
  * Author: NouberNou and esteldunedain
  * Compile the self action menu from config for an object's class
  *
- * Argument:
+ * Arguments:
  * 0: Object or class name <OBJECT> or <STRING>
  *
- * Return value:
+ * Return Value:
  * None
  *
  * Public: No

addons/interact_menu/functions/fnc_compileMenuZeus.sqf

@@ -2,10 +2,10 @@
  * Author: SilentSpike
  * Compile the zeus action menu (only to be done once)
  *
- * Argument:
+ * Arguments:
  * nil
  *
- * Return value:
+ * Return Value:
  * None
  *
  * Public: No

addons/interact_menu/functions/fnc_createAction.sqf

@@ -3,7 +3,7 @@
  * Creates an isolated ACE action
  * Note: This function is NOT global.
  *
- * Argument:
+ * Arguments:
  * 0: Action name <STRING>
  * 1: Name of the action shown in the menu <STRING>
  * 2: Icon <STRING>
@@ -16,7 +16,7 @@
  * 9: Other parameters [showDisabled,enableInside,canCollapse,runOnHover,doNotCheckLOS] <ARRAY> (Optional)
  * 10: Modifier function <CODE> (Optional)
  *
- * Return value:
+ * Return Value:
  * Action <ARRAY>
  *
  * Example:

addons/interact_menu/functions/fnc_ctrlSetParsedTextCached.sqf

@@ -2,12 +2,12 @@
  * Author: commy2
  * Sets the controls structured text if it isn't already set.
  *
- * Argument:
+ * Arguments:
  * 0: Structured Text Ctrl <CONTROL>
  * 1: Index <NUMBER>
  * 2: Text <STRING>
  *
- * Return value:
+ * Return Value:
  * None
  *
  * Public: No

addons/interact_menu/functions/fnc_findActionNode.sqf

@@ -3,11 +3,11 @@
  * Return action point from path
  * Note: This function is NOT global.
  *
- * Argument:
+ * Arguments:
  * 0: List of Action Tree <ARRAY>
  * 1: Path <ARRAY>
  *
- * Return value:
+ * Return Value:
  * Action node <ARRAY> or <NIL> if not found 
  *
  * Example:

addons/interact_menu/functions/fnc_handlePlayerChanged.sqf

@@ -2,11 +2,11 @@
  * Author: commy2
  * Disables firing while the menu is opened. Called from playerChanged eh.
  *
- * Argument:
+ * Arguments:
  * 0: New unit to add the addAction eh <OBJECT>
  * 1: Old unit to remove the addAction eh <STRING>
  *
- * Return value:
+ * Return Value:
  * None
  */
 #include "script_component.hpp"

addons/interact_menu/functions/fnc_isSubPath.sqf

@@ -2,11 +2,11 @@
  * Author: esteldunedain
  * Check if the first path is a subpath of the other
  *
- * Argument:
+ * Arguments:
  * 0: LongPath <ARRAY>
  * 1: ShortPath <STRING>
  *
- * Return value:
+ * Return Value:
  * Bool
  *
  * Example:

addons/interact_menu/functions/fnc_keyDown.sqf

@@ -2,10 +2,10 @@
  * Author: NouberNou and esteldunedain
  * Handle interactions key down
  *
- * Argument:
+ * Arguments:
  * 0: Type of key: 0 interaction / 1 self interaction <NUMBER>
  *
- * Return value:
+ * Return Value:
  * true <BOOL>
  *
  * Public: No

addons/interact_menu/functions/fnc_keyUp.sqf

@@ -2,10 +2,10 @@
  * Author: NouberNou and esteldunedain
  * Handle interactions key up
  *
- * Argument:
+ * Arguments:
  * 0: Type of key: 0 interaction / 1 self interaction <NUMBER>
  *
- * Return value:
+ * Return Value:
  * true <BOOL>
  *
  * Public: No

addons/interact_menu/functions/fnc_removeActionFromClass.sqf

@@ -2,12 +2,12 @@
  * Author: esteldunedain
  * Removes an action from a class
  *
- * Argument:
+ * Arguments:
  * 0: TypeOf of the class <STRING>
  * 1: Type of action, 0 for actions, 1 for self-actions <NUMBER>
  * 2: Full path of the new action <ARRAY>
  *
- * Return value:
+ * Return Value:
  * None
  *
  * Example:

addons/interact_menu/functions/fnc_removeActionFromObject.sqf

@@ -2,12 +2,12 @@
  * Author: commy2, NouberNou and esteldunedain
  * Removes an action from an object
  *
- * Argument:
+ * Arguments:
  * 0: Object the action is assigned to <OBJECT>
  * 1: Type of action, 0 for actions, 1 for self-actions <NUMBER>
  * 2: Full path of the action to remove <ARRAY>
  *
- * Return value:
+ * Return Value:
  * None
  *
  * Example:

addons/interact_menu/functions/fnc_render.sqf

@@ -2,10 +2,10 @@
  * Author: NouberNou and esteldunedain
  * Render all available nearby interactions
  *
- * Argument:
+ * Arguments:
  * None
  *
- * Return value:
+ * Return Value:
  * None
  *
  * Example:

addons/interact_menu/functions/fnc_renderActionPoints.sqf

@@ -2,10 +2,10 @@
  * Author: NouberNou and esteldunedain
  * Render all action points
  *
- * Argument:
+ * Arguments:
  * None
  *
- * Return value:
+ * Return Value:
  * None
  *
  * Public: No

addons/interact_menu/functions/fnc_renderBaseMenu.sqf

@@ -2,12 +2,12 @@
  * Author: NouberNou and esteldunedain
  * Render the interaction menu for a base action
  *
- * Argument:
+ * Arguments:
  * 0: Object <OBJECT>
  * 1: Action node <ARRAY>
  * 2: 3D position or 2D position <ARRAY> (Optional)
  *
- * Return value:
+ * Return Value:
  * Was the menu rendered <BOOL>
  *
  * Public: No

addons/interact_menu/functions/fnc_renderIcon.sqf

@@ -2,13 +2,13 @@
  * Author: NouberNou and esteldunedain
  * Render a single interaction icon
  *
- * Argument:
+ * Arguments:
  * 0: Text <STRING>
  * 1: Icon <STRING>
  * 2: 2d position <ARRAY>
  * 3: Text Settings <STRING>
  *
- * Return value:
+ * Return Value:
  * None
  *
  * Public: No

addons/interact_menu/functions/fnc_renderMenu.sqf

@@ -2,13 +2,13 @@
  * Author: NouberNou and esteldunedain
  * Render an interaction menu and it's children recursively
  *
- * Argument:
+ * Arguments:
  * 0: Parent path <ARRAY>
  * 1: Action data <ARRAY>
  * 2: 2D position <ARRAY>
  * 3: Angle range available for rendering <ARRAY>
  *
- * Return value:
+ * Return Value:
  * None
  *
  * Public: No

addons/interact_menu/functions/fnc_renderSelector.sqf

@@ -2,11 +2,11 @@
  * Author: esteldunedain
  * Render a single interaction icon
  *
- * Argument:
+ * Arguments:
  * 0: 2d position <ARRAY>
  * 1: Icon <STRING>
  *
- * Return value:
+ * Return Value:
  * None
  *
  * Public: No

addons/interact_menu/functions/fnc_setupTextColors.sqf

@@ -2,10 +2,10 @@
  * Author: PabstMirror
  * Builds color strings needed for displaying interaction text
  *
- * Argument:
+ * Arguments:
  * None
  *
- * Return value:
+ * Return Value:
  * None
  *
  * Public: No

addons/interact_menu/functions/fnc_splitPath.sqf

@@ -2,10 +2,10 @@
  * Author: esteldunedain
  * Take full path and split it between parent path and action name
  *
- * Argument:
+ * Arguments:
  * Full path of the action to remove <ARRAY>
  *
- * Return value:
+ * Return Value:
  * 0: Parent path <ARRAY>
  * 1: Action name <STRING>
  *

addons/interaction/functions/fnc_canJoinTeam.sqf

@@ -6,7 +6,7 @@
  * 0: Player <OBJECT>
  * 1: Target <OBJECT>
  *
- * Return value:
+ * Return Value:
  * Able to join a team <BOOL>
  *
  * Example:

addons/interaction/functions/fnc_getWeaponPos.sqf

@@ -5,7 +5,7 @@
  * Arguments:
  * None (uses local variable _target)
  *
- * Return value:
+ * Return Value:
  * Children actions <ARRAY>
  *
  * Example:

addons/interaction/functions/fnc_hideMouseHint.sqf

@@ -5,7 +5,7 @@
  * Arguments:
  * None
  *
- * Return value:
+ * Return Value:
  * None
  *
  * Example:

addons/interaction/functions/fnc_showMouseHint.sqf

@@ -7,7 +7,7 @@
  * 1: Right Click Text <STRING>
  * 2: Scroll Text <STRING> (Optional)
  *
- * Return value:
+ * Return Value:
  * None
  *
  * Example:

addons/interaction/functions/fnc_switchLamp.sqf

@@ -5,7 +5,7 @@
  * Arguments:
  * 0: Lamp <OBJECT>
  *
- * Return value:
+ * Return Value:
  * None
  *
  * Example:

addons/laser/functions/fnc_laserOff.sqf

@@ -5,7 +5,7 @@
  * Arguments:
  * 0: UUID (from laserOn) <string>
  *
- * Return value:
+ * Return Value:
  * None
  */
 

addons/laser/functions/fnc_laserOn.sqf

@@ -10,7 +10,7 @@
  * 4: Laser code <number>
  * 5: Beam divergence (in mils off beam center).
  *
- * Return value:
+ * Return Value:
  * String, UUID for sending to laserOff function.
  */
 

addons/laser/functions/fnc_seekerFindLaserSpot.sqf

@@ -9,7 +9,7 @@
  * 3: Seeker wavelength sensitivity range, [1550,1550] is common eye safe. <array>
  * 4: Seeker laser code. <number>
  *
- * Return value:
+ * Return Value:
  * Array, [Strongest compatible laser spot ASL pos, owner object] Nil array values if nothing found.
  */
 

addons/laser/functions/fnc_unitTurretCanLockLaser.sqf

@@ -2,10 +2,10 @@
  * Author: jaynus
  * Checks if the turret occupied by the given unit can lock a laser designator and select laser code.
  *
- * Argument:
+ * Arguments:
  * 0: Unit <OBJECT>
  *
- * Return value:
+ * Return Value:
  * Has designator? <BOOL>
  */
 #include "script_component.hpp"

addons/laser/functions/fnc_vanillaLaserSeekerHandler.sqf

@@ -2,11 +2,11 @@
  * Author: jaynus
  * Handler function for laser network code.
  *
- * Argument:
+ * Arguments:
  * 0: Emitter
  * 1: Owner
  * 
- * Return value:
+ * Return Value:
  *    [position, direction]
  */
 //#define DEBUG_MODE_FULL

addons/laser_selfdesignate/functions/fnc_findLaserSource.sqf

@@ -2,7 +2,7 @@
  * Author: jaynus
  * Handler function for laser network code.
  *
- * Argument:
+ * Arguments:
  * 0: Emitter <OBJECT>
  *
  * Return Value:

addons/laser_selfdesignate/functions/fnc_laserHudDesignateOff.sqf

@@ -2,7 +2,7 @@
  * Author: jaynus
  * Turns off passed laser self designation.
  *
- * Argument:
+ * Arguments:
  * 0: Shooter, player shooting the laser
  * 1: LaserUUID, the UUID of the laser returned by EFUNC(laser,laserOn)
  * 2: Local laser target, unused.

addons/magazinerepack/functions/fnc_getMagazineChildren.sqf

@@ -2,11 +2,11 @@
  * Author: PabstMirror, commy2, esteldunedain, Ruthberg
  * Gets magazine children for interaciton menu.
  *
- * Argument:
+ * Arguments:
  * 0: Target <OBJECT>
  * 1: Player <OBJECT>
  *
- * Return value:
+ * Return Value:
  * ChildActions <ARRAY>
  *
  * Example:

addons/map/functions/fnc_compileFlashlightMenu.sqf

@@ -7,7 +7,7 @@
  * 1: Player <OBJECT>
  * 3: Parameters <ARRAY>
  *
- * Return value:
+ * Return Value:
  * None
  *
  * Example:

addons/map/functions/fnc_flashlightGlow.sqf

@@ -5,7 +5,7 @@
  * Arguments:
  * 0: Flashlight classname ("" for off) <STRING>
  *
- * Return value:
+ * Return Value:
  * None
  *
  * Example:

addons/map/functions/fnc_getUnitFlashlights.sqf

@@ -5,7 +5,7 @@
  * Arguments:
  * 0: Unit to check <OBJECT>
  *
- * Return value:
+ * Return Value:
  * Flashlight classnames (empty for none) <ARRAY>
  *
  * Example:

addons/map/functions/fnc_switchFlashlight.sqf

@@ -5,7 +5,7 @@
  * Arguments:
  * 0: Flashlight classname ("" for off) <STRING>
  *
- * Return value:
+ * Return Value:
  * None
  *
  * Example:

addons/maptools/functions/fnc_addLineMarker.sqf

@@ -8,7 +8,7 @@
  * 2: Marker end pos <ARRAY>
  * 3: Color index <NUMBER>
  *
- * Return value:
+ * Return Value:
  * None
  *
  * Public: No

addons/maptools/functions/fnc_calculateMapScale.sqf

@@ -5,7 +5,7 @@
  * Arguments:
  * None
  *
- * Return value:
+ * Return Value:
  * No
  *
  * Public: No

addons/maptools/functions/fnc_canDraw.sqf

@@ -5,7 +5,7 @@
  * Arguments:
  * None
  *
- * Return value:
+ * Return Value:
  * <BOOL>
  *
  * Public: No

addons/maptools/functions/fnc_canUseMapGPS.sqf

@@ -5,7 +5,7 @@
  * Arguments:
  * None
  *
- * Return value:
+ * Return Value:
  * <BOOL>
  *
  * Public: No

addons/maptools/functions/fnc_canUseMapTools.sqf

@@ -5,7 +5,7 @@
  * Arguments:
  * None
  *
- * Return value:
+ * Return Value:
  * <BOOL>
  *
  * Public: No