GetWeaponState - Revision history

Fernando187: Remove obsolete Requirements section

2024-11-07T17:08:02Z

Remove obsolete Requirements section

← Older revision		Revision as of 17:08, 7 November 2024
Line 25:		Line 25:
	addEventHandler("onClientResourceStart", resourceRoot, testWeaponState)		addEventHandler("onClientResourceStart", resourceRoot, testWeaponState)
	</syntaxhighlight>		</syntaxhighlight>

	~~==Requirements==~~
	~~{{Requirements\|n/a\|1.3.0-9.04555\|}}~~

	==See also==		==See also==
	{{Client weapon creation functions}}		{{Client weapon creation functions}}

AlexTMjugador: Some minor grammar fix at /* Returns */

2014-12-23T17:50:56Z

Some minor grammar fix at Returns

← Older revision		Revision as of 17:50, 23 December 2014
Line 13:		Line 13:
	* A [[string]] if the [[Element/Weapon\|weapon]] is valid, indicating the weapon state, which can be:		* A [[string]] if the [[Element/Weapon\|weapon]] is valid, indicating the weapon state, which can be:
	** '''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 is constantly shooting (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.		* ''false'' if an error occured or the [[Element/Weapon\|weapon]] is invalid.

AlexTMjugador at 16:23, 23 December 2014

2014-12-23T16:23:33Z

← Older revision		Revision as of 16:23, 23 December 2014
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">string getWeaponState ( weapon theWeapon )</syntaxhighlight>		<syntaxhighlight lang="lua">string getWeaponState ( weapon theWeapon )</syntaxhighlight>
			{{OOP\|\|[[Element/Weapon\|weapon]]:getState\|state\|setWeaponState}}

	===Required arguments===		===Required arguments===

AlexTMjugador: Added OOP syntax and improved the example

2014-12-23T16:22:01Z

Added OOP syntax and improved the example

← Older revision		Revision as of 16:22, 23 December 2014
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
	~~Get~~ the state of ~~the~~ custom weapon.		This function gets the state of a [[Element/Weapon\|custom weapon]].

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">string getWeaponState ( weapon theWeapon )</syntaxhighlight>		<syntaxhighlight lang="lua">string getWeaponState ( weapon theWeapon )</syntaxhighlight>

	===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.		* A [[string]] if the [[Element/Weapon\|weapon]] is valid, indicating the weapon state, which can be:
	** '''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.
	* ''false'' ~~otherwise~~.		* ''false'' if an error occured or the [[Element/Weapon\|weapon]] is invalid.

	==Example==		==Example==
	This ~~command will block players from reloading while they are still reloading~~		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()
	~~addCommandHandler~~ ( "~~reload~~",		local weapon = createWeapon("m4", getElementPosition(localPlayer)) -- Create the weapon
	~~function~~ ( ~~thePlayer~~ )		outputChatBox("The weapon that has just been created state is " .. getWeaponState(weapon) .. ".") -- Tell the player its state
	if ( getWeaponState ( ~~getPedWeapon ( thePlayer~~ ) ~~) == "reloading" ) then~~		end
	~~outputChatBox ( "You are still reloading~~..."~~, thePlayer~~ )		addEventHandler("onClientResourceStart", resourceRoot, testWeaponState)
	~~return~~
	end
	~~reloadPedWeapon~~ ( ~~thePlayer )~~
	~~end~~
	)
	</syntaxhighlight>		</syntaxhighlight>

Line 32:		Line 28:
	{{Requirements\|n/a\|1.3.0-9.04555\|}}		{{Requirements\|n/a\|1.3.0-9.04555\|}}

	==See ~~Also~~==		==See also==
	{{Client weapon creation functions}}		{{Client weapon creation functions}}

Strix at 22:30, 4 October 2014

2014-10-04T22:30:49Z

← Older revision		Revision as of 22:30, 4 October 2014
Line 10:		Line 10:

	===Returns===		===Returns===
	~~Returns a~~ [[string]] indicating the weapon state~~, ''false'' otherwise~~.		* A [[string]] indicating the weapon state.
	* '''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
			* ''false'' otherwise.
	==Example==		==Example==
	This command will block players from reloading while they are still reloading		This command will block players from reloading while they are still reloading

Strix at 22:29, 4 October 2014

2014-10-04T22:29:25Z

← Older revision		Revision as of 22:29, 4 October 2014
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==

Strix at 22:28, 4 October 2014

2014-10-04T22:28:17Z

← Older revision		Revision as of 22:28, 4 October 2014
Line 7:		Line 7:

	===Required Arguments===		===Required Arguments===
	* '''theWeapon:''' ~~The~~ [[weapon]] to get the target of.		* '''theWeapon:''' the [[weapon]] to get the target of.

	===Returns===		===Returns===

Lopez: removed {{Needs Example}}

2014-10-04T20:42:28Z

removed {{Needs Example}}

← Older revision		Revision as of 20:42, 4 October 2014
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
	~~{{Needs Example}}~~
	Get the state of the custom weapon.		Get the state of the custom weapon.

Tosfera: Added a small example.

2014-10-04T17:23:09Z

Added a small example.

← Older revision		Revision as of 17:23, 4 October 2014
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>

MTA SE: /* unnecessary red frame in Returns block */

2012-11-29T17:47:08Z

unnecessary red frame in Returns block

← Older revision		Revision as of 17:47, 29 November 2012
Line 12:		Line 12:
	===Returns===		===Returns===
	Returns a [[string]] indicating the weapon state, ''false'' otherwise.		Returns a [[string]] indicating the weapon state, ''false'' otherwise.
	~~<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 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
	~~</div>~~

	==Example==		==Example==