TextDisplayGetObservers: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(2 intermediate revisions by one other user not shown)
Line 13: Line 13:


==Example==  
==Example==  
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--TODO
 
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)
</syntaxhighlight>
</syntaxhighlight>
</section>


==See Also==
==See Also==
{{Text functions}}
{{Text functions}}
[[Category:Needs Example]]

Latest revision as of 15:29, 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


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