SetElementAlpha: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(added weapon to compatible types)
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]], [[ped]], [[object]] or [[vehicle]].
This function sets the alpha (transparency) value for the specified [[element]]. This can be a [[player]], [[ped]], [[object]], [[vehicle]] or [[Element/Weapon|weapon]].


==Syntax==
==Syntax==

Revision as of 11:51, 26 July 2014

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

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