diff --git a/addons/captives/functions/fnc_canStopEscorting.sqf b/addons/captives/functions/fnc_canStopEscorting.sqf index cfafb5a0e8..181b16be94 100644 --- a/addons/captives/functions/fnc_canStopEscorting.sqf +++ b/addons/captives/functions/fnc_canStopEscorting.sqf @@ -1,13 +1,13 @@ /* * Author: PabstMirror - * Tests if player can stop escorting + * Tests if player can stop escorting. * * Arguments: - * 0: caller (player) - * 1: target + * 0: Caller (player) + * 1: Target (default: objNull) * * Return Value: - * The return value + * Can unit stop escorting another unit * * Example: * [player, bob] call ACE_captives_fnc_canStopEscorting diff --git a/addons/cargo/functions/fnc_canUnloadItem.sqf b/addons/cargo/functions/fnc_canUnloadItem.sqf index 1e8753cc27..9f1722ad08 100644 --- a/addons/cargo/functions/fnc_canUnloadItem.sqf +++ b/addons/cargo/functions/fnc_canUnloadItem.sqf @@ -5,7 +5,7 @@ * Arguments: * 0: loaded Object * 1: Object - * 2: Unloader (player) + * 2: Unloader (player) (default: objNull) * * Return Value: * Can be unloaded diff --git a/addons/chemlights/functions/fnc_throwIR.sqf b/addons/chemlights/functions/fnc_throwIR.sqf index 7d97c99f8e..5d29ccde67 100644 --- a/addons/chemlights/functions/fnc_throwIR.sqf +++ b/addons/chemlights/functions/fnc_throwIR.sqf @@ -5,13 +5,13 @@ * Arguments: * 0: Original throw projectile * 1: Class of projectile - * 2: Adv throw (default: false) + * 2: Adv throw (default: false) * * Return Value: * None * * Example: - * [_projectile, _ammoType] call ace_chemlights_fnc_throwIR; + * [_projectile, _ammoType] call ace_chemlights_fnc_throwIR * * Public: No */ diff --git a/addons/common/functions/fnc_dumpArray.sqf b/addons/common/functions/fnc_dumpArray.sqf index b274f1119e..6c1caf7908 100644 --- a/addons/common/functions/fnc_dumpArray.sqf +++ b/addons/common/functions/fnc_dumpArray.sqf @@ -4,7 +4,7 @@ * * Arguments: * 0: Array to be dumped - * 1: Depth + * 1: Depth (default: 0) * * Return Value: * None diff --git a/addons/common/functions/fnc_findUnloadPosition.sqf b/addons/common/functions/fnc_findUnloadPosition.sqf index c3b0dc3f34..85818cbda1 100644 --- a/addons/common/functions/fnc_findUnloadPosition.sqf +++ b/addons/common/functions/fnc_findUnloadPosition.sqf @@ -1,20 +1,20 @@ /* * Author: PabstMirror, ViperMaul - * Find a safe place near a vehicle to unload something - * Handles Normal Terrain, In Water or On Buildings (Pier, StaticShip) + * Find a safe place near a vehicle to unload something. + * Handles Normal Terrain, In Water or On Buildings (Pier, StaticShip). * * Arguments: * 0: Source Vehicle * 1: Cargo Classname - * 2: Unloader (player) - * 3: Max Distance (meters) - * 4: Check Vehicle is Stable + * 2: Unloader (player) (default: objNull) + * 3: Max Distance (meters) (default: 10) + * 4: Check Vehicle is Stable (default: true) * * Return Value: - * Unload PositionAGL (Can Be [] if no valid pos found) + * Unload PositionAGL (can Be [] if no valid pos found) * * Example: - * [theCar, "CAManBase", player, 10, true] call ace_common_fnc_findUnloadPosition; + * [theCar, "CAManBase", player, 10, true] call ace_common_fnc_findUnloadPosition * * Public: No */ diff --git a/addons/common/functions/fnc_showHud.sqf b/addons/common/functions/fnc_showHud.sqf index 7c91ab3592..4fe088d3a8 100644 --- a/addons/common/functions/fnc_showHud.sqf +++ b/addons/common/functions/fnc_showHud.sqf @@ -1,11 +1,11 @@ /* * Author: PabstMirror - * Allows multiple sources to not overwrite showHud command - * Bitwise AND Logic (a single false in a mask will make it false) + * Allows multiple sources to not overwrite showHud command. + * Bitwise AND Logic (a single false in a mask will make it false). * * Arguments: - * 0: Source ID - * 1: Show Hud Bool Array (8 to set, empty to remove) + * 0: Source ID (default: "") + * 1: Show Hud Bool Array (8 to set, empty to remove) (default: []) * - [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) diff --git a/addons/common/functions/fnc_unloadPersonLocal.sqf b/addons/common/functions/fnc_unloadPersonLocal.sqf index ed5b8dc020..762b643bc1 100644 --- a/addons/common/functions/fnc_unloadPersonLocal.sqf +++ b/addons/common/functions/fnc_unloadPersonLocal.sqf @@ -3,12 +3,12 @@ * Unload a person from a vehicle, local * * Arguments: - * 0: unit to unload + * 0: Unit to unload * 1: Vehicle - * 2: Unloader (player) + * 2: Unloader (player) (default: objNull) * * Return Value: - * Returns true if succesfully unloaded person + * Succesfully unloaded person * * Example: * [bob, car, bob] call ace_common_fnc_unloadpersonLocal diff --git a/addons/common/functions/fnc_watchVariable.sqf b/addons/common/functions/fnc_watchVariable.sqf index 300a5ef195..012a726a6c 100644 --- a/addons/common/functions/fnc_watchVariable.sqf +++ b/addons/common/functions/fnc_watchVariable.sqf @@ -1,27 +1,27 @@ /* * Author: PabstMirror - * Shows multiple watched variables on the main display (for easy debugging) + * Shows multiple watched variables on the main display (for easy debugging). * * Arguments: - * 0: Title (var name) - * 1: Code to generate result (passed nothing, can return any) - * 2: Array containing modifiers + * 0: Title (var name) (default: "") + * 1: Code to generate result (passed nothing, can return any) (default: {}) + * 2: Array containing modifiers (default: []) * For Numbers: - * 0: Show Delta change (default: true) - * 1: Slider Min Value (default: 0) - * 1: Slider Max Value (default: 0) + * 0: Show Delta change (default: true) + * 1: Slider Min Value (default: 0) + * 1: Slider Max Value (default: 0) * For Anything else: - * 0: Number of structured text lines (default: 1) + * 0: Number of structured text lines (default: 1) * * Return Value: * None * * Example: - * ["CBA_missionTime"] call ace_common_fnc_watchVariable; // Uses title as code - * ["diag_frameNo", {diag_frameNo}, [false]] call ace_common_fnc_watchVariable; // Won't show delta - * ["blood", {player getVariable "ace_medical_bloodVolume"}, [true, 0, 100]] call ace_common_fnc_watchVariable; // Shows slider - * ["multiLine text", {"Line 1
Line 2"}, [2]] call ace_common_fnc_watchVariable; - * ["player names", {allPlayers apply {name _x}}, [5]] call ace_common_fnc_watchVariable; // handles any data types + * ["CBA_missionTime"] call ace_common_fnc_watchVariable // Uses title as code + * ["diag_frameNo", {diag_frameNo}, [false]] call ace_common_fnc_watchVariable // Won't show delta + * ["blood", {player getVariable "ace_medical_bloodVolume"}, [true, 0, 100]] call ace_common_fnc_watchVariable // Shows slider + * ["multiLine text", {"Line 1
Line 2"}, [2]] call ace_common_fnc_watchVariable + * ["player names", {allPlayers apply {name _x}}, [5]] call ace_common_fnc_watchVariable // handles any data types * * Public: Yes */ diff --git a/addons/disarming/functions/fnc_disarmDropItems.sqf b/addons/disarming/functions/fnc_disarmDropItems.sqf index af799e25df..9352de4ecc 100644 --- a/addons/disarming/functions/fnc_disarmDropItems.sqf +++ b/addons/disarming/functions/fnc_disarmDropItems.sqf @@ -4,10 +4,10 @@ * Makes a unit drop items * * Arguments: - * 0: caller (player) - * 1: target - * 2: classnamess - * 3: Do Not Drop Ammo + * 0: Caller (player) + * 1: Target + * 2: Classnames + * 3: Do Not Drop Ammo (default: false) * * Return Value: * None diff --git a/addons/explosives/functions/fnc_placeExplosive.sqf b/addons/explosives/functions/fnc_placeExplosive.sqf index 5114f907ac..9dc799f74d 100644 --- a/addons/explosives/functions/fnc_placeExplosive.sqf +++ b/addons/explosives/functions/fnc_placeExplosive.sqf @@ -1,6 +1,6 @@ /* * Author: Garth 'L-H' de Wet - * Places an explosive at the requested position + * Places an explosive at the requested position. * * Arguments: * 0: Unit @@ -9,14 +9,13 @@ * 3: Magazine class * 4: Config of trigger * 5: Variables required for the trigger type - * 6: Explosive placeholder + * 6: Explosive placeholder (default: objNull) * * Return Value: * Placed explosive * * Example: - * _explosive = [player, player modelToWorldVisual [0,0.5, 0.1], 134, - * "SatchelCharge_Remote_Mag", "Command", []] call ACE_Explosives_fnc_placeExplosive; + * _explosive = [player, player modelToWorldVisual [0,0.5, 0.1], 134, "SatchelCharge_Remote_Mag", "Command", []] call ace_explosives_fnc_placeExplosive * * Public: Yes */ diff --git a/addons/explosives/functions/fnc_scriptedExplosive.sqf b/addons/explosives/functions/fnc_scriptedExplosive.sqf index ff7a2ca1a0..5c27e35e60 100644 --- a/addons/explosives/functions/fnc_scriptedExplosive.sqf +++ b/addons/explosives/functions/fnc_scriptedExplosive.sqf @@ -1,19 +1,18 @@ /* * Author: VKing - * Detonate explosives via script, for use in triggers or mission scripts to - * detonate editor-placed explosives. + * Detonate explosives via script, for use in triggers or mission scripts to detonate editor-placed explosives. * * Arguments: * 0: Explosives objects to detonate - * 1: Fuze delay (for each explosive; use negative number for random time up to value) - * 2: Trigger Item Classname + * 1: Fuze delay (for each explosive; use negative number for random time up to value) (default: 0) + * 2: Trigger Item Classname (default: "#scripted") * * Return Value: * None * * Example: - * [[charge1, charge2, charge3], -1] call ACE_Explosives_fnc_scriptedExplosive; - * [[claymore1, claymore2]] call ACE_Explosives_fnc_scriptedExplosive; + * [[charge1, charge2, charge3], -1] call ace_explosives_fnc_scriptedExplosive + * [[claymore1, claymore2]] call ace_explosives_fnc_scriptedExplosive * * Public: Yes */ diff --git a/addons/explosives/functions/fnc_startTimer.sqf b/addons/explosives/functions/fnc_startTimer.sqf index 6694d5dc0d..737e6a6586 100644 --- a/addons/explosives/functions/fnc_startTimer.sqf +++ b/addons/explosives/functions/fnc_startTimer.sqf @@ -5,13 +5,13 @@ * Arguments: * 0: Explosive * 1: Time till detonate - * 2: Trigger Item Classname + * 2: Trigger Item Classname (default: "#timer") * * Return Value: * None * * Example: - * [_explosive, 10] call ACE_Explosives_fnc_startTimer; + * [_explosive, 10] call ace_explosives_fnc_startTimer * * Public: Yes */ diff --git a/addons/hearing/functions/fnc_updateVolume.sqf b/addons/hearing/functions/fnc_updateVolume.sqf index 01ab58ef76..7d0f875414 100644 --- a/addons/hearing/functions/fnc_updateVolume.sqf +++ b/addons/hearing/functions/fnc_updateVolume.sqf @@ -1,10 +1,10 @@ /* * Author: commy2 and esteldunedain and Ruthberg - * Updates and applys the current deafness. Called every 1 sec from a PFEH. + * Updates and applies the current deafness. Called every 1 sec from a PFEH. * * Arguments: * 0: Args - * -----0: Just update volume (skip ringing/recovery) + * 0: Just update volume (skip ringing/recovery) (default: false) * * Return Value: * None @@ -22,7 +22,7 @@ if (!alive ACE_player) exitWith { [QUOTE(ADDON), 1, true] call EFUNC(common,setHearingCapability); }; -(_this select 0) params ["_justUpdateVolume"]; +(_this select 0) params [["_justUpdateVolume", false]]; GVAR(deafnessDV) = (GVAR(deafnessDV) min 20) max 0; GVAR(volume) = (1 - (GVAR(deafnessDV) / 20)) max 0.05; diff --git a/addons/interact_menu/functions/fnc_handleEscapeMenu.sqf b/addons/interact_menu/functions/fnc_handleEscapeMenu.sqf index 41e16e8951..d390d23d94 100644 --- a/addons/interact_menu/functions/fnc_handleEscapeMenu.sqf +++ b/addons/interact_menu/functions/fnc_handleEscapeMenu.sqf @@ -3,10 +3,13 @@ * Handle the escape key being pressed. * * Arguments: - * 0: Escape menu display that should be closed + * 0: Escape menu display that should be closed (default: displayNull) * * Return Value: - * Nothing + * None + * + * Example: + * [display] call ace_interact_menu_fnc_handleEscapeMenu * * Public: No */ diff --git a/addons/interaction/functions/fnc_showMouseHint.sqf b/addons/interaction/functions/fnc_showMouseHint.sqf index c9fb628c15..815aa09f41 100644 --- a/addons/interaction/functions/fnc_showMouseHint.sqf +++ b/addons/interaction/functions/fnc_showMouseHint.sqf @@ -1,12 +1,12 @@ /* * Author: Garth de Wet (LH) - * Shows the interaction helper text with the mouse buttons at the bottom middle of the screen + * Shows the interaction helper text with the mouse buttons at the bottom middle of the screen. * * Arguments: * 0: Left Click Text * 1: Right Click Text - * 2: Scroll Text (Optional) - * 2: Extra Icon/Text pairs + * 2: Scroll Text (default: "") + * 2: Extra Icon/Text pairs (default: []) * * Return Value: * None diff --git a/addons/laser/functions/fnc_laserOn.sqf b/addons/laser/functions/fnc_laserOn.sqf index cd300af083..baa7e9c1c3 100644 --- a/addons/laser/functions/fnc_laserOn.sqf +++ b/addons/laser/functions/fnc_laserOn.sqf @@ -8,15 +8,15 @@ * 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 common eye safe) * 4: Laser code - * 5: Beam divergence (in mils off beam center). - * 6: Method Args + * 5: Beam divergence (in mils off beam center) + * 6: Method Args (default: nil) * * Return Value: - * UUID for sending to laserOff function. + * UUID for sending to laserOff function * * Example: - * [hmg, hmg, [[0,0,1], "HMG_static"], 1550, 1111, 1] call ace_laser_fnc_laserOn; - * [player, player, "ace_laser_fnc_findLaserSource", 1550, 1111, 1, ["pilot"]] call ace_laser_fnc_laserOn; + * [hmg, hmg, [[0,0,1], "HMG_static"], 1550, 1111, 1] call ace_laser_fnc_laserOn + * [player, player, "ace_laser_fnc_findLaserSource", 1550, 1111, 1, ["pilot"]] call ace_laser_fnc_laserOn * * Public: No */ diff --git a/addons/laser/functions/fnc_seekerFindLaserSpot.sqf b/addons/laser/functions/fnc_seekerFindLaserSpot.sqf index 3c144b0eae..200e00acae 100644 --- a/addons/laser/functions/fnc_seekerFindLaserSpot.sqf +++ b/addons/laser/functions/fnc_seekerFindLaserSpot.sqf @@ -8,15 +8,15 @@ * 1: Direction vector (will be normalized) * 2: Seeker FOV in degrees * 3: Seeker max distance in meters - * 4: Seeker wavelength sensitivity range, [1550,1550] is common eye safe. + * 4: Seeker wavelength sensitivity range, [1550,1550] is common eye safe * 5: Seeker laser code. - * 6: Ignore 1 (e.g. Player's vehicle) + * 6: Ignore 1 (e.g. Player's vehicle) (default: objNull) * * Return Value: - * [Strongest compatible laser spot ASL pos, owner object] Nil array values if nothing found. + * [Strongest compatible laser spot ASL pos, owner object] Nil array values if nothing found * * Example: - * [getPosASL player, [0,1,0], 90, [1500, 1500], 1111, player] call ace_laser_fnc_seekerFindLaserSpot; + * [getPosASL player, [0,1,0], 90, [1500, 1500], 1111, player] call ace_laser_fnc_seekerFindLaserSpot * * Public: No */ diff --git a/addons/laser/functions/fnc_shootCone.sqf b/addons/laser/functions/fnc_shootCone.sqf index ceb45ba24b..9cde6f2139 100644 --- a/addons/laser/functions/fnc_shootCone.sqf +++ b/addons/laser/functions/fnc_shootCone.sqf @@ -1,19 +1,19 @@ /* * Author: Nou - * Shoots multiple rays in a dispersion pattern + * Shoots multiple rays in a dispersion pattern. * * Arguments: * 0: Origin position ASL * 1: Direction (normalized) - * 2: Divergence (mils) - * 3: Count at each divergence level - * 4: Ignore vehicle 1 (e.g. Player's vehicle) + * 2: Divergence (mils) (default: 0.3) + * 3: Count at each divergence level (default: 3) + * 4: Ignore vehicle 1 (e.g. Player's vehicle) (default: objNull) * * Return Value: * [_longestReturn, _shortestReturn, _resultPositions] * * Example: - * [getPosASL player, [0,1,0]] call ace_laser_fnc_shootCone; + * [getPosASL player, [0,1,0]] call ace_laser_fnc_shootCone * * Public: No */ diff --git a/addons/laser/functions/fnc_shootRay.sqf b/addons/laser/functions/fnc_shootRay.sqf index 88844c5c95..12a3cf64bf 100644 --- a/addons/laser/functions/fnc_shootRay.sqf +++ b/addons/laser/functions/fnc_shootRay.sqf @@ -1,18 +1,18 @@ /* * Author: Nou, PabstMirror - * Shoots a ray from a source to a direction and finds first intersction and distance + * Shoots a ray from a source to a direction and finds first intersction and distance. * * Arguments: * 0: Origin position ASL * 1: Direction (normalized) - * 2: Ignore 1 (e.g. Player's vehicle) - * 2: Ignore 2 (e.g. Player's vehicle) + * 2: Ignore 1 (e.g. Player's vehicle) (default: objNull) + * 2: Ignore 2 (e.g. Player's vehicle) (default: objNull) * * Return Value: * [posASL, distance] - pos will be nil if no intersection * * Example: - * [getPosASL player, [0,1,0], player] call ace_laser_fnc_shootRay; + * [getPosASL player, [0,1,0], player] call ace_laser_fnc_shootRay * * Public: No */ diff --git a/addons/microdagr/functions/fnc_openDisplay.sqf b/addons/microdagr/functions/fnc_openDisplay.sqf index aa2db94827..7d1171d479 100644 --- a/addons/microdagr/functions/fnc_openDisplay.sqf +++ b/addons/microdagr/functions/fnc_openDisplay.sqf @@ -1,9 +1,9 @@ /* * Author: PabstMirror - * Changes the display mode of the microDAGR + * Changes the display mode of the MicroDAGR. * * Arguments: - * 0: Display Mode to show the microDAGR in + * 0: Display Mode to show the microDAGR in (default: -1) * * Return Value: * None diff --git a/addons/mk6mortar/functions/fnc_loadMagazineTimer.sqf b/addons/mk6mortar/functions/fnc_loadMagazineTimer.sqf index 16016f06e6..fa0adb28d0 100644 --- a/addons/mk6mortar/functions/fnc_loadMagazineTimer.sqf +++ b/addons/mk6mortar/functions/fnc_loadMagazineTimer.sqf @@ -1,12 +1,12 @@ /* * Author: Grey - * Loads Magazine into static weapon using a timer + * Loads Magazine into static weapon using a timer. * * Arguments: - * 0: static - * 1: unit - * 2: time to load - * 3: magazineClassOptional + * 0: Static + * 1: Unit + * 2: Time to load + * 3: Magazine Class (default: "") * * Return Value: * None @@ -20,7 +20,7 @@ params ["_static","_unit","_timeToLoad",["_magazineClassOptional","",[""]]]; -//Move player into animation if player is standing +// Move player into animation if player is standing if ((_unit call CBA_fnc_getUnitAnim) select 0 == "stand") then { [_unit, "AmovPercMstpSrasWrflDnon_diary", 1] call EFUNC(common,doAnimation); }; diff --git a/addons/zeus/functions/fnc_showMessage.sqf b/addons/zeus/functions/fnc_showMessage.sqf index c91c90093a..755b9b6278 100644 --- a/addons/zeus/functions/fnc_showMessage.sqf +++ b/addons/zeus/functions/fnc_showMessage.sqf @@ -1,11 +1,11 @@ /* * Author: 654wak654 - * Shows a zeus message through the BIS function, handles localization. + * Shows a Zeus message through the BIS function, handles localization. * If multiple args are given, they get formatted. * * Arguments: - * 0: The message - * N: Anything + * 0: Message + * N: Anything (default: nil) * * Return Value: * None