OutputConsole: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
mNo edit summary |
||
Line 11: | Line 11: | ||
===Optional Arguments=== | ===Optional Arguments=== | ||
*'''visibleTo:''' This specifies who the chat is visible to. Any players in this element will see the chat message. See [[visibility]]. | *'''visibleTo:''' This specifies who the chat is visible to. Any players in this element will see the chat message. See [[visibility]]. | ||
Note | {{Note|'''visibleTo''' can also be a Team object, in this case, the text will be visible to all the players of that team.}} | ||
==Example== | ==Example== |
Revision as of 20:24, 23 January 2012
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.
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
- getMaxPlayers
- getServerConfigSetting
- getServerHttpPort
- getServerName
- getServerPassword
- getServerPort
- isGlitchEnabled
- setGlitchEnabled
- setMaxPlayers
- setServerConfigSetting
- setServerPassword
- shutdown