GetWeaponState: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
| Line 12: | Line 12: | ||
===Returns=== | ===Returns=== | ||
Returns a [[string]] indicating the weapon state, ''false'' otherwise. | Returns a [[string]] indicating the weapon state, ''false'' otherwise. | ||
* '''reloading''': The weapon is reloading | * '''reloading''': The weapon is reloading | ||
* '''firing''': The weapon will constantly fire ( unless any shooting blocking flags are set ) according to its assigned firing rate | * '''firing''': The weapon will constantly fire ( unless any shooting blocking flags are set ) according to its assigned firing rate | ||
* '''ready''': The weapon is idle | * '''ready''': The weapon is idle | ||
==Example== | ==Example== | ||
Revision as of 17:47, 29 November 2012
|
Script Example Missing Function GetWeaponState needs a script example, help out by writing one. |
Before submitting check out Editing Guidelines Script Examples. |
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.
See Also
- createWeapon
- fireWeapon
- getWeaponAmmo
- getWeaponClipAmmo
- getWeaponFiringRate
- getWeaponFlags
- getWeaponOwner
- getWeaponProperty
- getWeaponState
- getWeaponTarget
- resetWeaponFiringRate
- setWeaponAmmo
- setWeaponClipAmmo
- setWeaponFiringRate
- setWeaponFlags
- setWeaponProperty
- setWeaponState
- setWeaponTarget