textDisplayRemoveText
Client-side
Server-side
Shared
Manual Review Required
Please finish this page using the corresponding Old Wiki article. Go to Contribution guidelines for more information.
This function removes a textitem from a textdisplay. This stops any observers of the textdisplay from being able to see the textitem.
Syntax
textDisplayRemoveText ( textdisplay displayToRemoveFrom, textitem itemToRemove )Required Arguments
- displayToRemoveFrom: The textdisplay to remove the textitem from.
- itemToRemove: The textitem to remove from the display.
Code Examples
shared
This example creates a text display and adds a "Hello World" text item to it. It then removes that text item 5 seconds later.
-- Create a text display.myTextDisplay = textCreateDisplay ( )-- Add a player as an observer, i.e. this player will see everything added to this displaytextDisplayAddObserver ( 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 displaytextDisplayAddText ( myTextDisplay, myTextItem )-- Remove the text item from the displaysetTimer ( textDisplayRemoveText, 5000, 1, myTestDispay, myTextItem )See Also
Text Functions
- textCreateDisplay
- textCreateTextItem
- textDestroyDisplay
- textDestroyTextItem
- textDisplayAddObserver
- textDisplayAddText
- textDisplayGetObservers
- textDisplayIsObserver
- textDisplayRemoveObserver
- textDisplayRemoveText
- textItemGetColor
- textItemGetPosition
- textItemGetPriority
- textItemGetScale
- textItemGetText
- textItemSetColor
- textItemSetPosition
- textItemSetPriority
- textItemSetScale
- textItemSetText