GetWeaponState: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Client function}}
{{Client function}}
{{Needs Example}}
Get the state of the custom weapon.
Get the state of the custom weapon.


Line 28: Line 29:
==See Also==
==See Also==
{{Client weapon creation functions}}
{{Client weapon creation functions}}
[[Category:Needs Example]]

Revision as of 09:12, 6 October 2012

Accessories-text-editor.png 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

Minimum server version n/a
Minimum client version 1.3.0-9.04555

Note: Using this feature requires the resource to have the above minimum version declared in the meta.xml <min_mta_version> section. e.g. <min_mta_version client="1.3.0-9.04555" />

See Also