GetPlayerAnnounceValue: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(invalid template)
 
(4 intermediate revisions by one other user not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Server function}}
{{Server function}}
{{New feature/item|3.0104|1.0.4||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==
Line 26: Line 26:


==See Also==
==See Also==
{{Player functions}}
{{Player functions|server}}
[[Category:Changes_in_1.0]]

Latest revision as of 22:40, 6 September 2024

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