GetWeaponState: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 7: | Line 7: | ||
===Required Arguments=== | ===Required Arguments=== | ||
* '''theWeapon:''' The weapon to get the target of. | * '''theWeapon:''' The [[weapon]] to get the target of. | ||
===Returns=== | ===Returns=== | ||
< | Returns a [[string]] indicating the weapon state, ''false'' otherwise. | ||
*''' | <div style="border:3px solid red;margin-bottom:3px;padding-left:5px;"><div style="float:right;padding-right:5px;font-weight:bold;"></div> | ||
* '''reloading''': The weapon is reloading | |||
* | * '''firing''': The weapon will constantly fire ( unless any shooting blocking flags are set ) according to its assigned firing rate | ||
* | * '''ready''': The weapon is idle | ||
< | </div> | ||
==Example== | |||
TODO | |||
<syntaxhighlight lang="lua"> | |||
--TODO | |||
</syntaxhighlight> | |||
==Requirements== | ==Requirements== | ||
Revision as of 13:04, 17 September 2012
Get the state of the custom weapon.
Syntax
string getWeaponState ( weapon theWeapon )
Required Arguments
- theWeapon: The weapon to get the target of.
Returns
Returns a string indicating the weapon state, false otherwise.
- reloading: The weapon is reloading
- firing: The weapon will constantly fire ( unless any shooting blocking flags are set ) according to its assigned firing rate
- ready: The weapon is idle
Example
TODO
--TODO
Requirements
This template will be deleted.