diff --git a/addons/advanced_throwing/functions/fnc_drawArc.sqf b/addons/advanced_throwing/functions/fnc_drawArc.sqf index 7caeaa3deed..d063340ac76 100644 --- a/addons/advanced_throwing/functions/fnc_drawArc.sqf +++ b/addons/advanced_throwing/functions/fnc_drawArc.sqf @@ -7,7 +7,7 @@ * None * * Return Value: - * Flight path (just for debug) + * Flight path (just for debug) * * Example: * call ace_advanced_throwing_fnc_drawArc diff --git a/addons/artillerytables/functions/fnc_interactMenuOpened.sqf b/addons/artillerytables/functions/fnc_interactMenuOpened.sqf index 676c8cd8f2f..c370e8edced 100644 --- a/addons/artillerytables/functions/fnc_interactMenuOpened.sqf +++ b/addons/artillerytables/functions/fnc_interactMenuOpened.sqf @@ -7,7 +7,7 @@ * 0: Menu Type (1 is self interaction) * * Return Value: - * Can Open + * None * * Example: * [1] call ace_artillerytables_fnc_interactMenuOpened diff --git a/addons/attach/functions/fnc_canAttach.sqf b/addons/attach/functions/fnc_canAttach.sqf index a9277155d95..4918052fb3b 100644 --- a/addons/attach/functions/fnc_canAttach.sqf +++ b/addons/attach/functions/fnc_canAttach.sqf @@ -6,7 +6,7 @@ * Arguments: * 0: vehicle that it will be attached to (player or vehicle) * 1: unit doing the attach (player) - * 2: Array empty or containing a string of the attachable item + * 2: Array empty or containing a string of the attachable item * * Return Value: * Can Attach diff --git a/addons/attach/functions/fnc_placeApprove.sqf b/addons/attach/functions/fnc_placeApprove.sqf index 6af65e37d31..779ad02afd9 100644 --- a/addons/attach/functions/fnc_placeApprove.sqf +++ b/addons/attach/functions/fnc_placeApprove.sqf @@ -15,7 +15,7 @@ * 3: Light Vehicle Classname * 4: On Attach Text * 5: Starting Pos of dummy item - * 5: Orientation of model + * 6: Orientation of model * * Return Value: * None diff --git a/addons/backpacks/functions/fnc_backpackOpened.sqf b/addons/backpacks/functions/fnc_backpackOpened.sqf index 13a70c82129..dbccb0ad770 100644 --- a/addons/backpacks/functions/fnc_backpackOpened.sqf +++ b/addons/backpacks/functions/fnc_backpackOpened.sqf @@ -5,14 +5,13 @@ * * Arguments: * 0: Who accessed your inventory? - * 1: Unit that wields the backpack - * 2: The backpack object + * 1: The backpack object * * Return Value: * None * * Example: - * [bob, kevin, backpack] call ace_backpacks_fnc_backpackOpened + * [bob, backpack] call ace_backpacks_fnc_backpackOpened * * Public: No */ diff --git a/addons/captives/functions/fnc_doApplyHandcuffs.sqf b/addons/captives/functions/fnc_doApplyHandcuffs.sqf index c6a9be8e2a8..9ed9bbb4dc4 100644 --- a/addons/captives/functions/fnc_doApplyHandcuffs.sqf +++ b/addons/captives/functions/fnc_doApplyHandcuffs.sqf @@ -8,7 +8,7 @@ * 1: target * * Return Value: - * The return value + * None * * Example: * [player, bob] call ACE_captives_fnc_doApplyHandcuffs; diff --git a/addons/captives/functions/fnc_doRemoveHandcuffs.sqf b/addons/captives/functions/fnc_doRemoveHandcuffs.sqf index a9a35cd6073..21448ad29f6 100644 --- a/addons/captives/functions/fnc_doRemoveHandcuffs.sqf +++ b/addons/captives/functions/fnc_doRemoveHandcuffs.sqf @@ -8,7 +8,7 @@ * 1: Target * * Return Value: - * The return value + * None * * Example: * [bob, bill] call ACE_captives_fnc_doRemoveHandcuffs diff --git a/addons/captives/functions/fnc_handleGetIn.sqf b/addons/captives/functions/fnc_handleGetIn.sqf index 00a090a6bb7..4b70e889106 100644 --- a/addons/captives/functions/fnc_handleGetIn.sqf +++ b/addons/captives/functions/fnc_handleGetIn.sqf @@ -9,7 +9,7 @@ * 2: _unit * * Return Value: - * The return value + * None * * Example: * [car2, x, player] call ACE_captives_fnc_handleGetIn diff --git a/addons/captives/functions/fnc_handleGetOut.sqf b/addons/captives/functions/fnc_handleGetOut.sqf index 610ec719f69..52fc0574981 100644 --- a/addons/captives/functions/fnc_handleGetOut.sqf +++ b/addons/captives/functions/fnc_handleGetOut.sqf @@ -9,7 +9,7 @@ * 2: _unit * * Return Value: - * The return value + * None * * Example: * [car2, x, player] call ACE_captives_fnc_handleGetOut diff --git a/addons/captives/functions/fnc_handleOnUnconscious.sqf b/addons/captives/functions/fnc_handleOnUnconscious.sqf index a43207fc848..90ce554b505 100644 --- a/addons/captives/functions/fnc_handleOnUnconscious.sqf +++ b/addons/captives/functions/fnc_handleOnUnconscious.sqf @@ -5,7 +5,7 @@ * * Arguments: * 0: Unit - * 0: Is Unconsisisiouses + * 1: Is Unconscious * * Return Value: * None diff --git a/addons/captives/functions/fnc_handlePlayerChanged.sqf b/addons/captives/functions/fnc_handlePlayerChanged.sqf index bafe93bef98..454b2c2853a 100644 --- a/addons/captives/functions/fnc_handlePlayerChanged.sqf +++ b/addons/captives/functions/fnc_handlePlayerChanged.sqf @@ -8,7 +8,7 @@ * 1: _oldUnit * * Return Value: - * The return value + * None * * Example: * [bob1, bob2] call ACE_captives_fnc_handlePlayerChanged diff --git a/addons/captives/functions/fnc_handleUnitInitPost.sqf b/addons/captives/functions/fnc_handleUnitInitPost.sqf index 1045046b2a6..02ca963a8fb 100644 --- a/addons/captives/functions/fnc_handleUnitInitPost.sqf +++ b/addons/captives/functions/fnc_handleUnitInitPost.sqf @@ -7,7 +7,7 @@ * 0: _unit * * Return Value: - * The return value + * None * * Example: * [bob] call ACE_captives_fnc_handleUnitInitPost diff --git a/addons/captives/functions/fnc_setHandcuffed.sqf b/addons/captives/functions/fnc_setHandcuffed.sqf index 53d28cccdb0..b597993d125 100644 --- a/addons/captives/functions/fnc_setHandcuffed.sqf +++ b/addons/captives/functions/fnc_setHandcuffed.sqf @@ -6,7 +6,7 @@ * Arguments: * 0: Unit * 1: True to take captive, false to release captive - * 2: Caller + * 2: Caller (default: objNull) * * Return Value: * None diff --git a/addons/cargo/functions/fnc_getSelectedItem.sqf b/addons/cargo/functions/fnc_getSelectedItem.sqf index b6042ac41b9..bd62fc31858 100644 --- a/addons/cargo/functions/fnc_getSelectedItem.sqf +++ b/addons/cargo/functions/fnc_getSelectedItem.sqf @@ -7,7 +7,7 @@ * None * * Return Value: - * Classname of selected item or selected object (default: nil) + * Classname of selected item or selected object (default: nil) * * Example: * call ace_cargo_fnc_getSelectedItem diff --git a/addons/common/functions/fnc_ASLToPosition.sqf b/addons/common/functions/fnc_ASLToPosition.sqf index 991e79c4331..89b92f948a3 100644 --- a/addons/common/functions/fnc_ASLToPosition.sqf +++ b/addons/common/functions/fnc_ASLToPosition.sqf @@ -9,7 +9,7 @@ * 2: position z * * Return Value: - * None + * * * Example: * [1, 2, 3] call ace_common_fnc_ASLToPosition diff --git a/addons/common/functions/fnc_assignObjectsInList.sqf b/addons/common/functions/fnc_assignObjectsInList.sqf index 0928812cd43..96b0a8cec1f 100644 --- a/addons/common/functions/fnc_assignObjectsInList.sqf +++ b/addons/common/functions/fnc_assignObjectsInList.sqf @@ -5,7 +5,7 @@ * Used by moduleAssign* within various parts of the ACE3 project. * * Arguments: - * 0: List + * 0: List * 1: Variable Name * 2: Value * 3: Global diff --git a/addons/common/functions/fnc_blurScreen.sqf b/addons/common/functions/fnc_blurScreen.sqf index 0ddf920a778..b7660a34fc4 100644 --- a/addons/common/functions/fnc_blurScreen.sqf +++ b/addons/common/functions/fnc_blurScreen.sqf @@ -4,7 +4,7 @@ * Blurs screen. * * Arguments: - * 0: ID + * 0: ID * 1: Show? * * Return Value: diff --git a/addons/common/functions/fnc_cachedCall.sqf b/addons/common/functions/fnc_cachedCall.sqf index 4f067ca717a..b9d016f5c6a 100644 --- a/addons/common/functions/fnc_cachedCall.sqf +++ b/addons/common/functions/fnc_cachedCall.sqf @@ -4,9 +4,9 @@ * Returns the result of the function and caches it up to a given time or event * * Arguments: - * 0: Parameters + * 0: Parameters * 1: Function - * 2: Namespace to store the cache on + * 2: Namespace (any type that supports setVariable) to store the cache on * 3: Cache uid * 4: Max duration of the cache * 5: Events that clear the cache (default: nil) diff --git a/addons/common/functions/fnc_canDig.sqf b/addons/common/functions/fnc_canDig.sqf index bd620d313ac..13c63bfe3cf 100644 --- a/addons/common/functions/fnc_canDig.sqf +++ b/addons/common/functions/fnc_canDig.sqf @@ -4,7 +4,7 @@ * Checks if the player can dig on the surface below (enough dust). * * Arguments: - * 0: Unit or Position (2d/3d) + * 0: Unit or Position (2d/3d) * * Return Value: * Can Dig diff --git a/addons/common/functions/fnc_eraseCache.sqf b/addons/common/functions/fnc_eraseCache.sqf index 1f574db588a..e27c7d73950 100644 --- a/addons/common/functions/fnc_eraseCache.sqf +++ b/addons/common/functions/fnc_eraseCache.sqf @@ -4,7 +4,7 @@ * Deletes a cached result * * Arguments: - * 0: Namespace to store the cache on + * 0: Namespace (any type that supports setVariable) to store the cache on * 1: Cache uid * * Return Value: diff --git a/addons/common/functions/fnc_errorMessage.sqf b/addons/common/functions/fnc_errorMessage.sqf index db77702e980..bd64861862d 100644 --- a/addons/common/functions/fnc_errorMessage.sqf +++ b/addons/common/functions/fnc_errorMessage.sqf @@ -7,7 +7,7 @@ * * Arguments: * 0: Header - * 1: Text + * 1: Text * * Return Value: * None diff --git a/addons/common/functions/fnc_getItemReplacements.sqf b/addons/common/functions/fnc_getItemReplacements.sqf index a8f44bef471..7421f2e3beb 100644 --- a/addons/common/functions/fnc_getItemReplacements.sqf +++ b/addons/common/functions/fnc_getItemReplacements.sqf @@ -8,7 +8,7 @@ * 1: Include type replacements for items (default: true) * * Return Value: - * Item replacements if replacements exist, nil if not + * Item replacements (strings if replacements exist, nil if not) * * Example: * ["FirstAidKit", false] call ace_common_fnc_getItemReplacements diff --git a/addons/common/functions/fnc_getVehicleCodriver.sqf b/addons/common/functions/fnc_getVehicleCodriver.sqf index 366c4db8ff7..36a961b59b3 100644 --- a/addons/common/functions/fnc_getVehicleCodriver.sqf +++ b/addons/common/functions/fnc_getVehicleCodriver.sqf @@ -4,7 +4,7 @@ * Get the vehicle codriver positions. * * Arguments: - * 0: Vehicle type + * 0: Vehicle * * Return Value: * Vehicle codriver positions diff --git a/addons/common/functions/fnc_isPlayer.sqf b/addons/common/functions/fnc_isPlayer.sqf index ae5dc721979..3ac5ed29965 100644 --- a/addons/common/functions/fnc_isPlayer.sqf +++ b/addons/common/functions/fnc_isPlayer.sqf @@ -6,7 +6,7 @@ * * Arguments: * 0: unit to be checked - * 1: exclude remote controlled units + * 1: exclude remote controlled units (default: false) * * Return Value: * Is unit a player? diff --git a/addons/common/functions/fnc_loadPerson.sqf b/addons/common/functions/fnc_loadPerson.sqf index f8fe96d17c0..5271f5d9020 100644 --- a/addons/common/functions/fnc_loadPerson.sqf +++ b/addons/common/functions/fnc_loadPerson.sqf @@ -7,8 +7,8 @@ * 0: Unit that will load * 1: Unit to be loaded * 2: Vehicle that the unit will be loaded in (default: objNull) - * 3: Preferred seats - * 4: Reverse fill + * 3: Preferred seats (default: []) + * 4: Reverse fill (default: false) * * Return Value: * Vehicle that the unitToBeloaded has been loaded in. Returns objNull if function failed diff --git a/addons/common/functions/fnc_normalRandom.sqf b/addons/common/functions/fnc_normalRandom.sqf index 0bded2a318b..c870c627252 100644 --- a/addons/common/functions/fnc_normalRandom.sqf +++ b/addons/common/functions/fnc_normalRandom.sqf @@ -5,8 +5,8 @@ * Uses Box-Muller transform to approximate distribution * * Arguments: - * 0: Mean or - * 1: Standard Deviation or + * 0: Mean + * 1: Standard Deviation * * Return Value: * Pair of random numbers according to normal distribution diff --git a/addons/common/functions/fnc_positionToASL.sqf b/addons/common/functions/fnc_positionToASL.sqf index bc0c436fc23..7eb7c65bc62 100644 --- a/addons/common/functions/fnc_positionToASL.sqf +++ b/addons/common/functions/fnc_positionToASL.sqf @@ -9,7 +9,7 @@ * 2: Position z * * Return Value: - * None + * PosASL * * Example: * [1, 1, 1] call ace_common_fnc_positionToASL diff --git a/addons/common/functions/fnc_rscObjectHelper.sqf b/addons/common/functions/fnc_rscObjectHelper.sqf index 201e46d6e05..2fc80c5e813 100644 --- a/addons/common/functions/fnc_rscObjectHelper.sqf +++ b/addons/common/functions/fnc_rscObjectHelper.sqf @@ -5,7 +5,7 @@ * * Arguments: * 0: Function - * 1: Input array + * 1: Input array * 2: Scale (default: 1) * * Return Value: diff --git a/addons/common/functions/fnc_sendRequest.sqf b/addons/common/functions/fnc_sendRequest.sqf index d5ec9643dab..ac8ccfdb10e 100644 --- a/addons/common/functions/fnc_sendRequest.sqf +++ b/addons/common/functions/fnc_sendRequest.sqf @@ -8,13 +8,13 @@ * 1: target * 2: requestID * 3: requestMessage Will be localized for other target object. - * 4: callback Code called upon accept or decline. + * 4: callback Code called upon accept or decline. * * Return Value: * None * * Example: - * [bob, kevin, "ID", "Message", {callback}] call ace_common_fnc_sendRequest + * [bob, kevin, "ID", "Message", "call code"] call ace_common_fnc_sendRequest * * Public: Yes */ diff --git a/addons/common/functions/fnc_setDead.sqf b/addons/common/functions/fnc_setDead.sqf index f6d62abd349..6e726c747d2 100644 --- a/addons/common/functions/fnc_setDead.sqf +++ b/addons/common/functions/fnc_setDead.sqf @@ -4,10 +4,10 @@ * Kills a unit without changing visual appearance. * * Arguments: - * 0: Unit + * 0: Unit * 1: Reason for death (only used if ace_medical is loaded) (default: "") - * 2: Killer (vehicle that killed unit) (default: objNull) - * 3: Instigator (unit who pulled trigger) (default: objNull) + * 2: Killer (vehicle that killed unit) (default: objNull) + * 3: Instigator (unit who pulled trigger) (default: objNull) * * Return Value: * None diff --git a/addons/common/functions/fnc_statusEffect_addType.sqf b/addons/common/functions/fnc_statusEffect_addType.sqf index 790f1e41269..cefb767d018 100644 --- a/addons/common/functions/fnc_statusEffect_addType.sqf +++ b/addons/common/functions/fnc_statusEffect_addType.sqf @@ -7,7 +7,7 @@ * 0: Status Effect Name, this should match a corresponding event name * 1: Send event globally * 2: Common Effect Reasons to pre-seed during init - * 3: Send event to JIP (requires sending event globally) + * 3: Send event to JIP (requires sending event globally) (default: false) * 4: Event name (default: "ace_common_") * * Return Value: diff --git a/addons/common/functions/fnc_stringToColoredText.sqf b/addons/common/functions/fnc_stringToColoredText.sqf index 94353adf013..f5c242a4c9a 100644 --- a/addons/common/functions/fnc_stringToColoredText.sqf +++ b/addons/common/functions/fnc_stringToColoredText.sqf @@ -8,7 +8,7 @@ * 1: Color * * Return Value: - * Text + * Text * * Example: * ["text", [0, 1, 2]] call ace_common_fnc_stringToColoredText diff --git a/addons/common/functions/fnc_toBitmask.sqf b/addons/common/functions/fnc_toBitmask.sqf index 2efd5414c93..116d1cdd120 100644 --- a/addons/common/functions/fnc_toBitmask.sqf +++ b/addons/common/functions/fnc_toBitmask.sqf @@ -2,12 +2,10 @@ /* * Author: commy2 * Convert an array of booleans into a number. + * Takes Input (limited to float precision) * * Arguments: - * 0: Boolean - * 1: Boolean - * 2: Boolean - * ... + * 0: Boolean (least significant bit) * * Return Value: * Bitmask diff --git a/addons/common/functions/fnc_uniqueItems.sqf b/addons/common/functions/fnc_uniqueItems.sqf index 5b2177a3767..11dc3508e9e 100644 --- a/addons/common/functions/fnc_uniqueItems.sqf +++ b/addons/common/functions/fnc_uniqueItems.sqf @@ -5,8 +5,8 @@ * * Arguments: * 0: Target - * 1: Include magazines - * 0: No (default) + * 1: Include magazines (default: 0) + * 0: No * 1: Yes * 2: Only magazines * diff --git a/addons/common/functions/fnc_updatePlayerVehAttenuation.sqf b/addons/common/functions/fnc_updatePlayerVehAttenuation.sqf index ae5e7505351..f0b7ebd7ccd 100644 --- a/addons/common/functions/fnc_updatePlayerVehAttenuation.sqf +++ b/addons/common/functions/fnc_updatePlayerVehAttenuation.sqf @@ -7,7 +7,7 @@ * None * * Return Value: - * Amount that unit can hear outside + * None * * Example: * call ace_common_fnc_updatePlayerVehAttenuation diff --git a/addons/cookoff/functions/fnc_cookOffLocal.sqf b/addons/cookoff/functions/fnc_cookOffLocal.sqf index 4c61a4e5a63..1668c3017ae 100644 --- a/addons/cookoff/functions/fnc_cookOffLocal.sqf +++ b/addons/cookoff/functions/fnc_cookOffLocal.sqf @@ -7,7 +7,7 @@ * 0: Vehicle * 1: Spawn fire jet * 2: Spawn fire ring - * 3: What selection fire will originate from + * 3: What selection fire will originate from * 4: Cookoff intensity value * 5: Start time * 6: Duration of effect (max 20 seconds) diff --git a/addons/cookoff/functions/fnc_cookOffServer.sqf b/addons/cookoff/functions/fnc_cookOffServer.sqf index d1e5347be5e..87240e37a4e 100644 --- a/addons/cookoff/functions/fnc_cookOffServer.sqf +++ b/addons/cookoff/functions/fnc_cookOffServer.sqf @@ -12,7 +12,7 @@ * 4: Delay between smoke and fire enabled (default: true) * 5: Ammo detonation chance (default: 0) * 6: Detonate after cook-off (default: false) - * 7: Selection for fire source (default: "") + * 7: Selection for fire source (default: "") * 8: Can spawn fire ring (default: true) * 9: Can spawn fire jet (default: true) * 10: Maximum intensity (default: MAX_COOKOFF_INTENSITY) diff --git a/addons/cookoff/functions/fnc_handleDamageBox.sqf b/addons/cookoff/functions/fnc_handleDamageBox.sqf index 846dcdd6b9b..a3654f0cefb 100644 --- a/addons/cookoff/functions/fnc_handleDamageBox.sqf +++ b/addons/cookoff/functions/fnc_handleDamageBox.sqf @@ -7,7 +7,7 @@ * HandleDamage EH * * Return Value: - * Damage to be inflicted (can be nil) + * Damage to be inflicted (can be nil) * * Example: * _this call ace_cookoff_fnc_handleDamageBox diff --git a/addons/csw/functions/fnc_proxyWeapon.sqf b/addons/csw/functions/fnc_proxyWeapon.sqf index 47897c43c22..554b5bfe012 100644 --- a/addons/csw/functions/fnc_proxyWeapon.sqf +++ b/addons/csw/functions/fnc_proxyWeapon.sqf @@ -7,7 +7,7 @@ * 0: CSW * 1: Turret * 2: Proxy weapon needed - * 2: Weapon should be emptied + * 3: Weapon should be emptied * * Return Value: * None diff --git a/addons/dagr/functions/fnc_programWP.sqf b/addons/dagr/functions/fnc_programWP.sqf index 6c992091b47..bd7f8e20aac 100644 --- a/addons/dagr/functions/fnc_programWP.sqf +++ b/addons/dagr/functions/fnc_programWP.sqf @@ -4,9 +4,10 @@ * API to program Waypoints into the DAGR * * Arguments: - * 0: Position (2D,3D) - * 1: Waypoint Name - * 2: Index (Optional) + * 0: Position (2D,3D) + * 1: Waypoint Name (default: "Waypoint") + * 2: Index (default: auto-assign) + * * Return Value: * None * diff --git a/addons/dogtags/functions/fnc_showDogtag.sqf b/addons/dogtags/functions/fnc_showDogtag.sqf index 98b19686bfc..af9789f73ad 100644 --- a/addons/dogtags/functions/fnc_showDogtag.sqf +++ b/addons/dogtags/functions/fnc_showDogtag.sqf @@ -5,7 +5,7 @@ * * Arguments: * 0: Dog tag data - * 1: Display as double tag + * 1: Display as double tag (default: false) * * Return Value: * None diff --git a/addons/dragon/functions/fnc_sightAttach.sqf b/addons/dragon/functions/fnc_sightAttach.sqf index de085942b7d..e2985a31134 100644 --- a/addons/dragon/functions/fnc_sightAttach.sqf +++ b/addons/dragon/functions/fnc_sightAttach.sqf @@ -9,7 +9,7 @@ * 2: Is event (function recursives globaly to set weapon where turret is local) (default: false) * * Return Value: - * Can Attach Sighting Unit + * None * * Example: * [cursorObject, player] call ace_dragon_fnc_sightAttach diff --git a/addons/dragon/functions/fnc_sightDetach.sqf b/addons/dragon/functions/fnc_sightDetach.sqf index a5ac159a335..cb5e27980cd 100644 --- a/addons/dragon/functions/fnc_sightDetach.sqf +++ b/addons/dragon/functions/fnc_sightDetach.sqf @@ -9,7 +9,7 @@ * 2: Is event (function recursives globaly to set weapon where turret is local) (default: false) * * Return Value: - * Can Attach Sighting Unit + * None * * Example: * [cursorObject, player] call ace_dragon_fnc_sightDetach; diff --git a/addons/explosives/functions/fnc_detonateExplosive.sqf b/addons/explosives/functions/fnc_detonateExplosive.sqf index 367d48a672a..f3caad2c175 100644 --- a/addons/explosives/functions/fnc_detonateExplosive.sqf +++ b/addons/explosives/functions/fnc_detonateExplosive.sqf @@ -7,7 +7,7 @@ * 0: Unit (default: objNull) * 1: Max range (-1 to ignore) (default: 0) * 2: Item (default: []) - * - 0: Explosive (default objNull) + * - 0: Explosive (default: objNull) * - 1: Fuse time (default: 0) * 3: Trigger item classname (default: "#unknown") * diff --git a/addons/fastroping/functions/fnc_fastRopeLocalPFH.sqf b/addons/fastroping/functions/fnc_fastRopeLocalPFH.sqf index 2acc0e11258..ffe986e0b5f 100644 --- a/addons/fastroping/functions/fnc_fastRopeLocalPFH.sqf +++ b/addons/fastroping/functions/fnc_fastRopeLocalPFH.sqf @@ -5,7 +5,7 @@ * * Arguments: * 0: PFH arguments - * 1: PFH handle + * 1: PFH handle * * Return Value: * None diff --git a/addons/fastroping/functions/fnc_fastRopeServerPFH.sqf b/addons/fastroping/functions/fnc_fastRopeServerPFH.sqf index 716c0ab43e8..48494aa784e 100644 --- a/addons/fastroping/functions/fnc_fastRopeServerPFH.sqf +++ b/addons/fastroping/functions/fnc_fastRopeServerPFH.sqf @@ -5,7 +5,7 @@ * * Arguments: * 0: PFH arguments - * 1: PFH handle + * 1: PFH handle * * Return Value: * None diff --git a/addons/fire/functions/fnc_isBurning.sqf b/addons/fire/functions/fnc_isBurning.sqf index 04a57c29e6b..7857de5e07b 100644 --- a/addons/fire/functions/fnc_isBurning.sqf +++ b/addons/fire/functions/fnc_isBurning.sqf @@ -7,7 +7,7 @@ * 0: Object * * Return Value: - * None + * Is Burning * * Example: * player call ace_fire_fnc_isBurning diff --git a/addons/flags/functions/fnc_modifyPickupAction.sqf b/addons/flags/functions/fnc_modifyPickupAction.sqf index dcf819d61ed..853eaa36b00 100644 --- a/addons/flags/functions/fnc_modifyPickupAction.sqf +++ b/addons/flags/functions/fnc_modifyPickupAction.sqf @@ -10,7 +10,7 @@ * 3: Action Data * * Return Value: - * Flag items + * None * * Example: * [_target, _player, [], _this select 3] call ace_flags_fnc_modifyPickupAction diff --git a/addons/fortify/functions/fnc_parseSide.sqf b/addons/fortify/functions/fnc_parseSide.sqf index 6af2fac4b49..66a6f577a4b 100644 --- a/addons/fortify/functions/fnc_parseSide.sqf +++ b/addons/fortify/functions/fnc_parseSide.sqf @@ -4,7 +4,7 @@ * Parses the given text and returns a side. * * Arguments: - * 0: Text + * 0: Text * * Return Value: * Side diff --git a/addons/frag/functions/fnc_dev_sphereDraw.sqf b/addons/frag/functions/fnc_dev_sphereDraw.sqf index 31a1393991e..78ce8661b0b 100644 --- a/addons/frag/functions/fnc_dev_sphereDraw.sqf +++ b/addons/frag/functions/fnc_dev_sphereDraw.sqf @@ -18,7 +18,7 @@ params ["_posASL", ["_color", "blue"]]; -if (!isServer) exitWith {}; +if (!isServer) exitWith {objNull}; if (_color select [0,1] != "(") then { _color = switch (toLowerANSI _color) do { diff --git a/addons/grenades/functions/fnc_incendiary.sqf b/addons/grenades/functions/fnc_incendiary.sqf index 8b7aec0e5af..989a3ec61f8 100644 --- a/addons/grenades/functions/fnc_incendiary.sqf +++ b/addons/grenades/functions/fnc_incendiary.sqf @@ -5,7 +5,7 @@ * * Arguments: * 0: Incendiary grenade - * 1: Incendiary lifetime + * 1: Incendiary lifetime * 2: Instigator's side * * Return Value: diff --git a/addons/hearing/functions/fnc_firedNear.sqf b/addons/hearing/functions/fnc_firedNear.sqf index be3ef007d08..4ce812b7e5b 100644 --- a/addons/hearing/functions/fnc_firedNear.sqf +++ b/addons/hearing/functions/fnc_firedNear.sqf @@ -11,7 +11,7 @@ * 4: Muzzle * 5: Current mode of the fired weapon * 6: Ammo - * 7: Unit that fired the weapon + * 7: Unit that fired the weapon * * Return Value: * None diff --git a/addons/hearing/functions/fnc_getAmmoLoudness.sqf b/addons/hearing/functions/fnc_getAmmoLoudness.sqf index 26e8ba9b270..71c8bd2d07a 100644 --- a/addons/hearing/functions/fnc_getAmmoLoudness.sqf +++ b/addons/hearing/functions/fnc_getAmmoLoudness.sqf @@ -8,7 +8,7 @@ * 0: Magazine * * Return Value: - * None + * * * Example: * "30Rnd_65x39_caseless_mag" call ace_hearing_fnc_getAmmoLoudness diff --git a/addons/interact_menu/functions/fnc_isSubPath.sqf b/addons/interact_menu/functions/fnc_isSubPath.sqf index a967f85f2cd..e0f83b34449 100644 --- a/addons/interact_menu/functions/fnc_isSubPath.sqf +++ b/addons/interact_menu/functions/fnc_isSubPath.sqf @@ -5,7 +5,7 @@ * * Arguments: * 0: LongPath - * 1: ShortPath + * 1: ShortPath * * Return Value: * Bool diff --git a/addons/interaction/functions/fnc_getInteractionDistance.sqf b/addons/interaction/functions/fnc_getInteractionDistance.sqf index 002cd6adb12..2f8df25b400 100644 --- a/addons/interaction/functions/fnc_getInteractionDistance.sqf +++ b/addons/interaction/functions/fnc_getInteractionDistance.sqf @@ -5,7 +5,7 @@ * * Arguments: * 0: Player - * 0: Target Vehicle + * 1: Target Vehicle * * Return Value: * Distance to interaction point diff --git a/addons/interaction/functions/fnc_moduleInteraction.sqf b/addons/interaction/functions/fnc_moduleInteraction.sqf index dc7a82a235c..c6455f39208 100644 --- a/addons/interaction/functions/fnc_moduleInteraction.sqf +++ b/addons/interaction/functions/fnc_moduleInteraction.sqf @@ -4,7 +4,7 @@ * Initializes the Interaction module. * * Arguments: - * 0: Logic + * 0: Logic * 1: Units * 2: Activation State * diff --git a/addons/javelin/functions/fnc_onOpticDraw.sqf b/addons/javelin/functions/fnc_onOpticDraw.sqf index 9dfb7d2e484..cd8714ccc49 100644 --- a/addons/javelin/functions/fnc_onOpticDraw.sqf +++ b/addons/javelin/functions/fnc_onOpticDraw.sqf @@ -5,10 +5,11 @@ * * Arguments: * 0: Last run frame - * 0: Current target (what we locked last run) - * 0: Lock start time (cba mission time) - * 0: Next sound play time (ticktime) - * 0: Next target scan (ticktime) + * 1: Current target (what we locked last run) + * 2: Lock start time (cba mission time) + * 3: Next sound play time (ticktime) + * 4: Fire disabled event handler ID + * 5: Next target scan (ticktime) * * Return Value: * None diff --git a/addons/kestrel4500/functions/fnc_updateMemory.sqf b/addons/kestrel4500/functions/fnc_updateMemory.sqf index c717035390d..cbbcfc1f02c 100644 --- a/addons/kestrel4500/functions/fnc_updateMemory.sqf +++ b/addons/kestrel4500/functions/fnc_updateMemory.sqf @@ -5,7 +5,7 @@ * * Arguments: * 0: Slot - * 1: Value + * 1: Value * * Return Value: * None diff --git a/addons/laser/functions/fnc_laserOn.sqf b/addons/laser/functions/fnc_laserOn.sqf index 6e9ce7b0866..9e4105e8a4b 100644 --- a/addons/laser/functions/fnc_laserOn.sqf +++ b/addons/laser/functions/fnc_laserOn.sqf @@ -6,7 +6,7 @@ * Arguments: * 0: Emitter * 1: Owner - * 2: Method, can be code, which emitter and owner are passed to, a string function name, an array with a position memory point and weapon name, or an array with a position memory point, a vector begining memory point, and vector ending memory point. + * 2: Method, can be code, which emitter and owner are passed to, a string function name, an array with a position memory point and weapon name, or an array with a position memory point, a vector begining memory point, and vector ending memory point. * 3: Wavelength (1550nm is typical) * 4: Laser code * 5: Beam divergence (in mils off beam center) diff --git a/addons/laser/functions/fnc_rotateVectLine.sqf b/addons/laser/functions/fnc_rotateVectLine.sqf index 3cdf12c0059..bad3c1060a9 100644 --- a/addons/laser/functions/fnc_rotateVectLine.sqf +++ b/addons/laser/functions/fnc_rotateVectLine.sqf @@ -4,10 +4,11 @@ * * * Argument: - * None + * 0: Map parameters + * 1: Rotation angle theta * * Return Value: - * None + * * * Example: * call ace_laser_fnc_rotateVectLine diff --git a/addons/laser/functions/fnc_rotateVectLineGetMap.sqf b/addons/laser/functions/fnc_rotateVectLineGetMap.sqf index 7a05660f168..1412987781a 100644 --- a/addons/laser/functions/fnc_rotateVectLineGetMap.sqf +++ b/addons/laser/functions/fnc_rotateVectLineGetMap.sqf @@ -4,10 +4,12 @@ * * * Arguments: - * None + * 0: Point to rotate around + * 1: First point defining the line + * 2: Second point defining the line * * Return Value: - * None + * * * Example: * call ace_laser_fnc_rotateVectLineGetMap diff --git a/addons/laser/functions/fnc_shootRay.sqf b/addons/laser/functions/fnc_shootRay.sqf index 9b8341909c3..b3da4a2cccc 100644 --- a/addons/laser/functions/fnc_shootRay.sqf +++ b/addons/laser/functions/fnc_shootRay.sqf @@ -7,7 +7,7 @@ * 0: Origin position ASL * 1: Direction (normalized) * 2: Ignore 1 (e.g. Player's vehicle) (default: objNull) - * 2: Ignore 2 (e.g. Player's vehicle) (default: objNull) + * 3: Ignore 2 (e.g. Player's vehicle) (default: objNull) * * Return Value: * [posASL, distance] - pos will be nil if no intersection diff --git a/addons/markers/functions/fnc_sendMarkersJIP.sqf b/addons/markers/functions/fnc_sendMarkersJIP.sqf index 99ddb4b3c40..dc10abcbf9b 100644 --- a/addons/markers/functions/fnc_sendMarkersJIP.sqf +++ b/addons/markers/functions/fnc_sendMarkersJIP.sqf @@ -4,13 +4,13 @@ * Server: Recives a dummy logic, sends marker data back to the owner. * * Arguments: - * 0: Logic + * 0: Client ID * * Return Value: * None * * Example: - * [onUnloadEvent] call ace_markers_fnc_sendMarkersJIP; + * [6] call ace_markers_fnc_sendMarkersJIP; * * Public: No */ diff --git a/addons/markinglaser/functions/fnc_findTurret.sqf b/addons/markinglaser/functions/fnc_findTurret.sqf index 19b3f36fa3d..19428c30389 100644 --- a/addons/markinglaser/functions/fnc_findTurret.sqf +++ b/addons/markinglaser/functions/fnc_findTurret.sqf @@ -4,7 +4,7 @@ * Finds the turret that has control over the marking laser. * * Arguments: - * 0: Aircraft config + * 0: Aircraft config * * Return Value: * diff --git a/addons/medical/functions/fnc_adjustPainLevel.sqf b/addons/medical/functions/fnc_adjustPainLevel.sqf index 94b246bae39..186b02349f2 100644 --- a/addons/medical/functions/fnc_adjustPainLevel.sqf +++ b/addons/medical/functions/fnc_adjustPainLevel.sqf @@ -9,7 +9,7 @@ * 1: Added amount of pain (can be negative) * * Return Value: - * The new pain level + * None * * Example: * [guy, 0.5] call ace_medical_fnc_adjustPainLevel diff --git a/addons/medical_damage/functions/fnc_interpolatePoints.sqf b/addons/medical_damage/functions/fnc_interpolatePoints.sqf index 22e6c6b5eb9..e6e43673443 100644 --- a/addons/medical_damage/functions/fnc_interpolatePoints.sqf +++ b/addons/medical_damage/functions/fnc_interpolatePoints.sqf @@ -7,7 +7,7 @@ * Arguments: * 0: Input value * 1: Function points, must be in descending order by X (input) value - * 2: Whether to force integer + * 2: Whether to force integer (default: false) * * ReturnValue: * Interpolated result diff --git a/addons/medical_engine/functions/fnc_handleDamage.sqf b/addons/medical_engine/functions/fnc_handleDamage.sqf index de3720fb5c3..ac84f4511e7 100644 --- a/addons/medical_engine/functions/fnc_handleDamage.sqf +++ b/addons/medical_engine/functions/fnc_handleDamage.sqf @@ -9,7 +9,7 @@ * Handle damage EH * * Return Value: - * Damage to be inflicted + * Damage to be inflicted (nil if not local) * * Public: No */ diff --git a/addons/medical_feedback/functions/fnc_effectBleeding.sqf b/addons/medical_feedback/functions/fnc_effectBleeding.sqf index e4469a8e422..b69a19bae04 100644 --- a/addons/medical_feedback/functions/fnc_effectBleeding.sqf +++ b/addons/medical_feedback/functions/fnc_effectBleeding.sqf @@ -5,7 +5,7 @@ * * Arguments: * 0: Enable effect - * 1: Current bloodloss (in l/s) + * 1: Current bloodloss (in l/s) (optional if enable is false) * 2: Instant change (default: false) * * Return Value: diff --git a/addons/medical_feedback/functions/fnc_effectBloodVolume.sqf b/addons/medical_feedback/functions/fnc_effectBloodVolume.sqf index 08a200cbd0c..91c4ae9e0b0 100644 --- a/addons/medical_feedback/functions/fnc_effectBloodVolume.sqf +++ b/addons/medical_feedback/functions/fnc_effectBloodVolume.sqf @@ -5,7 +5,7 @@ * * Arguments: * 0: Enable - * 1: Intensity + * 1: Intensity (optional if enable is false) * * Return Value: * None diff --git a/addons/medical_feedback/functions/fnc_effectBloodVolumeIcon.sqf b/addons/medical_feedback/functions/fnc_effectBloodVolumeIcon.sqf index b03867e4bbe..1df2b4d09f6 100644 --- a/addons/medical_feedback/functions/fnc_effectBloodVolumeIcon.sqf +++ b/addons/medical_feedback/functions/fnc_effectBloodVolumeIcon.sqf @@ -5,7 +5,7 @@ * * Arguments: * 0: Enable - * 1: Intensity 0...6 + * 1: Intensity 0...6 (optional if enable is false) * * Return Value: * None diff --git a/addons/medical_feedback/functions/fnc_effectPain.sqf b/addons/medical_feedback/functions/fnc_effectPain.sqf index 0df6cde5dd0..2c38603164c 100644 --- a/addons/medical_feedback/functions/fnc_effectPain.sqf +++ b/addons/medical_feedback/functions/fnc_effectPain.sqf @@ -5,7 +5,7 @@ * * Arguments: * 0: Enable - * 1: Intensity + * 1: Intensity (optional if enable is false) * * Return Value: * None diff --git a/addons/medical_gui/functions/fnc_updateTriageStatus.sqf b/addons/medical_gui/functions/fnc_updateTriageStatus.sqf index 0ec694409ae..0d15f1d5c4a 100644 --- a/addons/medical_gui/functions/fnc_updateTriageStatus.sqf +++ b/addons/medical_gui/functions/fnc_updateTriageStatus.sqf @@ -4,7 +4,7 @@ * Updates the triage status control for the given target. * * Arguments: - * 0: Display + * 0: Display * 1: Target * * Return Value: diff --git a/addons/medical_treatment/functions/fnc_checkBloodPressure.sqf b/addons/medical_treatment/functions/fnc_checkBloodPressure.sqf index 78a6fcb0155..eb91bfedd39 100644 --- a/addons/medical_treatment/functions/fnc_checkBloodPressure.sqf +++ b/addons/medical_treatment/functions/fnc_checkBloodPressure.sqf @@ -6,7 +6,7 @@ * Arguments: * 0: Medic * 1: Patient - * 2: Body Part + * 2: Body Part * * Return Value: * None diff --git a/addons/medical_treatment/functions/fnc_checkBloodPressureLocal.sqf b/addons/medical_treatment/functions/fnc_checkBloodPressureLocal.sqf index 0c3fe398769..967065060ff 100644 --- a/addons/medical_treatment/functions/fnc_checkBloodPressureLocal.sqf +++ b/addons/medical_treatment/functions/fnc_checkBloodPressureLocal.sqf @@ -6,7 +6,7 @@ * Arguments: * 0: Medic * 1: Patient - * 2: Body Part + * 2: Body Part * * Return Value: * None diff --git a/addons/medical_treatment/functions/fnc_checkPulse.sqf b/addons/medical_treatment/functions/fnc_checkPulse.sqf index 3f776ff7495..a542d62c046 100644 --- a/addons/medical_treatment/functions/fnc_checkPulse.sqf +++ b/addons/medical_treatment/functions/fnc_checkPulse.sqf @@ -6,7 +6,7 @@ * Arguments: * 0: Medic * 1: Patient - * 2: Body Part + * 2: Body Part * * Return Value: * None diff --git a/addons/medical_treatment/functions/fnc_checkPulseLocal.sqf b/addons/medical_treatment/functions/fnc_checkPulseLocal.sqf index 61bda2d8319..31956d2f586 100644 --- a/addons/medical_treatment/functions/fnc_checkPulseLocal.sqf +++ b/addons/medical_treatment/functions/fnc_checkPulseLocal.sqf @@ -6,7 +6,7 @@ * Arguments: * 0: Medic * 1: Patient - * 2: Body Part + * 2: Body Part * * Return Value: * None diff --git a/addons/microdagr/functions/fnc_canShow.sqf b/addons/microdagr/functions/fnc_canShow.sqf index fcc99f6dbf2..e546915fe85 100644 --- a/addons/microdagr/functions/fnc_canShow.sqf +++ b/addons/microdagr/functions/fnc_canShow.sqf @@ -7,7 +7,7 @@ * The display mode to test showing * * Return Value: - * None + * * * Example: * [1] call ace_microdagr_fnc_canShow diff --git a/addons/minedetector/functions/fnc_isDetectorEnabled.sqf b/addons/minedetector/functions/fnc_isDetectorEnabled.sqf index 007a20ea779..33e8df11bee 100644 --- a/addons/minedetector/functions/fnc_isDetectorEnabled.sqf +++ b/addons/minedetector/functions/fnc_isDetectorEnabled.sqf @@ -8,7 +8,7 @@ * 1: Detector type (default: currentWeapon Unit) * * Return Value: - * None + * Is Enabled * * Example: * [player, currentWeapon player] call ace_minedetector_fnc_isDetectorEnabled diff --git a/addons/missile_clgp/functions/fnc_copperhead_uiCanOpen.sqf b/addons/missile_clgp/functions/fnc_copperhead_uiCanOpen.sqf index 5247d0e7bca..8880dad48f7 100644 --- a/addons/missile_clgp/functions/fnc_copperhead_uiCanOpen.sqf +++ b/addons/missile_clgp/functions/fnc_copperhead_uiCanOpen.sqf @@ -7,7 +7,7 @@ * Args * * Return Value: - * None + * * * Example: * [vehicle, player] call ace_missile_clgp_fnc_copperhead_uiCanOpen diff --git a/addons/missileguidance/functions/fnc_changeMissileDirection.sqf b/addons/missileguidance/functions/fnc_changeMissileDirection.sqf index 77858401ba8..64ba3292ee4 100644 --- a/addons/missileguidance/functions/fnc_changeMissileDirection.sqf +++ b/addons/missileguidance/functions/fnc_changeMissileDirection.sqf @@ -6,13 +6,15 @@ * * Arguments: * 0: Projectile - * 1: Direction (unit vector) + * 1: Direction Pitch + * 2: Direction Yaw + * 3: Direction Roll * * Return Value: * None * * Example: - * [missile, [0,1,0]] call ace_missileguidance_fnc_changeMissileDirection; + * [missile, 0, 1, 0] call ace_missileguidance_fnc_changeMissileDirection; * * Public: No */ diff --git a/addons/missileguidance/functions/fnc_checkLos.sqf b/addons/missileguidance/functions/fnc_checkLos.sqf index 57aa5d43c7c..86fed68e797 100644 --- a/addons/missileguidance/functions/fnc_checkLos.sqf +++ b/addons/missileguidance/functions/fnc_checkLos.sqf @@ -6,7 +6,7 @@ * Arguments: * 0: Seeker * 1: Target - * 2: Whether or not to use checkVisibility to test for LOS + * 2: Whether or not to use checkVisibility to test for LOS (default: true) * * Return Value: * Has LOS diff --git a/addons/missileguidance/functions/fnc_gps_getAttackData.sqf b/addons/missileguidance/functions/fnc_gps_getAttackData.sqf index 7101cefd9fb..d0020ff7752 100644 --- a/addons/missileguidance/functions/fnc_gps_getAttackData.sqf +++ b/addons/missileguidance/functions/fnc_gps_getAttackData.sqf @@ -7,7 +7,7 @@ * None * * Return Value: - * None + * * * Example: * [] call ace_missileguidance_fnc_gps_getAttackData diff --git a/addons/nametags/functions/fnc_drawNameTagIcon.sqf b/addons/nametags/functions/fnc_drawNameTagIcon.sqf index ea6f16ebc39..b1996b05360 100644 --- a/addons/nametags/functions/fnc_drawNameTagIcon.sqf +++ b/addons/nametags/functions/fnc_drawNameTagIcon.sqf @@ -7,8 +7,8 @@ * 0: Unit (Player) * 1: Target * 2: Alpha - * 4: Height offset - * 5: Draw name + * 3: Height offset + * 4: Draw name * 5: Draw rank * 6: Draw soundwave * diff --git a/addons/nightvision/functions/fnc_nonDedicatedFix.sqf b/addons/nightvision/functions/fnc_nonDedicatedFix.sqf index 63f8919eafb..1ac87b0582a 100644 --- a/addons/nightvision/functions/fnc_nonDedicatedFix.sqf +++ b/addons/nightvision/functions/fnc_nonDedicatedFix.sqf @@ -4,7 +4,7 @@ * Handles the client who is the non-dedicated server turning on the fog effects. * * Arguments: - * 0: Module + * None * * Return Value: * None diff --git a/addons/overheating/functions/fnc_updateAmmoTemperature.sqf b/addons/overheating/functions/fnc_updateAmmoTemperature.sqf index 870ebbc331d..c186e97d8ed 100644 --- a/addons/overheating/functions/fnc_updateAmmoTemperature.sqf +++ b/addons/overheating/functions/fnc_updateAmmoTemperature.sqf @@ -6,7 +6,7 @@ * Arguments: * 0: Unit * 1: Weapon - * 2: Barrel Temperature + * 2: Barrel Temperature * * Return Value: * New temperature diff --git a/addons/parachute/functions/fnc_handleReserve.sqf b/addons/parachute/functions/fnc_handleReserve.sqf index dd7ba042138..cc7e49d9e18 100644 --- a/addons/parachute/functions/fnc_handleReserve.sqf +++ b/addons/parachute/functions/fnc_handleReserve.sqf @@ -4,10 +4,10 @@ * Cache reserve parachute on player unit when their inventory changes and add it when they open their parachute * * Arguments: - * None + * 0: Unit * * Return Value: - * 0: Unit + * None * * Example: * [player] call ace_parachute_fnc_handleReserve diff --git a/addons/rearm/functions/fnc_getAllRearmTurrets.sqf b/addons/rearm/functions/fnc_getAllRearmTurrets.sqf index 41edfeaabf5..7c44ec31fb3 100644 --- a/addons/rearm/functions/fnc_getAllRearmTurrets.sqf +++ b/addons/rearm/functions/fnc_getAllRearmTurrets.sqf @@ -7,7 +7,7 @@ * This function just adds driver turret to the array returned by "allTurrets". * * Arguments: - * 0: Vehicle + * 0: Vehicle * * Return Value: * Turret paths diff --git a/addons/rearm/functions/fnc_getTurretConfigMagazines.sqf b/addons/rearm/functions/fnc_getTurretConfigMagazines.sqf index d02f54aef84..5067b2e84e3 100644 --- a/addons/rearm/functions/fnc_getTurretConfigMagazines.sqf +++ b/addons/rearm/functions/fnc_getTurretConfigMagazines.sqf @@ -4,7 +4,7 @@ * Returns all magazines a turret of a vehicle object can hold according to config. * * Arguments: - * 0: Vehicle object or typeOf + * 0: Vehicle object or typeOf * 1: Turret Path * * Return Value: diff --git a/addons/refuel/functions/fnc_dropNozzle.sqf b/addons/refuel/functions/fnc_dropNozzle.sqf index ee37a869e10..5d712981580 100644 --- a/addons/refuel/functions/fnc_dropNozzle.sqf +++ b/addons/refuel/functions/fnc_dropNozzle.sqf @@ -6,7 +6,7 @@ * Arguments: * 0: Unit (default: objNull) * 1: Nozzle - * 2: Disconnect Only + * 2: Disconnect Only (default: false) * * Return Value: * None diff --git a/addons/reloadlaunchers/functions/fnc_canLoad.sqf b/addons/reloadlaunchers/functions/fnc_canLoad.sqf index 3e5d6303d16..bb711e08fdf 100644 --- a/addons/reloadlaunchers/functions/fnc_canLoad.sqf +++ b/addons/reloadlaunchers/functions/fnc_canLoad.sqf @@ -10,7 +10,7 @@ * 3: Missile name * * Return Value: - * None + * Can Load * * Example: * [player, cursorTarget, "launch_RPG32_F", "RPG32_F"] call ace_reloadlaunchers_fnc_canLoad diff --git a/addons/repair/functions/fnc_doPatchWheelProgress.sqf b/addons/repair/functions/fnc_doPatchWheelProgress.sqf index 4d9b84ebc2b..c6acd199d8b 100644 --- a/addons/repair/functions/fnc_doPatchWheelProgress.sqf +++ b/addons/repair/functions/fnc_doPatchWheelProgress.sqf @@ -4,15 +4,18 @@ * Called by repair action / progress bar. Raise events to set the new hitpoint damage. * * Arguments: - * 0: Unit that does the patching - * 1: Vehicle to patch - * 2: Selected wheel hitpoint + * 0: Arguments + * 0: Unit that does the patching + * 1: Vehicle to patch + * 2: Selected wheel hitpoint + * 1: Elapsed Time + * 2: Total Time * * Return Value: * Should patching continue? * * Example: - * [unit, vehicle, "hitpoint"] call ace_repair_fnc_doPatchWheelProgress + * [[unit, vehicle, "hitpoint"], 1, 2] call ace_repair_fnc_doPatchWheelProgress * * Public: No */ diff --git a/addons/repair/functions/fnc_getHitPointString.sqf b/addons/repair/functions/fnc_getHitPointString.sqf index 23a57f8895d..fe4e642be5d 100644 --- a/addons/repair/functions/fnc_getHitPointString.sqf +++ b/addons/repair/functions/fnc_getHitPointString.sqf @@ -7,11 +7,11 @@ * 0: Hitpoint * 1: Localized Text * 2: Default Text - * 3: Track Added Hitpoints (default: false) + * 3: Track Added Hitpoints (default: []) * * Return Value: * 0: Text - * 1: Added Hitpoint (default: []) + * 1: Added Hitpoint Info * * Example: * ["HitFuel", "Repairing %1 ...", "Repairing HitFuel"] call ace_repair_fnc_getHitPointString diff --git a/addons/respawn/functions/fnc_updateRallypoint.sqf b/addons/respawn/functions/fnc_updateRallypoint.sqf index bedc887b3c2..642812398bc 100644 --- a/addons/respawn/functions/fnc_updateRallypoint.sqf +++ b/addons/respawn/functions/fnc_updateRallypoint.sqf @@ -4,7 +4,7 @@ * Updates marker position and texts. * * Arguments: - * 0: Marker + * 0: Rallypoint * 1: Side * 2: Position * diff --git a/addons/safemode/functions/fnc_lockSafety.sqf b/addons/safemode/functions/fnc_lockSafety.sqf index b747ad52d25..eca382de94d 100644 --- a/addons/safemode/functions/fnc_lockSafety.sqf +++ b/addons/safemode/functions/fnc_lockSafety.sqf @@ -8,7 +8,7 @@ * 1: Weapon * 2: Muzzle * 3: Show hint (default: true) - * 3: Only unlock (default: false) + * 4: Only unlock (default: false) * * Return Value: * None diff --git a/addons/scopes/functions/fnc_calculateZeroAngleCorrection.sqf b/addons/scopes/functions/fnc_calculateZeroAngleCorrection.sqf index 670a119f839..a1f1fdfa5e6 100644 --- a/addons/scopes/functions/fnc_calculateZeroAngleCorrection.sqf +++ b/addons/scopes/functions/fnc_calculateZeroAngleCorrection.sqf @@ -7,7 +7,7 @@ * 0: Old Zero range * 1: New Zero range * 2: Bore height - * 3: Weapon + * 3: Weapon * 4: Ammo * 5: Magazine * 6: Advanced Ballistics enabled? diff --git a/addons/slideshow/functions/fnc_autoTransition.sqf b/addons/slideshow/functions/fnc_autoTransition.sqf index 6a18a041c47..66a65cc2c1e 100644 --- a/addons/slideshow/functions/fnc_autoTransition.sqf +++ b/addons/slideshow/functions/fnc_autoTransition.sqf @@ -6,7 +6,7 @@ * Arguments: * 0: Objects * 1: Image Paths - * 2: State Variable Name + * 2: State Variable Name * 3: Current Slideshow * 4: Duration (0 disables automatic transitions) * 5: Texture Selection diff --git a/addons/spectator/functions/fnc_getTargetEntities.sqf b/addons/spectator/functions/fnc_getTargetEntities.sqf index 352f3f9c186..0f0a246e97d 100644 --- a/addons/spectator/functions/fnc_getTargetEntities.sqf +++ b/addons/spectator/functions/fnc_getTargetEntities.sqf @@ -5,7 +5,7 @@ * Optionally includes dead units for the list and switching. * * Arguments: - * 0: Include dead + * 0: Include dead (default: false) * * Return Value: * Valid entities diff --git a/addons/spectator/functions/fnc_setFocus.sqf b/addons/spectator/functions/fnc_setFocus.sqf index 6a897506b66..22f96f9b361 100644 --- a/addons/spectator/functions/fnc_setFocus.sqf +++ b/addons/spectator/functions/fnc_setFocus.sqf @@ -4,7 +4,7 @@ * Function used to set the camera focus * * Arguments: - * 0: New focus + * 0: New focus (use true to auto-select) * * Return Value: * None diff --git a/addons/spectator/functions/fnc_ui_handleMapClick.sqf b/addons/spectator/functions/fnc_ui_handleMapClick.sqf index 6dc7719bf30..2e6dfce18bb 100644 --- a/addons/spectator/functions/fnc_ui_handleMapClick.sqf +++ b/addons/spectator/functions/fnc_ui_handleMapClick.sqf @@ -6,8 +6,8 @@ * Arguments: * 0: Map control * 1: Mouse button pressed - * 2: x screen coordinate clicked - * 3: y screen coordinate clicked + * 2: x screen coordinate clicked + * 3: y screen coordinate clicked * * Return Value: * None diff --git a/addons/spike/functions/fnc_camera_switchAway.sqf b/addons/spike/functions/fnc_camera_switchAway.sqf index 033e28d7831..a16355dd20a 100644 --- a/addons/spike/functions/fnc_camera_switchAway.sqf +++ b/addons/spike/functions/fnc_camera_switchAway.sqf @@ -4,7 +4,7 @@ * Switches away from the currently controlled camera * * Arguments: - * 0: Camera + * 0: Camera (default: objNull) * * Return Value: * None diff --git a/addons/spike/functions/fnc_camera_update.sqf b/addons/spike/functions/fnc_camera_update.sqf index c9d819c51bd..bc6743365a7 100644 --- a/addons/spike/functions/fnc_camera_update.sqf +++ b/addons/spike/functions/fnc_camera_update.sqf @@ -4,8 +4,10 @@ * Updates camera to be on a fixed point * * Arguments: - * 0: Guidance Arg Array - * 1: PFID + * 0: Camera Array + * 1: Projectile + * 2: Delta time + * 3: Camera Namespace * * Return Value: * None diff --git a/addons/spike/functions/fnc_camera_updateTargetingGate.sqf b/addons/spike/functions/fnc_camera_updateTargetingGate.sqf index 6cf71711502..35a9964e621 100644 --- a/addons/spike/functions/fnc_camera_updateTargetingGate.sqf +++ b/addons/spike/functions/fnc_camera_updateTargetingGate.sqf @@ -5,7 +5,7 @@ * * Arguments: * 0: Camera - * 0: Camera Array + * 1: Camera Array * * Return Value: * None diff --git a/addons/spike/functions/fnc_camera_userInCamera.sqf b/addons/spike/functions/fnc_camera_userInCamera.sqf index 0357d12d7b2..4318b87c002 100644 --- a/addons/spike/functions/fnc_camera_userInCamera.sqf +++ b/addons/spike/functions/fnc_camera_userInCamera.sqf @@ -4,7 +4,7 @@ * Switches away from the currently controlled camera * * Arguments: - * 0: Camera + * 0: Camera (default: objNull) * * Return Value: * diff --git a/addons/switchunits/functions/fnc_addMapFunction.sqf b/addons/switchunits/functions/fnc_addMapFunction.sqf index 46d4ce9e8f7..c20b78937df 100644 --- a/addons/switchunits/functions/fnc_addMapFunction.sqf +++ b/addons/switchunits/functions/fnc_addMapFunction.sqf @@ -4,14 +4,13 @@ * Adds a mapClick Eventhandler * * Arguments: - * 0: unit - * 1: sides > + * None * * Return Value: * None * * Example: - * [_unit, _sides] call ace_switchunits_fnc_addMapFunction + * [] call ace_switchunits_fnc_addMapFunction * * Public: No */ diff --git a/addons/switchunits/functions/fnc_initPlayer.sqf b/addons/switchunits/functions/fnc_initPlayer.sqf index 49990959b7a..b365dbd9a41 100644 --- a/addons/switchunits/functions/fnc_initPlayer.sqf +++ b/addons/switchunits/functions/fnc_initPlayer.sqf @@ -5,13 +5,12 @@ * * Arguments: * 0: player - * 1: sides > * * Return Value: * None * * Example: - * [player, [west]] call ace_switchunits_fnc_initPlayer + * [player] call ace_switchunits_fnc_initPlayer * * Public: No */ diff --git a/addons/tagging/functions/fnc_compileTagAction.sqf b/addons/tagging/functions/fnc_compileTagAction.sqf index a7011abfe48..339a0c982c6 100644 --- a/addons/tagging/functions/fnc_compileTagAction.sqf +++ b/addons/tagging/functions/fnc_compileTagAction.sqf @@ -4,7 +4,14 @@ * Compiles tags from ACE_Tags and returns children actions. * * Arguments: - * 0: Unit + * 0: Unique Identifier + * 1: Display Name + * 2: Required Item + * 3: Textures Paths + * 4: Icon Path (default: "") + * 5: Material Paths + * 6: Tag Model + * 7: Condition (default: {true}) * * Return Value: * None diff --git a/addons/tagging/functions/fnc_generateStencilTexture.sqf b/addons/tagging/functions/fnc_generateStencilTexture.sqf index 6d8dffdc551..27562986f98 100644 --- a/addons/tagging/functions/fnc_generateStencilTexture.sqf +++ b/addons/tagging/functions/fnc_generateStencilTexture.sqf @@ -9,7 +9,7 @@ * 2: Text Color (in HEX 6 or 8) (default: "000000" - black) * 3: Background Color (in HEX 6 or 8) (default: "00000000" - transparent) * 4: Auto newlines (default: true) - * 4: Texture Dimensions (default: 512) + * 5: Texture Dimensions (default: 512) * * Return Value: * Texture diff --git a/addons/towing/functions/fnc_isSuitableSimulation.sqf b/addons/towing/functions/fnc_isSuitableSimulation.sqf index efda4110926..b3eab113c01 100644 --- a/addons/towing/functions/fnc_isSuitableSimulation.sqf +++ b/addons/towing/functions/fnc_isSuitableSimulation.sqf @@ -5,7 +5,6 @@ * * Arguments: * 0: Vehicle to tow from - * 1: Check type - Parent or Child * * Return Value: * Whether or not this vehicle can tow diff --git a/addons/vector/functions/fnc_adjustBrightness.sqf b/addons/vector/functions/fnc_adjustBrightness.sqf index 25ebe2991d1..b045dfcb93c 100644 --- a/addons/vector/functions/fnc_adjustBrightness.sqf +++ b/addons/vector/functions/fnc_adjustBrightness.sqf @@ -4,13 +4,13 @@ * * * Arguments: - * 0: Number + * 0: Illuminate * * Return Value: * None * * Example: - * [5] call ace_vector_fnc_adjustBrightness + * [true] call ace_vector_fnc_adjustBrightness * * Public: No */ diff --git a/addons/vector/functions/fnc_convertToTexturesDegree.sqf b/addons/vector/functions/fnc_convertToTexturesDegree.sqf index 559c79d5bd6..6adb56a95b9 100644 --- a/addons/vector/functions/fnc_convertToTexturesDegree.sqf +++ b/addons/vector/functions/fnc_convertToTexturesDegree.sqf @@ -7,7 +7,7 @@ * 0: Number * * Return Value: - * None + * Textures * * Example: * [5] call ace_vector_fnc_convertToTexturesDegree diff --git a/addons/vector/functions/fnc_convertToTexturesFOS.sqf b/addons/vector/functions/fnc_convertToTexturesFOS.sqf index 5b831f080ec..7d00d0129d5 100644 --- a/addons/vector/functions/fnc_convertToTexturesFOS.sqf +++ b/addons/vector/functions/fnc_convertToTexturesFOS.sqf @@ -4,14 +4,14 @@ * converts rangefinder distance into array of textures for the vectors scripted info control * * Arguments: - * 0: Number + * 0: Array * 1: Number * * Return Value: * Array * * Example: - * [5, 6] call ace_vector_fnc_convertToTexturesFOS + * [[5], 0] call ace_vector_fnc_convertToTexturesFOS * * Public: No */ diff --git a/addons/vector/functions/fnc_getDistance.sqf b/addons/vector/functions/fnc_getDistance.sqf index dbe8f708183..e8249fe8273 100644 --- a/addons/vector/functions/fnc_getDistance.sqf +++ b/addons/vector/functions/fnc_getDistance.sqf @@ -7,7 +7,7 @@ * None * * Return Value: - * Array + * Distance * * Example: * call ace_vector_fnc_getDistance diff --git a/addons/vector/functions/fnc_nextMode.sqf b/addons/vector/functions/fnc_nextMode.sqf index 7512d8c8928..62165084843 100644 --- a/addons/vector/functions/fnc_nextMode.sqf +++ b/addons/vector/functions/fnc_nextMode.sqf @@ -7,7 +7,7 @@ * 0: Name of mode ("settings", "config") * * Return Value: - * Array + * None * * Example: * ["settings"] call ace_vector_fnc_nextMode diff --git a/addons/vehicle_damage/functions/fnc_handleDamage.sqf b/addons/vehicle_damage/functions/fnc_handleDamage.sqf index 11d06f454fd..369f1f28408 100644 --- a/addons/vehicle_damage/functions/fnc_handleDamage.sqf +++ b/addons/vehicle_damage/functions/fnc_handleDamage.sqf @@ -14,7 +14,7 @@ * 7: Hit point * * Return Value: - * Current or maximum damage of part + * Current or maximum damage of part (nil if not local) * * Example: * [cursorObject, "hit_engine_point", 0.5, player, projectile, 1, player, "HitEngine"] call ace_vehicle_damage_fnc_handleDamage diff --git a/addons/vehicle_damage/functions/fnc_handleDetonation.sqf b/addons/vehicle_damage/functions/fnc_handleDetonation.sqf index 9fdaa3b0c27..f5e1b0545fa 100644 --- a/addons/vehicle_damage/functions/fnc_handleDetonation.sqf +++ b/addons/vehicle_damage/functions/fnc_handleDetonation.sqf @@ -12,7 +12,7 @@ * 5: Person who caused damage * * Return Value: - * None + * Should Detonate Ammo * * Example: * [cursorObject, 0.5, true, player, player] call ace_vehicle_damage_fnc_handleDetonation diff --git a/addons/vehicle_damage/functions/fnc_handleVehicleDamage.sqf b/addons/vehicle_damage/functions/fnc_handleVehicleDamage.sqf index c452a90e737..73dfb4a608e 100644 --- a/addons/vehicle_damage/functions/fnc_handleVehicleDamage.sqf +++ b/addons/vehicle_damage/functions/fnc_handleVehicleDamage.sqf @@ -9,7 +9,7 @@ * 2: Hit index * 3: Selection * 4: Added damage to part - * 5: Projectile + * 5: Projectile * 6: Source of damage * 7: Person who caused damage * diff --git a/addons/vehicle_damage/functions/fnc_processHit.sqf b/addons/vehicle_damage/functions/fnc_processHit.sqf index 261c3c99c2d..81520fffdf0 100644 --- a/addons/vehicle_damage/functions/fnc_processHit.sqf +++ b/addons/vehicle_damage/functions/fnc_processHit.sqf @@ -8,7 +8,7 @@ * 1: Hit point * 2: Hit index * 3: Added damage to part - * 4: Projectile + * 4: Projectile * 5: Source of damage * 6: Person who caused damage * diff --git a/addons/vehicles/functions/fnc_toggleSpeedControl.sqf b/addons/vehicles/functions/fnc_toggleSpeedControl.sqf index bbbaa088763..a3eca4468cc 100644 --- a/addons/vehicles/functions/fnc_toggleSpeedControl.sqf +++ b/addons/vehicles/functions/fnc_toggleSpeedControl.sqf @@ -5,8 +5,8 @@ * Should run as key handler. * * Arguments: - * 0: Cruise Control - * 1: Preserve Speed Limit + * 0: Cruise Control (default: false) + * 1: Preserve Speed Limit (default: false) * * Return Value: * Key handled diff --git a/addons/viewdistance/functions/fnc_setFovBasedOvdPFH.sqf b/addons/viewdistance/functions/fnc_setFovBasedOvdPFH.sqf index db5849d6947..52c55797995 100644 --- a/addons/viewdistance/functions/fnc_setFovBasedOvdPFH.sqf +++ b/addons/viewdistance/functions/fnc_setFovBasedOvdPFH.sqf @@ -4,11 +4,11 @@ * Sets Object View Distance dynamically based on current Field of View, between Object View Distance (minimal value) and View Distance (maximum value) set before this PFH starts. * * Arguments: - * 0: PFH Arguments + * 0: PFH Arguments (not used) * 1: PFH Handle * * Return Value: - * PFH Handle + * None * * Example: * [] call ace_viewdistance_fnc_setFovBasedOvdPFH diff --git a/addons/wardrobe/functions/fnc_addActionsName.sqf b/addons/wardrobe/functions/fnc_addActionsName.sqf index c89c0822836..fe6850b53af 100644 --- a/addons/wardrobe/functions/fnc_addActionsName.sqf +++ b/addons/wardrobe/functions/fnc_addActionsName.sqf @@ -8,7 +8,7 @@ * 1: Desired variant * * Return Value: - * Display name of the action + * Display name of the action * * Example: * [(configFile >> "CfgWeapons" >> "U_B_CTRG_3"), (configFile >> "CfgWeapons" >> "U_B_CTRG_1")] call ace_wardrobe_fnc_addActionsName diff --git a/addons/wardrobe/functions/fnc_compareComponents.sqf b/addons/wardrobe/functions/fnc_compareComponents.sqf index f5afb3d24d3..e0f15de4042 100644 --- a/addons/wardrobe/functions/fnc_compareComponents.sqf +++ b/addons/wardrobe/functions/fnc_compareComponents.sqf @@ -4,13 +4,13 @@ * Function to compare the components of the current and target wearables. * * Arguments: - * 0: Current variant - * 1: Desired variant + * 0: Current variant + * 1: Desired variant * * Return Value: * Nested array - * - 0: Configs of missing components - * - 1: Configs of surplus components + * - 0: Configs of missing components + * - 1: Configs of surplus components * * Example: * [G_Balaclava_blk, G_Balaclava_combat] call ace_wardrobe_fnc_compareComponents diff --git a/addons/winddeflection/functions/fnc_updateTrajectoryPFH.sqf b/addons/winddeflection/functions/fnc_updateTrajectoryPFH.sqf index 6f54dfbba10..8eb3b11d00b 100644 --- a/addons/winddeflection/functions/fnc_updateTrajectoryPFH.sqf +++ b/addons/winddeflection/functions/fnc_updateTrajectoryPFH.sqf @@ -4,14 +4,13 @@ * Handles wind deflection for projectiles. * * Arguments: - * 0: bullet - Object the event handler is assigned to - * 1: airFriction - air friction of the bullet + * None * * Return Value: * None * * Example: - * [bullet, 2] call ace_winddeflection_fnc_updateTrajectoryPFH + * [] call ace_winddeflection_fnc_updateTrajectoryPFH * * Public: No */