SetElementAlpha: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
{{Server client function}}
{{Server client function}}
__NOTOC__
__NOTOC__
This function sets the alpha(transparency) value for the specified [[element]]. This can be a [[player]] or a [[vehicle]].
This function sets the alpha (transparency) value for the specified [[element]]. This can be a [[player]], [[ped]], [[object]] or [[vehicle]].


==Syntax==
==Syntax==
Line 10: Line 10:
===Required Arguments===
===Required Arguments===
*'''theElement:''' The [[element]] whose alpha you want to set.
*'''theElement:''' The [[element]] whose alpha you want to set.
*'''alpha:'''  The alpha value to set. Value can be 0-255, where 255 is fully opaque and 0 is fully transparent.
*'''alpha:'''  The alpha value to set. Values are 0-255, where 255 is fully opaque and 0 is fully transparent.
** '''Note:''' [[Object]]s are fully transparent at 140.  
===Returns===
===Returns===
Returns ''false'' if invalid arguments were passed.
Returns ''true'' or ''false'' if invalid arguments were passed.


==Example==
==Example==
Line 19: Line 20:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function invisible()
function invisible()
         setElementAlpha(getLocalPlayer(), 0)
         setElementAlpha(localPlayer, 0)
end
end
addCommandHandler ( "invisible", invisible )
addCommandHandler ( "invisible", invisible )

Revision as of 19:35, 14 January 2014

This function sets the alpha (transparency) value for the specified element. This can be a player, ped, object or vehicle.

Syntax

bool setElementAlpha ( element theElement, int alpha )

Required Arguments

  • theElement: The element whose alpha you want to set.
  • alpha: The alpha value to set. Values are 0-255, where 255 is fully opaque and 0 is fully transparent.
    • Note: Objects are fully transparent at 140.

Returns

Returns true or false if invalid arguments were passed.

Example

Click to collapse [-]
Clientside example

This example makes the player invisible. 

function invisible()
        setElementAlpha(localPlayer, 0)
end
addCommandHandler ( "invisible", invisible )
Click to collapse [-]
Serverside example

This example lets you toggle invisibility when you write /invis. 

function toggleInvis ( thePlayer )  -- thePlayer is whoever executed the command
        if getElementAlpha( thePlayer ) == 0 then		-- if the player is NOT invisible
		setElementAlpha ( thePlayer, 0 )	-- set the players alpha to 0 (make them invisible)
	else			-- else, if the source player IS visible
		setElementAlpha ( thePlayer, 255 )	-- set the players alpha to 255 (make them 100% visible)
	end
end
addCommandHandler ( "invis", toggleInvis )	-- When /invis is typed, the function 'toggleInvis' will start.

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/SetElementAlpha?oldid=38378"