GetPlayerAmmoInClip: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
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]]

Revision as of 16:10, 29 November 2007

This function returns an integer that contains the ammo in a specified player's weapon. See Weapon Info

Syntax

Click to collapse [-]
Server
int getPlayerAmmoInClip ( player thePlayer )

Required Arguments

  • 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.

Click to collapse [-]
Client
int getPlayerAmmoInClip ( player thePlayer [, int weaponSlot = current ] )

Required Arguments

  • thePlayer: The player whose ammo you want to check.

Optional Arguments

  • weaponSlot: an integer representing the weapon slot (set to the player's currently selected slot if not specified).

Returns

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.

Example

Click to collapse [-]
Server

This example outputs the amount of ammo the specified player has in his current slot. For example: 'ammo someguy'.

function showAmmo( thePlayer, command, who )
	local targetPlayer = getPlayerFromNick ( who )
	if ( thePlayer ) then
		local ammo = getPlayerAmmoInClip ( targetPlayer )
		outputChatBox ( who .. " has " .. ammo .. " ammo in his active clip", thePlayer )
	else
		outputChatBox ( "Player '" .. who .. "' not found.", thePlayer )
	end
end
addCommandHandler( "ammo", showAmmo )

See Also