IsElementVisibleTo: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 3: Line 3:


__NOTOC__  
__NOTOC__  
This function is for blahblah.. not defined yet
This checks if an element is visible to a player. This does not check if the player can litterally see the element, just that they are aware that it exists. Some so-called [[per-player elements]] are able to be visible only to some players, as such this checks if this is the case for a particular element/player combination.


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
INSERT SYNTAX HERE             
bool isElementVisibleTo ( element theElement, player visibleTo )         
</syntaxhighlight>  
</syntaxhighlight>  


===Required Arguments===  
===Required Arguments===  
*'''argumentName:''' description
*'''theElement:''' The element you want to check the visibility of
 
*'''visibleTo:''' The player you want to check against
===Optional Arguments===
{{OptionalArg}}
*'''argumentName2:''' descriptiona
*'''argumentName3:''' description


===Returns===
===Returns===
Returns ''true'' if blah, ''false'' otherwise.
Returns ''true'' if element is visible to the specified player, ''false'' if not or an invalid argument was passed to the function.


==Example==  
==Example==  
This example does...
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--This line does...
 
blabhalbalhb --abababa
--This line does this...
mooo
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{FunctionArea_Functions}}
{{Element_functions}}
[[Category:Needs Example]]

Revision as of 12:07, 12 September 2006


This checks if an element is visible to a player. This does not check if the player can litterally see the element, just that they are aware that it exists. Some so-called per-player elements are able to be visible only to some players, as such this checks if this is the case for a particular element/player combination.

Syntax

bool isElementVisibleTo ( element theElement, player visibleTo )          

Required Arguments

  • theElement: The element you want to check the visibility of
  • visibleTo: The player you want to check against

Returns

Returns true if element is visible to the specified player, false if not or an invalid argument was passed to the function.

Example


See Also