From 16128721e0330acc33df303a053150d3c07c9376 Mon Sep 17 00:00:00 2001 From: lambdatiger Date: Wed, 17 Jan 2024 18:20:47 -0600 Subject: [PATCH] Function header changes Co-authored-by: johnb432 <58661205+johnb432@users.noreply.github.com> --- addons/frag/functions/fnc_dev_fragCalcDump.sqf | 5 ++--- addons/frag/functions/fnc_dev_sphereDraw.sqf | 2 +- addons/frag/functions/fnc_dev_trackHitBox.sqf | 4 ++-- addons/frag/functions/fnc_doFrag.sqf | 6 +++--- addons/frag/functions/fnc_doFragRandom.sqf | 2 +- addons/frag/functions/fnc_doFragTargeted.sqf | 10 +++++----- addons/frag/functions/fnc_initBlackList.sqf | 2 +- addons/frag/functions/fnc_initMaterialCache.sqf | 6 +++--- addons/frag/functions/fnc_initRound.sqf | 4 ++-- addons/frag/functions/fnc_shouldFrag.sqf | 6 +++--- addons/frag/functions/fnc_shouldSpall.sqf | 3 +-- 11 files changed, 24 insertions(+), 26 deletions(-) diff --git a/addons/frag/functions/fnc_dev_fragCalcDump.sqf b/addons/frag/functions/fnc_dev_fragCalcDump.sqf index 7850b8d602..8214ffac3b 100644 --- a/addons/frag/functions/fnc_dev_fragCalcDump.sqf +++ b/addons/frag/functions/fnc_dev_fragCalcDump.sqf @@ -3,11 +3,10 @@ * Author: Lambda.Tiger, based on fnc_dev_debugAmmo by "ACE-Team" * Dumps all ammo types to see if there's any reason to spawn fragments * given hit power and distance. Good for grasping the values used in - * shouldFrag to cull non-fragmenting rounds + * shouldFrag to cull non-fragmenting rounds. * * Arguments: - * 0: Display rounds that will never frag (power < 5). - * Default value false + * 0: Display rounds that will never frag (power < 5) (default: false) * * Return Value: * None diff --git a/addons/frag/functions/fnc_dev_sphereDraw.sqf b/addons/frag/functions/fnc_dev_sphereDraw.sqf index 73d71b1291..c99dbcb138 100644 --- a/addons/frag/functions/fnc_dev_sphereDraw.sqf +++ b/addons/frag/functions/fnc_dev_sphereDraw.sqf @@ -1,7 +1,7 @@ #include "..\script_component.hpp" /* * Author: Lambda.Tiger - * Add a colored sphere at a specified point + * Add a colored sphere at a specified point. * * Arguments: * 0: ASL position to add sphere diff --git a/addons/frag/functions/fnc_dev_trackHitBox.sqf b/addons/frag/functions/fnc_dev_trackHitBox.sqf index e6f9114e61..49d7638e0d 100644 --- a/addons/frag/functions/fnc_dev_trackHitBox.sqf +++ b/addons/frag/functions/fnc_dev_trackHitBox.sqf @@ -2,10 +2,10 @@ /* * Author: Lambda.Tiger * Add a hit box outline to an object, outdated for unit hits as they - * use hit-point locations + * use hit-point locations. * * Arguments: - * 0: Object to draw the hit box of : + * 0: Object to draw the hit box of * 1: Add sphere at object origin * * Return Value: diff --git a/addons/frag/functions/fnc_doFrag.sqf b/addons/frag/functions/fnc_doFrag.sqf index ecd7db40de..3ade288f5a 100644 --- a/addons/frag/functions/fnc_doFrag.sqf +++ b/addons/frag/functions/fnc_doFrag.sqf @@ -5,10 +5,10 @@ * as handling some of the performance optimizations. * * Arguments: - * 0: projectile that's fragmenting + * 0: Projectile that's fragmenting * 1: ASL position of projectile - * 2: velocity of projectile - * 3: projectile cfgAmmo classname + * 2: Velocity of projectile + * 3: Projectile cfgAmmo classname * 4: getShotParents of projectile at EH * * Return Value: diff --git a/addons/frag/functions/fnc_doFragRandom.sqf b/addons/frag/functions/fnc_doFragRandom.sqf index 698b720ce6..a28f6212d9 100644 --- a/addons/frag/functions/fnc_doFragRandom.sqf +++ b/addons/frag/functions/fnc_doFragRandom.sqf @@ -2,7 +2,7 @@ /* * Author: Jaynus, NouberNou, Lambda.Tiger * This function creates fragments randomly spreading out from an explosion to - * a maximum of 15 + * a maximum of 15. * * Arguments: * 0: Position of fragmenting projectile ASL diff --git a/addons/frag/functions/fnc_doFragTargeted.sqf b/addons/frag/functions/fnc_doFragTargeted.sqf index bc415923bc..8257b4fd21 100644 --- a/addons/frag/functions/fnc_doFragTargeted.sqf +++ b/addons/frag/functions/fnc_doFragTargeted.sqf @@ -2,19 +2,19 @@ /* * Author: Jaynus, NouberNou, Lambda.Tiger * This function creates fragments targeted at specific entities, up to - * a configured maximum + * a configured maximum. * * Arguments: * 0: Position of fragmenting projectile ASL * 1: Velocity of the fragmenting projectile - * 2: Maximum range of fragments to calculate - * 3: Maximum number of fragments to produce + * 2: Maximum range of fragments to calculate + * 3: Maximum number of fragments to produce * 4: Types of fragments - * 5: A modified parameter used to calculate whether a fragment hits + * 5: A modified parameter used to calculate whether a fragment hits * 6: Shot parent * * Return Value: - * Number of fragments created + * Number of fragments created * * Example: * [getPosASL _proj, velocity _proj, 50, 50, [], 1, [player, player]] call ace_frag_fnc_doFragTargeted; diff --git a/addons/frag/functions/fnc_initBlackList.sqf b/addons/frag/functions/fnc_initBlackList.sqf index 605ef1d180..ece32b20da 100644 --- a/addons/frag/functions/fnc_initBlackList.sqf +++ b/addons/frag/functions/fnc_initBlackList.sqf @@ -1,7 +1,7 @@ #include "..\script_component.hpp" /* * Author: Lambda.Tiger - * Adds setting defined blacklisted rounds to blacklist + * Adds setting defined blacklisted rounds to blacklist. * * Arguments: * None diff --git a/addons/frag/functions/fnc_initMaterialCache.sqf b/addons/frag/functions/fnc_initMaterialCache.sqf index cde98f9fa1..809221e40f 100644 --- a/addons/frag/functions/fnc_initMaterialCache.sqf +++ b/addons/frag/functions/fnc_initMaterialCache.sqf @@ -2,13 +2,13 @@ /* * Author: Lambda.Tiger * For performance, we load a bunch of vanilla materials preemptively into - * the spall material cache + * the spall material cache. * * Arguments: - * none + * None * * Return Value: - * none + * None * * Example: * call initMaterialCache; diff --git a/addons/frag/functions/fnc_initRound.sqf b/addons/frag/functions/fnc_initRound.sqf index cfbeb21d21..eed7d3d6f4 100644 --- a/addons/frag/functions/fnc_initRound.sqf +++ b/addons/frag/functions/fnc_initRound.sqf @@ -1,10 +1,10 @@ #include "..\script_component.hpp" /* * Author: Lambda.Tiger - * This function adds rounds using their config init EH + * This function adds rounds using their config init EH. * Arguments: - * 0: _projectile - The object created + * 0: Projectile - The object created * * Return Value: * None diff --git a/addons/frag/functions/fnc_shouldFrag.sqf b/addons/frag/functions/fnc_shouldFrag.sqf index f9e032d301..103f7aac75 100644 --- a/addons/frag/functions/fnc_shouldFrag.sqf +++ b/addons/frag/functions/fnc_shouldFrag.sqf @@ -2,13 +2,13 @@ /* * Author: Lambda.Tiger * This function checks whether an ammunition type should cause fragmentation - * and whether any submunitions exist + * and whether any submunitions exist. * * Arguments: - * 0: _ammo - cfgAmmo type of ammo to check + * 0: Type of ammo to check * * Return Value: - * _shouldFrag Should the specific round fragment + * Should the specific round fragment * * Example: * ["B_556x45_Ball"] call ace_frag_fnc_shouldFrag; diff --git a/addons/frag/functions/fnc_shouldSpall.sqf b/addons/frag/functions/fnc_shouldSpall.sqf index 0265aa305a..1ee1ed8f53 100644 --- a/addons/frag/functions/fnc_shouldSpall.sqf +++ b/addons/frag/functions/fnc_shouldSpall.sqf @@ -1,8 +1,7 @@ #include "..\script_component.hpp" /* * Author: Lambda.Tiger - * This function checks whether an ammunition type should cause spalling - * + * This function checks whether an ammunition type should cause spalling. * * Arguments: * 0: _ammo - cfgAmmo type of ammo to check