ResetWeaponFiringRate: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (Added OOP syntax and Needs Example template)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Client function}}
{{Client function}}
Reset the firing rate to be used when you set the custom weapon to the firing state to its default.
{{Needs_Example}}
This function resets the firing rate of a [[Element/Weapon|custom weapon]] to the default one.


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">bool resetWeaponFiringRate ( weapon theWeapon )</syntaxhighlight>
<syntaxhighlight lang="lua">bool resetWeaponFiringRate ( weapon theWeapon )</syntaxhighlight>
{{OOP||[[Element/Weapon|weapon]]:resetFiringRate}}


===Required Arguments===
===Required Arguments===
Line 15: Line 17:
{{Requirements|n/a|1.3.0-9.04555|}}
{{Requirements|n/a|1.3.0-9.04555|}}


==See Also==
==See also==
{{Client weapon creation functions}}
{{Client weapon creation functions}}

Revision as of 16:49, 23 December 2014

Accessories-text-editor.png Script Example Missing Function ResetWeaponFiringRate needs a script example, help out by writing one.

Before submitting check out Editing Guidelines Script Examples.

This function resets the firing rate of a custom weapon to the default one.

Syntax

bool resetWeaponFiringRate ( weapon theWeapon )

OOP Syntax Help! I don't understand this!

Method: weapon:resetFiringRate(...)


Required Arguments

  • theWeapon: the weapon to reset the firing rate of.

Returns

Returns true on success, false otherwise.

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