ClearElementVisibleTo: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Fixed arg name in "Required Arguments")
mNo edit summary
Line 7: Line 7:
bool clearElementVisibleTo ( element theElement )   
bool clearElementVisibleTo ( element theElement )   
</syntaxhighlight>  
</syntaxhighlight>  
{{OOP|||[[element]]:clearVisibility||}}
{{OOP||[[element]]:clearVisibility|||}}


===Required Arguments===  
===Required Arguments===  

Revision as of 16:05, 17 September 2018

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!

Method: element:clearVisibility(...)


Required Arguments

  • theElement: 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