GetPlayerAmmoInClip - Revision history

AlexTMjugador: Changed "DeprecatedWithAlt" template to "Deprecated"

2015-02-13T16:24:28Z

Changed "DeprecatedWithAlt" template to "Deprecated"

← Older revision		Revision as of 16:24, 13 February 2015
Line 1:		Line 1:
			__NOTOC__
	{{Server client function}}		{{Server client function}}
	{{~~DeprecatedWithAlt~~\|getPedAmmoInClip\|}}		{{Deprecated\|getPedAmmoInClip\|}}
	~~__NOTOC__~~
	This function returns an integer that contains the ammo in a specified [[player]]'s weapon. See [[weapon\|Weapon Info]]		This function returns an integer that contains the ammo in a specified [[player]]'s weapon. See [[weapon\|Weapon Info]]

Ccw at 23:19, 21 October 2011

2011-10-21T23:19:51Z

← Older revision		Revision as of 23:19, 21 October 2011
Line 1:		Line 1:
	{{Server client function}}		{{Server client function}}
			{{DeprecatedWithAlt\|getPedAmmoInClip\|}}
	__NOTOC__		__NOTOC__
	This function returns an integer that contains the ammo in a specified [[player]]'s weapon. See [[weapon\|Weapon Info]]		This function returns an integer that contains the ammo in a specified [[player]]'s weapon. See [[weapon\|Weapon Info]]

EAi: /* Syntax */

2008-04-20T01:37:41Z

Syntax

← Older revision		Revision as of 01:37, 20 April 2008
Line 18:		Line 18:
	<section name="Client" class="client" show="true">		<section name="Client" class="client" show="true">
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	int getPlayerAmmoInClip ( player thePlayer , int weaponSlot )		int getPlayerAmmoInClip ( player thePlayer, int weaponSlot )
	</syntaxhighlight>		</syntaxhighlight>

EAi: /* Syntax */

2008-04-20T01:37:30Z

Syntax

← Older revision		Revision as of 01:37, 20 April 2008
Line 24:		Line 24:
	*'''thePlayer:''' The [[player]] whose ammo you want to check.		*'''thePlayer:''' The [[player]] whose ammo you want to check.
	*'''weaponSlot:''' an integer representing the weapon slot.		*'''weaponSlot:''' an integer representing the weapon slot.

	~~===Optional Arguments===~~
	~~none~~

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

Crazy: /* Syntax */

2008-04-19T16:24:02Z

Syntax

← Older revision		Revision as of 16:24, 19 April 2008
Line 18:		Line 18:
	<section name="Client" class="client" show="true">		<section name="Client" class="client" show="true">
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	int getPlayerAmmoInClip ( player thePlayer [, int weaponSlot ~~= current ]~~ )		int getPlayerAmmoInClip ( player thePlayer , int weaponSlot )
	</syntaxhighlight>		</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	*'''thePlayer:''' The [[player]] whose ammo you want to check.		*'''thePlayer:''' The [[player]] whose ammo you want to check.
			*'''weaponSlot:''' an integer representing the weapon slot.

	===Optional Arguments===		===Optional Arguments===
	*'''weaponSlot:''' an integer representing the weapon slot (set to the player's currently selected slot if not specified).		none

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

ChrML at 16:10, 29 November 2007

2007-11-29T16:10:48Z

← Older revision		Revision as of 16:10, 29 November 2007
Line 1:		Line 1:
	{{Server client function}}		{{Server client function}}
	~~{{Needs_Checking\|Should return ''false'' instead of 0 if player's invalid, for consistency}}~~
	__NOTOC__		__NOTOC__
	This function returns an integer that contains the ammo in a specified [[player]]'s weapon. See [[weapon\|Weapon Info]]		This function returns an integer that contains the ammo in a specified [[player]]'s weapon. See [[weapon\|Weapon Info]]

Arc at 15:17, 19 August 2007

2007-08-19T15:17:29Z

← Older revision		Revision as of 15:17, 19 August 2007
Line 33:		Line 33:

	==Example==		==Example==
			<section name="Server" class="server" show="true">
	This example outputs the amount of ammo the specified player has in his current slot. For example: 'ammo someguy'.		This example outputs the amount of ammo the specified player has in his current slot. For example: 'ammo someguy'.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
Line 39:		Line 40:
	if ( thePlayer ) then		if ( thePlayer ) then
	local ammo = getPlayerAmmoInClip ( targetPlayer )		local ammo = getPlayerAmmoInClip ( targetPlayer )
	outputChatBox(who .. " has "..ammo .. " in his active clip", thePlayer)		outputChatBox ( who .. " has " .. ammo .. " ammo in his active clip", thePlayer )
	else		else
	outputChatBox("Player '" .. who .. "' not found.", thePlayer)		outputChatBox ( "Player '" .. who .. "' not found.", thePlayer )
	end		end
	end		end
	addCommandHandler( "ammo", showAmmo )		addCommandHandler( "ammo", showAmmo )
	</syntaxhighlight>		</syntaxhighlight>
			</section>

	==See Also==		==See Also==
	{{Player functions}}		{{Player functions}}

Arc at 15:13, 19 August 2007

2007-08-19T15:13:29Z

← Older revision		Revision as of 15:13, 19 August 2007
Line 1:		Line 1:
			{{Server client function}}
	{{Needs_Checking\|Should return ''false'' instead of 0 if player's invalid, for consistency}}		{{Needs_Checking\|Should return ''false'' instead of 0 if player's invalid, for consistency}}
	__NOTOC__		__NOTOC__
Line 4:		Line 5:

	==Syntax==		==Syntax==
			<section name="Server" class="server" show="true">
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	int getPlayerAmmoInClip ( player thePlayer~~, [ int weaponSlot = current ]~~ )		int getPlayerAmmoInClip ( player thePlayer )
	</syntaxhighlight>		</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	*'''thePlayer''': The [[player]] whose ammo you want to check.		*'''thePlayer:''' The [[player]] whose ammo you want to check.

			===Returns===
			Returns an [[int]] containing the amount of ammo in the player's currently selected clip, or 0 if the player specified is invalid.
			</section>

			<section name="Client" class="client" show="true">
			<syntaxhighlight lang="lua">
			int getPlayerAmmoInClip ( player thePlayer [, int weaponSlot = current ] )
			</syntaxhighlight>

			===Required Arguments===
			*'''thePlayer:''' The [[player]] whose ammo you want to check.

	===Optional Arguments===		===Optional Arguments===
	*'''weaponSlot''': an integer representing the weapon slot (set to the ~~players current~~ slot if not ~~given~~)~~. Please note this argument is only relevant when using the function '''clientside'''~~.		*'''weaponSlot:''' an integer representing the weapon slot (set to the player's currently selected slot if not specified).

	===Returns===		===Returns===
	Returns an [[int]] containing the ~~ammount~~ of ammo in the specified player's clip, or 0 if the player specified is invalid.		Returns an [[int]] containing the amount of ammo in the specified player's currently selected or specified clip, or 0 if the player specified is invalid.
			</section>

	==Example==		==Example==
	This example outputs the amount of ammo the specified player has in his current slot. For example: 'ammo someguy'.		This example outputs the amount of ammo the specified player has in his current slot. For example: 'ammo someguy'.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function showAmmo( ~~player~~, command, who )		function showAmmo( thePlayer, command, who )
	~~thePlayer~~ = getPlayerFromNick(who)		local targetPlayer = getPlayerFromNick ( who )
	if (thePlayer ~~~= false~~) then		if ( thePlayer ) then
	local ammo = getPlayerAmmoInClip(~~thePlayer~~)		local ammo = getPlayerAmmoInClip ( targetPlayer )
	outputChatBox(who.." has "..ammo.." in his active clip", ~~player~~)		outputChatBox(who .. " has "..ammo .. " in his active clip", thePlayer)
	else		else
	outputChatBox("Player '"..who.."' not found.", ~~player~~)		outputChatBox("Player '" .. who .. "' not found.", thePlayer)
	end		end
	end		end

Talidan at 21:59, 29 July 2007

2007-07-29T21:59:54Z

← Older revision		Revision as of 21:59, 29 July 2007
Line 12:		Line 12:

	===Optional Arguments===		===Optional Arguments===
	*'''weaponSlot''': an integer representing the weapon slot (set to the players current slot if not given)		*'''weaponSlot''': an integer representing the weapon slot (set to the players current slot if not given). Please note this argument is only relevant when using the function '''clientside'''.

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

Driver2 at 21:45, 29 July 2007

2007-07-29T21:45:12Z

← Older revision		Revision as of 21:45, 29 July 2007
Line 18:		Line 18:

	==Example==		==Example==
	This example outputs the amount of ammo a player ~~called ''Someguy''~~ has in his current ~~weapon~~'~~s clip~~.		This example outputs the amount of ammo the specified player has in his current slot. For example: 'ammo someguy'.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~-- Find the~~ player ~~called 'Someguy'~~		function showAmmo( player, command, who )
	~~myPlayer~~ = ~~findPlayer~~ ( ~~"Someguy"~~ )		thePlayer = getPlayerFromNick(who)
	~~-- If a player called 'Someguy' was found then~~		if (thePlayer ~= false) then
	if ( ~~myPlayer~~ ~= false )		local ammo = getPlayerAmmoInClip(thePlayer)
	~~-- Retrieve the ammount of ammo in the clip for that player, and store it in a variable called 'ammo'~~		outputChatBox(who.." has "..ammo.." in his active clip", player)
	ammo = getPlayerAmmoInClip ( ~~myPlayer~~ )		else
	~~-- Tell all the players how much~~ ammo ~~'Someguy' has~~		outputChatBox("Player '"..who.."' not found.", player)
	outputChatBox ( "~~Someguy~~'~~s current ammo-in-clip:~~ "~~, ammo,~~ "." )		end
	end		end
			addCommandHandler( "ammo", showAmmo )
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		==See Also==
	{{Player functions}}		{{Player functions}}