SetWeaponState: Difference between revisions

Latest revision as of 19:39, 4 May 2015

This function sets a custom weapon's state.

Syntax

bool setWeaponState ( weapon theWeapon, string theState )

OOP Syntax Help! I don't understand this!

Method: weapon:setState(...)

Variable: .state

Counterpart: getWeaponState

Required Arguments

theWeapon: the weapon you wish to set the state of.
theState: the state you wish to set:
- reloading: makes the weapon reload.
- firing: makes the weapon constantly fire its target (unless any shooting blocking flags are set) according to its assigned firing rate.
- ready: makes the weapon stop reloading or firing.

Returns

Returns true on success, false otherwise.

Example

addEventHandler("onClientResourceStart", resourceRoot,
      function()
            local wep = createWeapon("m4", 0, 0, 4)
            setWeaponState(wep, "firing")
      end
)

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" />

@@ Line 1: / Line 1: @@
 __NOTOC__
 {{Client function}}
-Sets a custom weapons state.
+This function sets a [[Element/Weapon|custom weapon]]'s state.
 ==Syntax==
 <syntaxhighlight lang="lua">bool setWeaponState ( weapon theWeapon, string theState )</syntaxhighlight>
+{{OOP||[[Element/Weapon|weapon]]:setState|state|getWeaponState}}
 ===Required Arguments===
-* '''theWeapon:''' the weapon you wish to change the state of
+* '''theWeapon''': the weapon you wish to set the state of.
-* '''theState:''' the state you wish to set:
+* '''theState''': the state you wish to set:
-** "reloading" - the weapon is reloading
+** '''reloading''': makes the weapon reload.
-** "firing" - the weapon will constantly fire ( unless any shooting blocking flags are set ) according to its assigned firing rate
+** '''firing''': makes the weapon constantly fire its target (unless any shooting blocking flags are set) according to its assigned firing rate.
-** "ready" - the weapon is idle
+** '''ready''': makes the weapon stop reloading or firing.
 ===Returns===
 Returns ''true'' on success, ''false'' otherwise.
+===Example===
+<syntaxhighlight lang="lua">addEventHandler("onClientResourceStart", resourceRoot,
+      function()
+            local wep = createWeapon("m4", 0, 0, 4)
+            setWeaponState(wep, "firing")
+      end
+)</syntaxhighlight>
 ==Requirements==
 {{Requirements|n/a|1.3.0-9.04555|}}
-==See Also==
+==See also==
 {{Client weapon creation functions}}