SetPlayerAnnounceValue

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

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.

For server-wide changes you can use setRuleValue!

Syntax

bool setPlayerAnnounceValue ( element thePlayer, string key, string value )

OOP Syntax Help! I don't understand this!

Method: player:setAnnounceValue(...)
Counterpart: getPlayerAnnounceValue


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

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

Example

Click to collapse [-]
Server

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