OutputConsole

From Multi Theft Auto: Wiki
Revision as of 20:24, 23 January 2012 by Winky- (talk | contribs)
Jump to navigation Jump to search

This outputs the specified text string to the console window (accessed with F8 or ~ key). It can be specified as a message to certain player(s) or all players.

Syntax

bool outputConsole ( string text, [ element visibleTo=getRootElement() ] )

Required Arguments

  • text: The text string that you wish to send to the console window

Optional Arguments

  • visibleTo: This specifies who the chat is visible to. Any players in this element will see the chat message. See visibility.
[[{{{image}}}|link=|]] Note: visibleTo can also be a Team object, in this case, the text will be visible to all the players of that team.

Example

This code creates two console commands. One, 'public', will post a message in the consoles of all players, and the other, 'private', will post a message in only the console of the player that executed the command.

function publicMessage ( sourcePlayer, command )
      outputConsole ( "Public console message" )                -- Display console message for all players
end

function privateMessage ( sourcePlayer, command )
      outputConsole ( "Private console message", sourcePlayer ) -- Send message to whoever entered the /private command
end

addCommandHandler ( "public", publicMessage )
addCommandHandler ( "private", privateMessage )


See Also