GetPlayerAnnounceValue: Difference between revisions
Jump to navigation
Jump to search
m (Syntax section) |
|||
| Line 4: | Line 4: | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">string getPlayerAnnounceValue ( element thePlayer, string key )</syntaxhighlight> | <syntaxhighlight lang="lua">string getPlayerAnnounceValue ( element thePlayer, string key )</syntaxhighlight> | ||
| Line 13: | Line 12: | ||
===Returns=== | ===Returns=== | ||
This function returns a ''string'' containing the requested value if a valid key was specified or ''false'' otherwise. | This function returns a ''string'' containing the requested value if a valid key was specified or ''false'' otherwise. | ||
==Example== | ==Example== | ||
This example adds a command named "getscore" which outputs a players "score" value to his chatbox. | This example adds a command named "getscore" which outputs a players "score" value to his chatbox. | ||
<syntaxhighlight lang="lua">function getScore ( playerSource, cmdName ) | <syntaxhighlight lang="lua">function getScore ( playerSource, cmdName ) | ||
| Line 27: | Line 24: | ||
addCommandHandler ( "getscore", getScore ) | addCommandHandler ( "getscore", getScore ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{Player functions}} | {{Player functions}} | ||
Revision as of 10:53, 15 November 2011
This function retrieves a players ASE announce value under a certain key.
Syntax
string getPlayerAnnounceValue ( element thePlayer, string key )
Required Arguments
- thePlayer: This is the Player whos value you want to retrieve.
- key: The name of the key.
Returns
This function returns a string containing the requested value if a valid key was specified or false otherwise.
Example
This example adds a command named "getscore" which outputs a players "score" value to his chatbox.
function getScore ( playerSource, cmdName )
local scoreValue = getPlayerAnnounceValue ( playerSource, "score" )
if ( scoreValue ) then
outputChatBox ( "Your score: "..scoreValue, playerSource )
end
end
addCommandHandler ( "getscore", getScore )
See Also
- forcePlayerMap
- getAlivePlayers
- getDeadPlayers
- getPlayerACInfo
- getPlayerAnnounceValue
- getPlayerBlurLevel
- getPlayerCount
- getPlayerFromName
- getPlayerIdleTime
- getPlayerIP
- getPlayerMoney
- getPlayerName
- getPlayerNametagColor
- getPlayerNametagText
- getPlayerPing
- getPlayerScriptDebugLevel
- getPlayerSerial
- getPlayerTeam
- getPlayerVersion
- getPlayerWantedLevel
- getRandomPlayer
- givePlayerMoney
- isPlayerMapForced
- isPlayerMuted
- isPlayerNametagShowing
- isVoiceEnabled
- redirectPlayer
- resendPlayerACInfo
- resendPlayerModInfo
- setPlayerAnnounceValue
- setPlayerBlurLevel
- setPlayerHudComponentVisible
- setPlayerMoney
- setPlayerMuted
- setPlayerName
- setPlayerNametagColor
- setPlayerNametagShowing
- setPlayerNametagText
- setPlayerScriptDebugLevel
- setPlayerTeam
- setPlayerVoiceBroadcastTo
- setPlayerVoiceIgnoreFrom
- setPlayerWantedLevel
- spawnPlayer
- takePlayerMoney
- takePlayerScreenShot