GetPlayerArmor: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (Changed "DeprecatedWithAlt" template to "Deprecated") |
||
| (5 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server client function}} | |||
{{Deprecated|getPedArmor|}} | |||
This function returns a float that contains the current armor for the specified [[player]]. | This function returns a float that contains the current armor for the specified [[player]]. | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">float getPlayerArmor ( player | <syntaxhighlight lang="lua">float getPlayerArmor ( player thePlayer )</syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
*''' | *'''thePlayer:''' The [[player]] whose armor you want to check | ||
==Returns== | ===Returns=== | ||
A ''float'' with the armor, ''false'' if | A ''float'' with the armor, ''false'' if an invalid player was given. | ||
==Example== | ==Example== | ||
This example | This example defines a "showarmor" console command that shows the player that executes it how much armor he has. | ||
<section name="Client" class="client" show="true"> | |||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function showArmor( | function showArmor ( ) | ||
local armor = getPlayerArmor( | local me = getLocalPlayer ( ) | ||
outputChatBox("Your armor: "..armor) | local armor = getPlayerArmor ( me ) | ||
outputChatBox( "Your armor: " .. armor, me ) | |||
end | end | ||
addCommandHandler(" | addCommandHandler ( "showarmor", showArmor ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
</section> | |||
==See Also== | ==See Also== | ||
{{Player functions}} | {{Player functions}} | ||
Latest revision as of 16:14, 13 February 2015
|
This function is deprecated. This means that its use is discouraged and that it might not exist in future versions. |
Please use getPedArmor instead. |
This function returns a float that contains the current armor for the specified player.
Syntax
float getPlayerArmor ( player thePlayer )
Required Arguments
- thePlayer: The player whose armor you want to check
Returns
A float with the armor, false if an invalid player was given.
Example
This example defines a "showarmor" console command that shows the player that executes it how much armor he has.
Click to collapse [-]
Clientfunction showArmor ( ) local me = getLocalPlayer ( ) local armor = getPlayerArmor ( me ) outputChatBox( "Your armor: " .. armor, me ) end addCommandHandler ( "showarmor", showArmor )
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