Updated function documentation

This commit is contained in:
lambdatiger 2024-07-30 16:08:59 -05:00
parent 25cc22bf77
commit 2e67d5d843
6 changed files with 10 additions and 11 deletions

View File

@ -1,7 +1,7 @@
#include "..\script_component.hpp"
/*
* Author: Jaynus, NouberNou
* Adds a round to the blacklist (will be ignored).
* Adds a round to the blacklist (will be ignored) and removes any ace_frag event handlers added to it.
*
* Arguments:
* 0: Projectile <OBJECT>

View File

@ -1,7 +1,8 @@
#include "..\script_component.hpp"
/*
* Author: Lambda.Tiger
* Add eventhandlers to rounds as needed
* Add "Exploded" eventhandler to a projectile if it will produce fragments
* and a "HitPart" eventhandler if it will produce spall.
*
* Arguments:
* Parameters inherited from EFUNC(common,firedEH)

View File

@ -1,12 +1,12 @@
#include "..\script_component.hpp"
/*
* Author: Jaynus, NouberNou
* Author: Jaynus, NouberNou, Lambda.Tiger
* Server func to create the fragmentation for a round.
*
* Arguments:
* 0: Last Position (ASL) <ARRAY>
* 1: Ammo Classname <STRING>
* 2: Shot parents <ARRAY>
* 0: ASL position projetile is fragmenting at <ARRAY>
* 1: Projectile ammo classname <STRING>
* 2: Projectile shot parents <ARRAY>
*
* Return Value:
* The number of fragments created <NUMBER>

View File

@ -8,7 +8,7 @@
*
* Return Value:
* _ammoInfo <ARRAY>
* 0: Caliber <NUMBER>
* 0: Caliber config value <NUMBER>
* 1: What part of the hit damage is from ballistic vs explosive energy (1 for all explosive) <NUMBER>
* 2: Indirect hit damage <NUMBER>
*

View File

@ -7,9 +7,7 @@
* 0: Ammo classname <STRING>
*
* Return Value:
* An array containing <ARRAY>
* 0: Should the ammo class generate fragments <BOOL>
* 1: Should the ammo class create submunitions that may fragment <BOOL>
* Could the ammo class generate fragments <BOOL>
*
* Example:
* "B_556x45_Ball" call ace_frag_fnc_shouldFrag

View File

@ -7,7 +7,7 @@
* 0: Ammo classname <STRING>
*
* Return Value:
* Whether the round type would spall when hitting an object <BOOL>
* Whether the round type could spall when hitting an object <BOOL>
*
* Example:
* "B_556x45_Ball" call ace_frag_fnc_shouldSpall