SetElementVisibleTo

From Multi Theft Auto: Wiki
Revision as of 23:53, 20 July 2006 by MrJax (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search


Dialog-information.png This article needs checking.

Reason(s): Can an element only be visible to one element (and its children) at a time? If so, do we need clearEntityVisibleTo? If not, surely we need to remove the root element before using this function?

This function can change an entity element's visibility. This does not work with all entities - vehicles, players and objects 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.

Syntax

bool setEntityVisibleTo ( entity theEntity, element visibleTo, bool visible )  

Required Arguments

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

Returns

Returns true if the entity'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
someguy = getFromNick ( "someguy" )
-- If the player was found then
if ( someguy ) then
	-- Get the player position into the variables x, y and z
	x, y, z = getEntityPosition ( someguy )
	-- Create a marker at the player's position
	myMarker = createMarker ( x, y, z )
	-- Make the marker only visible to that player
	setEntityVisibleTo ( myMarker, someguy, true )
end

See Also

Template:Entity functions