setPlayerAnnounceValue | Multi Theft Auto: Wiki Skip to content
Multi Theft Auto: Wiki

setPlayerAnnounceValue

Client-side
Server-side
Shared

Pair: getPlayerAnnounceValue

Manual Review Required

Please finish this page using the corresponding Old Wiki article. Go to Contribution guidelines for more information.

This function allows you to change ASE announce values for any player using a specified key. As an example this can be used to change the "score" value which will be shown at game-state.com's server list.

OOP Syntax Help! I don't understand this!

  • Method:player:setAnnounceValue(...)

Syntax 

bool setPlayerAnnounceValue ( element thePlayer, string key, string value )
Required Arguments
  • thePlayer: The player whos announce value you wish to change.
  • key: The key which the value will be stored at.
  • value: The value you wish to store.

Returns

  • bool: value

Returns true if the value was set succesfully, false otherwise.

Code Examples

shared

This small example adds a command that allows you to set your own "score" value.

function setScore ( playerSource, cmdName, scoreValue )
    if ( scoreValue ) then
        setPlayerAnnounceValue ( playerSource, "score", scoreValue )
    end
end


addCommandHandler ( "score", setScore )

See Also

Player Functions
Player Events
Reference