ClearElementVisibleTo: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
 
(13 intermediate revisions by 8 users not shown)
Line 1: Line 1:
[[Category:Incomplete]]
__NOTOC__  
__NOTOC__  
This fake function is for use with blah & blah and does blahblahblabhalbhl
{{Server function}}
This function clears any settings added by [[setElementVisibleTo]] and restores an [[element]] to its default [[visibility]].


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool clearElementVisibleTo ( element element )   
bool clearElementVisibleTo ( element theElement )   
</syntaxhighlight>  
</syntaxhighlight>  
{{OOP||[[element]]:clearVisibility|||}}


===Required Arguments===  
===Required Arguments===  
*'''argumentName:''' description
*'''theElement:''' The element in which you wish to restore to its default visibility
 
===Optional Arguments===
{{OptionalArg}}
*'''argumentName2:''' descriptiona
*'''argumentName3:''' description


===Returns===
===Returns===
Returns ''true'' if blah, ''false'' otherwise.
Returns ''true'' if the operation was successful, ''false'' otherwise.


==Example==  
==Example==  
This example does...
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">
--This line does...
-- specify the getBlipAttachedTo function
blabhalbalhb --abababa
function getBlipAttachedTo( thePlayer )
--This line does this...
local blips = getElementsByType( "blip" )
mooo
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", root, clearVisibilityWasted  ) --add an event handler for onPlayerWasted
</syntaxhighlight>
</syntaxhighlight>


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

Latest revision as of 22:29, 6 September 2024

This function clears any settings added by setElementVisibleTo and restores an element to its default visibility.

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", root, clearVisibilityWasted  ) --add an event handler for onPlayerWasted

See Also