ClearElementVisibleTo: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
Line 7: Line 7:
bool clearElementVisibleTo ( element theElement )   
bool clearElementVisibleTo ( element theElement )   
</syntaxhighlight>  
</syntaxhighlight>  
{{OOP|This function is also a static function underneath the Element class.|[[element]]:clearVisibility||}}


===Required Arguments===  
===Required Arguments===  
Line 15: Line 16:


==Example==  
==Example==  
<section name="Server" class="server" show="true">
This example clears any visibility settings after a player dies, so everyone can see his blip for a short period
This example clears any visibility settings after a player dies, so everyone can see his blip for a short period
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
Line 34: Line 34:
addEventHandler ( "onPlayerWasted", getRootElement(), clearVisibilityWasted  ) --add an event handler for onPlayerWasted
addEventHandler ( "onPlayerWasted", getRootElement(), clearVisibilityWasted  ) --add an event handler for onPlayerWasted
</syntaxhighlight>
</syntaxhighlight>
</section>


==See Also==
==See Also==
{{Element_functions}}
{{Element_functions}}

Revision as of 15:41, 16 August 2014

This function clears any settings added by setElementVisibleTo and restores an element to its default 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 clearElementVisibleTo ( element theElement )

OOP Syntax Help! I don't understand this!

Note: This function is also a static function underneath the Element class.
Method: element:clearVisibility(...)


Required Arguments

  • element: The element in which you wish to restore to its default visibility

Returns

Returns true if the operation was successful, false otherwise.

Example

This example clears any visibility settings after a player dies, so everyone can see his blip for a short period 

-- specify the getBlipAttachedTo function
function getBlipAttachedTo( thePlayer )
	local blips = getElementsByType( "blip" )
	for k, theBlip in ipairs( blips ) do
		if getElementAttachedTo( theBlip ) == thePlayer then
			return theBlip
		end
	end
	return false
end

function clearVisibilityWasted ( totalammo, killer, killerweapon, bodypart ) -- when a player dies
    clearElementVisibleTo ( getBlipAttachedTo ( source ) ) -- clear any visiblity settings of his blip
end
addEventHandler ( "onPlayerWasted", getRootElement(), clearVisibilityWasted  ) --add an event handler for onPlayerWasted

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/ClearElementVisibleTo?oldid=41420"