TextDisplayRemoveText

Description

This function remove a textitem from a textdisplay. This stops any observers of the textdisplay from being able to see the textitem.

Syntax

void textDisplayRemoveText ( textitem itemToRemove, textdisplay displayToAddRemoveFrom )

Required Arguments

• itemToRemoveFrom: The textitem to remove from the display.
• displayToRemove: The textdisplay to remove the textitem from.

Example

-- 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 )