SetWeaponState: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(Remove obsolete Requirements section)
 
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Client function}}
{{Client function}}
Sets a custom weapons state.
This function sets a [[Element/Weapon|custom weapon]]'s state.


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">bool setWeaponState ( weapon theWeapon, string theState )</syntaxhighlight>
<syntaxhighlight lang="lua">bool setWeaponState ( weapon theWeapon, string theState )</syntaxhighlight>
{{OOP||[[Element/Weapon|weapon]]:setState|state|getWeaponState}}


===Required Arguments===
===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===
Returns ''true'' on success, ''false'' otherwise.
Returns ''true'' on success, ''false'' otherwise.


==Requirements==
===Example===
{{Requirements|1.3.0-4555|1.3.0-4555|}}
<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


Retrieved from "https://wiki.multitheftauto.com/wiki/SetWeaponState?oldid=81137"