GetPlayerTotalAmmo: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
Line 1: | Line 1: | ||
{{Needs_Checking|Should return ''false'' instead of 0 if player's invalid, for consistency}} | |||
__NOTOC__ | __NOTOC__ | ||
This function returns an integer that contains the total ammo in a specified [[player]]'s weapon. See [[weapon|Weapon Info]] | This function returns an integer that contains the total ammo in a specified [[player]]'s weapon. See [[weapon|Weapon Info]] |
Revision as of 00:11, 2 March 2007
This article needs checking. | |
Reason(s): Should return false instead of 0 if player's invalid, for consistency |
This function returns an integer that contains the total ammo in a specified player's weapon. See Weapon Info
Syntax
int getPlayerTotalAmmo ( 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 players current slot if not given)
Returns
Returns an int containing the total amount of ammo for the specified player's weapon, or 0 if the player specified is invalid.
Example
This example outputs the total amount of ammo a player called Someguy has for his weapon.
-- Find the player called 'Someguy' myPlayer = findPlayer ( "Someguy" ) -- If a player called 'Someguy' was found then if ( myPlayer ~= false ) -- Retrieve the total amount of ammo for that player, and store it in a variable called 'ammo' ammo = getPlayerTotalAmmo ( myPlayer ) -- Tell all the players how much ammo 'Someguy' has outputChatBox ( "Someguy's current total ammo: ", ammo, "." ) end
See Also
- getPlayerTeam
- getPlayerBlurLevel
- setPlayerBlurLevel
- getPlayerSerial
- forcePlayerMap
- getPlayerScriptDebugLevel
- getPlayerFromName
- getPlayerMoney
- getPlayerName
- getPlayerNametagColor
- getPlayerNametagText
- getPlayerPing
- getPlayerWantedLevel
- givePlayerMoney
- isPlayerMapForced
- isPlayerNametagShowing
- setPlayerHudComponentVisible
- setPlayerMoney
- setPlayerNametagColor
- setPlayerNametagShowing
- setPlayerNametagText
- takePlayerMoney
- countPlayersInTeam
- getPlayersInTeam
- isVoiceEnabled
- setControlState
- getControlState