GetWeaponState: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 11: Line 11:
===Returns===
===Returns===
Returns a [[string]] indicating the weapon state, ''false'' otherwise.
Returns a [[string]] indicating the weapon state, ''false'' otherwise.
* '''reloading''': The weapon is reloading
* '''reloading''': the weapon is reloading
* '''firing''': The weapon will constantly fire ( 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


==Example==
==Example==

Revision as of 22:29, 4 October 2014

Get the state of the custom weapon.

Syntax

string getWeaponState ( weapon theWeapon )

Required Arguments

  • theWeapon: the weapon to get the target of.

Returns

Returns a string indicating the weapon state, false otherwise.

  • reloading: the weapon is reloading
  • firing: the weapon will constantly fire ( unless any shooting blocking flags are set ) according to its assigned firing rate
  • ready: the weapon is idle

Example

This command will block players from reloading while they are still reloading

addCommandHandler ( "reload",
    function ( thePlayer )
        if ( getWeaponState ( getPedWeapon ( thePlayer ) ) == "reloading" ) then
            outputChatBox ( "You are still reloading...", thePlayer )
            return
        end
        reloadPedWeapon ( thePlayer )
    end
)

Requirements

This template will be deleted.

See Also