GetPlayerAnnounceValue: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
m (Syntax section)
Line 4: Line 4:


==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>


Line 12: Line 13:
===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==

Revision as of 22:29, 14 November 2011

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

Syntax

Click to collapse [-]
Server
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

Click to collapse [-]
Server

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=27855"