TextDisplayRemoveText - Revision history

NOki: Changed argument order

2016-07-06T08:20:25Z

Changed argument order

← Older revision		Revision as of 08:20, 6 July 2016
Line 9:		Line 9:

	===Required Arguments===		===Required Arguments===
			* '''displayToRemoveFrom''': The [[textdisplay]] to remove the [[textitem]] from.
	* '''itemToRemove''': The [[textitem]] to remove from the display.		* '''itemToRemove''': The [[textitem]] to remove from the display.
	* '''displayToRemoveFrom''': The [[textdisplay]] to remove the [[textitem]] from.

	==Example==		==Example==

EAi at 15:21, 23 February 2008

2008-02-23T15:21:46Z

← Older revision		Revision as of 15:21, 23 February 2008
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server function}}		{{Server function}}
	~~==Description==~~
	This function removes a [[textitem]] from a [[textdisplay]]. This stops any observers of the [[textdisplay]] from being able to see the [[textitem]].		This function removes a [[textitem]] from a [[textdisplay]]. This stops any observers of the [[textdisplay]] from being able to see the [[textitem]].

Jax at 13:45, 23 February 2008

2008-02-23T13:45:51Z

← Older revision		Revision as of 13:45, 23 February 2008
Line 6:		Line 6:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	void textDisplayRemoveText ( textitem itemToRemove~~, textdisplay displayToRemoveFrom~~ )		void textDisplayRemoveText ( textdisplay displayToRemoveFrom, textitem itemToRemove )
	</syntaxhighlight>		</syntaxhighlight>

Talidan at 14:08, 29 August 2007

2007-08-29T14:08:15Z

← Older revision		Revision as of 14:08, 29 August 2007
Line 14:		Line 14:

	==Example==		==Example==
			This example creates a text display and adds a "Hello World" text item to it. It then removes that text item 5 seconds later.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	-- Create a text display.		-- Create a text display.
Line 24:		Line 25:
	textDisplayAddText ( myTextDisplay, myTextItem )		textDisplayAddText ( myTextDisplay, myTextItem )
	-- Remove the text item from the display		-- Remove the text item from the display
	textDisplayRemoveText ( myTestDispay, myTextItem )		setTimer ( textDisplayRemoveText, 5000, 1, myTestDispay, myTextItem )
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		==See Also==
	{{Text functions}}		{{Text functions}}

Arc at 18:20, 21 August 2007

2007-08-21T18:20:38Z

← Older revision		Revision as of 18:20, 21 August 2007
Line 2:		Line 2:
	{{Server function}}		{{Server function}}
	==Description==		==Description==
	This function ~~remove~~ a [[textitem]] from a [[textdisplay]]. This stops any observers of the [[textdisplay]] from being able to see the [[textitem]].		This function removes a [[textitem]] from a [[textdisplay]]. This stops any observers of the [[textdisplay]] from being able to see the [[textitem]].

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	void textDisplayRemoveText ( textitem itemToRemove, textdisplay ~~displayToAddRemoveFrom~~ )		void textDisplayRemoveText ( textitem itemToRemove, textdisplay displayToRemoveFrom )
	</syntaxhighlight>		</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	* '''~~itemToRemoveFrom~~''': The [[textitem]] to remove from the display.		* '''itemToRemove''': The [[textitem]] to remove from the display.
	* '''~~displayToRemove~~''': The [[textdisplay]] to remove the [[textitem]] from.		* '''displayToRemoveFrom''': The [[textdisplay]] to remove the [[textitem]] from.

	==Example==		==Example==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	-- Create a text display.		-- Create a text display.
	myTextDisplay = textCreateDisplay ()		myTextDisplay = textCreateDisplay ( )
	-- Add a player as an observer, i.e. this player will see everything added to this display		-- Add a player as an observer, i.e. this player will see everything added to this display
	textDisplayAddObserver ( myTextDisplay, aPlayer )		textDisplayAddObserver ( myTextDisplay, aPlayer )
Line 28:		Line 28:

	==See Also==		==See Also==
	{{Text ~~Functions~~}}		{{Text functions}}

Arc at 17:37, 15 August 2007

2007-08-15T17:37:57Z

← Older revision		Revision as of 17:37, 15 August 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
			{{Server function}}
	==Description==		==Description==
	This function remove a [[textitem]] from a [[textdisplay]]. This stops any observers of the [[textdisplay]] from being able to see the [[textitem]].		This function remove a [[textitem]] from a [[textdisplay]]. This stops any observers of the [[textdisplay]] from being able to see the [[textitem]].

MrJax at 21:04, 6 June 2006

2006-06-06T21:04:57Z

New page

__NOTOC__
==Description==
This function remove a [[textitem]] from a [[textdisplay]]. This stops any observers of the [[textdisplay]] from being able to see the [[textitem]].

==Syntax==
<syntaxhighlight lang="lua">
void textDisplayRemoveText ( textitem itemToRemove, textdisplay displayToAddRemoveFrom )
</syntaxhighlight>

===Required Arguments===
* '''itemToRemoveFrom''': The [[textitem]] to remove from the display.
* '''displayToRemove''': The [[textdisplay]] to remove the [[textitem]] from.

==Example==
<syntaxhighlight lang="lua">
-- Create a text display.
myTextDisplay = textCreateDisplay ()
-- Add a player as an observer, i.e. this player will see everything added to this display
textDisplayAddObserver ( myTextDisplay, aPlayer )
-- Create a new text item with the text 'Hello World' and a priority of 'low' and colored red.
myTextItem = textCreateTextItem ( "Hello World", 0.5, 0.5, "low", 255, 0, 0, 0, 1.0 )
-- Add the newly created text item to the display
textDisplayAddText ( myTextDisplay, myTextItem )
-- Remove the text item from the display
textDisplayRemoveText ( myTestDispay, myTextItem )
</syntaxhighlight>

==See Also==
{{Text Functions}}