OutputConsole - Revision history

Quiret: added notes about limitations

2020-01-18T10:54:00Z

added notes about limitations

← Older revision		Revision as of 10:54, 18 January 2020
Line 19:		Line 19:
	*'''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\|'''visibleTo''' can also be a Team object, in this case, the text will be visible to all the players of that team.}}</section>		{{Note\|'''visibleTo''' can also be a Team object, in this case, the text will be visible to all the players of that team.}}</section>

			==Remarks==
			The serverside function has a limitation of 1000 characters for the text parameter. Anything beyond 1000 characters is trimmed away. This limitation does not apply to the clientside version.

	==Example==		==Example==

Jack Johnson: Shortened down the function by taking advantage of the command variable.

2015-01-14T12:53:52Z

Shortened down the function by taking advantage of the command variable.

← Older revision		Revision as of 12:53, 14 January 2015
Line 23:		Line 23:
	<section name="Server" class="server" show="true">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.		<section name="Server" class="server" show="true">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.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function ~~publicMessage~~ ( ~~sourcePlayer~~, command )		function message(player,command)
	outputConsole ( "Public console message" ) ~~-- Display~~ console message ~~for all players~~		if command == "public" then
			outputConsole("Public console message")
			else
			outputConsole("Private console message",player)
			end
	end		end
			addCommandHandler("public",message)
	~~function privateMessage ( sourcePlayer, command )~~		addCommandHandler("private",message)
	~~outputConsole ( "Private console message", sourcePlayer ) -- Send message to whoever entered the /private command~~
	~~end~~

	addCommandHandler ( "public", ~~publicMessage~~ )
	addCommandHandler ( "private", ~~privateMessage~~ )
	</syntaxhighlight></section>		</syntaxhighlight></section>

	==See Also==		==See Also==
	{{Server functions}}		{{Server functions}}

Lopez: visibleTo is only serverside argument so I changed this page a little

2014-07-29T08:24:47Z

visibleTo is only serverside argument so I changed this page a little

← Older revision		Revision as of 08:24, 29 July 2014
Line 4:		Line 4:

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">bool outputConsole ( string text, [ element visibleTo=getRootElement() ] )</syntaxhighlight>		<section name="Client" class="client" show="true">
			<syntaxhighlight lang="lua">bool outputConsole ( string text )</syntaxhighlight>

			===Required Arguments===
			*'''text:''' The text string that you wish to send to the console window
			</section>

			<section name="Server" class="server" show="true"><syntaxhighlight lang="lua">bool outputConsole ( string text, [ element visibleTo=getRootElement() ] )</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
Line 11:		Line 18:
	===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\|'''visibleTo''' can also be a Team object, in this case, the text will be visible to all the players of that team.}}		{{Note\|'''visibleTo''' can also be a Team object, in this case, the text will be visible to all the players of that team.}}</section>

	==Example==		==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.		<section name="Server" class="server" show="true">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.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function publicMessage ( sourcePlayer, command )		function publicMessage ( sourcePlayer, command )
Line 26:		Line 33:
	addCommandHandler ( "public", publicMessage )		addCommandHandler ( "public", publicMessage )
	addCommandHandler ( "private", privateMessage )		addCommandHandler ( "private", privateMessage )
	</syntaxhighlight>		</syntaxhighlight></section>



	==See Also==		==See Also==
	{{Server functions}}		{{Server functions}}

Winky- at 20:24, 23 January 2012

2012-01-23T20:24:48Z

← Older revision		Revision as of 20:24, 23 January 2012
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: '''visibleTo''' can also be a Team object, in this case, the text will be visible to all the players of that team.		{{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==

Arc at 18:22, 16 August 2007

2007-08-16T18:22:29Z

← Older revision		Revision as of 18:22, 16 August 2007
Line 1:		Line 1:
	__NOTOC__		{{Server client function}}
			__NOTOC__
	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.		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==		==Syntax==
	<syntaxhighlight lang="lua">bool outputConsole ( string text, [ element visibleTo=~~getrootelement~~() ] )</syntaxhighlight>		<syntaxhighlight lang="lua">bool outputConsole ( string text, [ element visibleTo=getRootElement() ] )</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
Line 12:		Line 13:
	Note: '''visibleTo''' can also be a Team object, in this case, the text will be visible to all the players of that team.		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==
	<syntaxhighlight lang="lua">~~root = getRootElement ()~~		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.
	~~addCommandHandler ( "onPlayerConsole", root, "onConsole" )~~		<syntaxhighlight lang="lua">
	function ~~onConsole~~ ( ~~message )~~		function publicMessage ( sourcePlayer, command )
	~~local command = gettok(message, 1~~, ~~32) --The varible "command" equals text a player types in the console~~		outputConsole ( "Public console message" ) -- Display console message for all players
	~~if (~~command ~~== "!public"~~) ~~then --If players typed text equals !public~~		end
	outputConsole ( "Public console message" ) --Display console message to all players
	~~elseif~~ (command ~~== "!private"~~) ~~then --If players typed text equals !private~~		function privateMessage ( sourcePlayer, command )
	outputConsole ( "Private console message", ~~source~~ ) --Send message to whoever entered the ~~text !~~private		outputConsole ( "Private console message", sourcePlayer ) -- Send message to whoever entered the /private command
	end		end
	~~end~~</syntaxhighlight>
			addCommandHandler ( "public", publicMessage )
			addCommandHandler ( "private", privateMessage )
			</syntaxhighlight>

Erorr404 at 02:11, 4 November 2006

2006-11-04T02:11:56Z

← Older revision		Revision as of 02:11, 4 November 2006
Line 18:		Line 18:
	local command = gettok(message, 1, 32) --The varible "command" equals text a player types in the console		local command = gettok(message, 1, 32) --The varible "command" equals text a player types in the console
	if (command == "!public") then --If players typed text equals !public		if (command == "!public") then --If players typed text equals !public
	~~outputChatBox~~ ( "Public console message" ) --Display console message to all players		outputConsole ( "Public console message" ) --Display console message to all players
	elseif (command == "!private") then --If players typed text equals !private		elseif (command == "!private") then --If players typed text equals !private
	~~outputChatBox~~ ( "Private console message", source ) --Send message to whoever entered the text !private		outputConsole ( "Private console message", source ) --Send message to whoever entered the text !private
	end		end
	end</syntaxhighlight>		end</syntaxhighlight>

MrJax at 14:26, 16 August 2006

2006-08-16T14:26:02Z

← Older revision		Revision as of 14:26, 16 August 2006
Line 10:		Line 10:
	===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: '''visibleTo''' can also be a Team object, in this case, the text will be visible to all the players of that team.

	==Example==		==Example==

Ransom: /* See Also */

2006-05-20T20:23:16Z

Ransom at 20:23, 20 May 2006

2006-05-20T20:23:01Z

← Older revision		Revision as of 20:23, 20 May 2006
Line 24:		Line 24:

	==See Also==		==See Also==
	{{~~Player Functions~~}}		==See Also==
			{{Server functions}}

Ransom at 20:20, 20 May 2006

2006-05-20T20:20:05Z

← Older revision		Revision as of 20:20, 20 May 2006
Line 22:		Line 22:
	end		end
	end</syntaxhighlight>		end</syntaxhighlight>

			==See Also==
			{{Player Functions}}