SetElementVisibleTo

2020-12-26T00:47:34Z

STKrush:

__NOTOC__
{{Server function}}
{{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?

Does the order of setElementVisibleTo calls really not matter? [[visibility|Visibility]] seems to ''imply'' that the order does matter.

Is this function particularly ''or only'' useful for changing the visibility of markers, radar blips and radar areas?|[[User:EAi|EAi]][[User:Iam2noob4u|Iam2noob4u]]
}}

This function can change an [[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 that contribute to the physics engine). This function is particularly useful for changing the visibility of markers, radar blips and radar areas.

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 object, try [[clearElementVisibleTo]]

==Syntax==
<syntaxhighlight lang="lua">
bool setElementVisibleTo ( element theElement, element visibleTo, bool visible )
</syntaxhighlight>
{{OOP||[[element]]:setVisibleTo||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'.
<syntaxhighlight lang="lua">
-- 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
</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
</syntaxhighlight>

==See Also==
{{Element_functions}}

IsTransferBoxActive

2018-09-29T21:19:32Z

STKrush: /* Example */

__NOTOC__
{{Client function}}
This function returns whether the file downloading dialog box is active or not. This appears when a resource is started and the client doesn't have all the files that resource requires the client to have.

It's important to note that resources aren't started on the client until they're completely downloaded, so a resource cannot use this function to detect if it's own files are downloaded. A client-side resource triggers the [[onClientResourceStart]] event when the files it requires are downloaded.

==Syntax==
<syntaxhighlight lang="lua">
bool isTransferBoxActive ()
</syntaxhighlight>

===Returns===
Returns ''true'' if the file transfer box is visible, ''false'' if not.

==Example==
This makes the camera fade in, once all resource downloads are finished.
<syntaxhighlight lang="lua">
resourceRoot = getResourceRootElement(getThisResource())
function checkTransfer()
if isTransferBoxActive() then
setTimer(checkTransfer,2000,1) -- Check again after 2 seconds
else
fadeCamera(true) -- TransferBox isnt active, fade in camera
end
end
addEventHandler("onClientResourceStart",resourceRoot,checkTransfer)
</syntaxhighlight>

==See Also==
{{GUI_functions}}

Multi Theft Auto: Wiki - User contributions [en]

SetElementVisibleTo

IsTransferBoxActive