IsElementVisibleTo: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(Fix oop syntax)
 
(10 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{Server function}}
__NOTOC__  
__NOTOC__  
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.
This checks if an element is visible to a player. This does not check if the player can literally 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">
bool isElementVisibleTo ( element theElement, player visibleTo )           
bool isElementVisibleTo ( element theElement, element visibleTo )           
</syntaxhighlight>  
</syntaxhighlight>  
{{OOP||[[element]]:isVisibleTo||setElementVisibleTo}}


===Required Arguments===  
===Required Arguments===  
Line 15: Line 17:


==Example==  
==Example==  
<syntaxhighlight lang="lua">
This checks if the player is visible to them selves.
 
<syntaxhighlight lang="lua">addEventHandler("onPlayerSpawn",root,function()
    if not isElementVisibleTo(source,source) then --if the player is not visible to them selves
          setElementVisibleTo(source,source,true) --then make them visible to them selves.
    end
end)
</syntaxhighlight>
</syntaxhighlight>


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

Latest revision as of 17:11, 6 August 2016

This checks if an element is visible to a player. This does not check if the player can literally 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, element visibleTo )

OOP Syntax Help! I don't understand this!

Method: element:isVisibleTo(...)
Counterpart: setElementVisibleTo


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

This checks if the player is visible to them selves. 

addEventHandler("onPlayerSpawn",root,function()
     if not isElementVisibleTo(source,source) then --if the player is not visible to them selves
          setElementVisibleTo(source,source,true) --then make them visible to them selves.
     end
end)

See Also

Shared


Retrieved from "https://wiki.multitheftauto.com/wiki/IsElementVisibleTo?oldid=48727"