GetWeaponState: Difference between revisions

Latest revision as of 17:50, 23 December 2014

This function gets the state of a custom weapon.

Syntax

string getWeaponState ( weapon theWeapon )

OOP Syntax Help! I don't understand this!

Method: weapon:getState(...)

Variable: .state

Counterpart: setWeaponState

Required arguments

theWeapon: the weapon to get the state of.

Returns

A string if the weapon is valid, indicating the weapon state, which can be:
- reloading: the weapon is reloading.
- firing: the weapon is constantly shooting (unless any shooting blocking flags are set) according to its assigned firing rate.
- ready: the weapon is idle.
false if an error occured or the weapon is invalid.

Example

This example creates a gun where the local player is and informs any player about its state.

local function testWeaponState()
    local weapon = createWeapon("m4", getElementPosition(localPlayer)) -- Create the weapon
    outputChatBox("The weapon that has just been created state is " .. getWeaponState(weapon) .. ".") -- Tell the player its state
end
addEventHandler("onClientResourceStart", resourceRoot, testWeaponState)

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}}
-Get the state of the custom weapon.
+This function gets the state of a [[Element/Weapon|custom weapon]].
 ==Syntax==
 <syntaxhighlight lang="lua">string getWeaponState ( weapon theWeapon )</syntaxhighlight>
+{{OOP||[[Element/Weapon|weapon]]:getState|state|setWeaponState}}
-===Required Arguments===
+===Required arguments===
-* '''theWeapon:''' The [[weapon]] to get the target of.
+* '''theWeapon:''' the [[Element/Weapon|weapon]] to get the state of.
 ===Returns===
-Returns a [[string]] indicating the weapon state, ''false'' otherwise.
+* A [[string]] if the [[Element/Weapon|weapon]] is valid, indicating the weapon state, which can be:
-<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.
-* '''reloading''': The weapon is reloading
+** '''firing''': the weapon is constantly shooting (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
+* ''false'' if an error occured or the [[Element/Weapon|weapon]] is invalid.
-</div>
 ==Example==
-TODO
+This example creates a gun where the local player is and informs any player about its state.
-<syntaxhighlight lang="lua">
+<syntaxhighlight lang="lua">local function testWeaponState()
---TODO
+    local weapon = createWeapon("m4", getElementPosition(localPlayer)) -- Create the weapon
+    outputChatBox("The weapon that has just been created state is " .. getWeaponState(weapon) .. ".") -- Tell the player its state
+end
+addEventHandler("onClientResourceStart", resourceRoot, testWeaponState)
 </syntaxhighlight>
@@ Line 26: / Line 29: @@
 {{Requirements|n/a|1.3.0-9.04555|}}
-==See Also==
+==See also==
 {{Client weapon creation functions}}
-[[Category:Needs Example]]