GetPlayerAnnounceValue: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Syntax section)
No edit summary
 
(9 intermediate revisions by 7 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Server function}}
{{Server function}}
This function retrieves a players ASE announce value under a certain key.
{{New feature/item|3.0104|1.0.4||This function retrieves a players ASE announce value under a certain key.|}}


==Syntax==
==Syntax==
<section show="true" name="Server" class="server">
<syntaxhighlight lang="lua">string getPlayerAnnounceValue ( element thePlayer, string key )</syntaxhighlight>
<syntaxhighlight lang="lua">string getPlayerAnnounceValue ( element thePlayer, string key )</syntaxhighlight>
 
{{OOP||[[player]]:getAnnounceValue||setPlayerAnnounceValue}}
===Required Arguments===
===Required Arguments===
*'''thePlayer:''' This is the [[Player]] whos value you want to retrieve.
*'''thePlayer:''' This is the [[Player]] whos value you want to retrieve.
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.
</section>


==Example==
==Example==
<section show="true" name="Server" class="server">
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>
</section>


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

Latest revision as of 21:05, 14 June 2021

This function retrieves a players ASE announce value under a certain key.

Syntax

string getPlayerAnnounceValue ( element thePlayer, string key )

OOP Syntax Help! I don't understand this!

Method: player:getAnnounceValue(...)
Counterpart: setPlayerAnnounceValue


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


Retrieved from "https://wiki.multitheftauto.com/wiki/GetPlayerAnnounceValue?oldid=71292"