SetWeaponState: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
Fernando187 (talk | contribs) (Remove obsolete Requirements section) |
||
| (3 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Client function}} | {{Client function}} | ||
This function sets a [[Element/Weapon|custom weapon]]'s state. | This function sets a [[Element/Weapon|custom weapon]]'s state. | ||
| Line 18: | Line 17: | ||
Returns ''true'' on success, ''false'' otherwise. | 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> | |||
==See also== | ==See also== | ||
{{Client weapon creation functions}} | {{Client weapon creation functions}} | ||
Latest revision as of 17:07, 7 November 2024
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
)
See also
- createWeapon
- fireWeapon
- getWeaponAmmo
- getWeaponClipAmmo
- getWeaponFiringRate
- getWeaponFlags
- getWeaponOwner
- getWeaponProperty
- getWeaponState
- getWeaponTarget
- resetWeaponFiringRate
- setWeaponAmmo
- setWeaponClipAmmo
- setWeaponFiringRate
- setWeaponFlags
- setWeaponProperty
- setWeaponState
- setWeaponTarget