SetElementVisibleTo: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(28 intermediate revisions by 20 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__
{{Needs_Checking|Can an element only be visible to one element (and its children) at a time? If so, do we need clearElementVisibleTo? If not, surely we need to remove the root element before using this function?|[[User:EAi|EAi]]}}
{{Server function}}


This function can change an [[element]] [[element]]'s [[visibility]]. This does not work with all entities - [[vehicle]]s, [[player]]s and [[object]]s are exempt. This is because these objects are required for accurate sync (they're physical objects). This function is particularily useful for changing the visibility of markers, radar blips and radar areas.
This function can change an [[element]]'s [[visibility]].
 
This function only works with the following elements.
* [[Marker]]s
* [[Blip]]s
* [[Radararea]]s
 
Visibility settings of lower elements in the element tree override higher ones - if visibility for root is set to false and for a player is set to true, it will be visible to the player.
 
If you want to clear all visibility settings of an [[element]], try [[clearElementVisibleTo]]
 
Setting visibility for one element will also set visibility for all of its children.<br/>
Order of '''setElementVisibleTo''' calls doesn't matter.


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool setElementVisibleTo ( element theElement, element visibleTo, bool visible )
bool setElementVisibleTo ( element theElement, element visibleTo, bool visible )
</syntaxhighlight>  
</syntaxhighlight>  
{{OOP||[[element]]:setVisibleTo||isElementVisibleTo}}


===Required Arguments===  
===Required Arguments===  
*'''theElement:''' The element you want to control the visibility of.
*'''theElement:''' The element you want to control the visibility of.
*'''visibleTo:''' The element you wish the element to be visible or invisible to. Any child elements that are players will also be able to see the element. See [[visibility]].
*'''visibleTo:''' The element you wish the element to be visible or invisible to. Any child elements that are players will also be able to see the element. See [[visibility]].
*'''visible:''' Whether you are making it visible or invisible to the player.


===Returns===
===Returns===
Line 20: Line 34:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
-- Find the player called someguy
-- Find the player called someguy
someguy = getFromNick ( "someguy" )
local someguy = getPlayerFromName ( "someguy" )
-- If the player was found then
-- If the player was found then
if ( someguy ) then
if ( someguy ) then
-- Get the player position into the variables x, y and z
-- Get the player's position into the variables x, y and z
x, y, z = getElementPosition ( someguy )
x, y, z = getElementPosition ( someguy )
-- Create a marker at the player's position
-- Create a marker at the player's position
myMarker = createMarker ( x, y, z )
myMarker = createMarker ( x, y, z )
-- Make the marker only visible to that player
-- Then make the marker invisible to the whole dimension (root for the first)
setElementVisibleTo ( myMarker, root, false )
-- Set marker visibility to true for someguy
setElementVisibleTo ( myMarker, someguy, true )
setElementVisibleTo ( myMarker, someguy, true )
-- The order in which you do the visibility changes does not matter, but ideally trues should be set before falses in order to prevent a momentary flicker.
end
</syntaxhighlight>
The following example shows how to make the marker visible to everyone except anotherguy
<syntaxhighlight lang="lua">
-- Find the player called someguy
local someguy = getPlayerFromName ( "someguy" )
local anotherguy = getPlayerFromName ( "anotherguy" )
-- If the player was found then
if ( someguy ) then
-- Get the player's position into the variables x, y and z
x, y, z = getElementPosition ( someguy )
-- Create a marker at the player's position
myMarker = createMarker ( x, y, z )
attachElements(myMarker, someguy)
-- First make sure everyone is able to see the marker, this line is unnecessary in this case as root visibility is set to true by default behaviour
setElementVisibleTo ( myMarker, root, true )
-- Then hide it from anotherguy
setElementVisibleTo ( myMarker, anotherguy, false )
end
end
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{Element_functions}}
{{Element_functions|server}}

Latest revision as of 22:32, 6 September 2024

This function can change an element's visibility.

This function only works with the following elements.

Visibility settings of lower elements in the element tree override higher ones - if visibility for root is set to false and for a player is set to true, it will be visible to the player.

If you want to clear all visibility settings of an element, try clearElementVisibleTo

Setting visibility for one element will also set visibility for all of its children.
Order of setElementVisibleTo calls doesn't matter.

Syntax

bool setElementVisibleTo ( element theElement, element visibleTo, bool visible )

OOP Syntax Help! I don't understand this!

Method: element:setVisibleTo(...)
Counterpart: isElementVisibleTo


Required Arguments

  • theElement: The element you want to control the visibility of.
  • visibleTo: The element you wish the element to be visible or invisible to. Any child elements that are players will also be able to see the element. See visibility.
  • visible: Whether you are making it visible or invisible to the player.

Returns

Returns true if the element's visibility was changed successfully, false otherwise, for example if you are trying to change the visibility of a vehicle, player or object.

Example

This example creates a marker and makes it only visibile to the player called 'someguy'. 

-- Find the player called someguy
local someguy = getPlayerFromName ( "someguy" )
-- If the player was found then
if ( someguy ) then
	-- Get the player's position into the variables x, y and z
	x, y, z = getElementPosition ( someguy )
	-- Create a marker at the player's position
	myMarker = createMarker ( x, y, z )
	
	-- Then make the marker invisible to the whole dimension (root for the first)
	setElementVisibleTo ( myMarker, root, false )
	-- Set marker visibility to true for someguy
	setElementVisibleTo ( myMarker, someguy, true )
	
	-- The order in which you do the visibility changes does not matter, but ideally trues should be set before falses in order to prevent a momentary flicker.
end

The following example shows how to make the marker visible to everyone except anotherguy 

-- Find the player called someguy
local someguy = getPlayerFromName ( "someguy" )
local anotherguy = getPlayerFromName ( "anotherguy" )
-- If the player was found then
if ( someguy ) then
	-- Get the player's position into the variables x, y and z
	x, y, z = getElementPosition ( someguy )
	-- Create a marker at the player's position
	myMarker = createMarker ( x, y, z )
	attachElements(myMarker, someguy)

	-- First make sure everyone is able to see the marker, this line is unnecessary in this case as root visibility is set to true by default behaviour
	setElementVisibleTo ( myMarker, root, true )

	-- Then hide it from anotherguy
	setElementVisibleTo ( myMarker, anotherguy, false )
end

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/SetElementVisibleTo?oldid=80365"