TextDisplayGetObservers: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
Line 18: Line 18:
function removeAllObservers ( player , command )
function removeAllObservers ( player , command )
local tObservers = textDisplayGetObservers ( serverDisplay ) -- get a table of all observers in 'serverDisplay' text display
local tObservers = textDisplayGetObservers ( serverDisplay ) -- get a table of all observers in 'serverDisplay' text display
if tObservers then
if tObservers then -- if got the table
for index,player in ipairs ( tObservers ) do
for index,player in ipairs ( tObservers ) do -- loop the table
textDisplayRemoveObserver ( serverDisplay , player )
textDisplayRemoveObserver ( serverDisplay , player ) -- remove the player from the text display
end
end
end
end

Revision as of 10:25, 22 May 2012

This function can be used to retrieve all the players currently observing a specified textdisplay.

Syntax

table textDisplayGetObservers ( textdisplay theDisplay )

Required Arguments

  • theDisplay: The textdisplay of which observers you want to get.

Returns

Returns a table of players that are observers of the display or false if invalid textdisplay is passed.

Example

Click to collapse [-]
Server

function removeAllObservers ( player , command )
	local tObservers = textDisplayGetObservers ( serverDisplay ) -- get a table of all observers in 'serverDisplay' text display
	if tObservers then -- if got the table
		for index,player in ipairs ( tObservers ) do -- loop the table
			textDisplayRemoveObserver ( serverDisplay , player ) -- remove the player from the text display
		end
	end
end
addCommandHandler("removeAllObservers",removeAllObservers)

See Also