GetWeaponState: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Added a small example.)
Line 17: Line 17:


==Example==
==Example==
TODO
This command will block players from reloading while they are still reloading
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--TODO
addCommandHandler ( "reload",
    function ( thePlayer )
        if ( getWeaponState ( getPedWeapon ( thePlayer ) ) == "reloading" ) then
            outputChatBox ( "You are still reloading...", thePlayer )
            return
        end
        reloadPedWeapon ( thePlayer )
    end
)
</syntaxhighlight>
</syntaxhighlight>



Revision as of 17:23, 4 October 2014

Accessories-text-editor.png Script Example Missing Function GetWeaponState needs a script example, help out by writing one.

Before submitting check out Editing Guidelines Script Examples.

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