SetElementAlpha: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (→‎Syntax: OOP)
mNo edit summary
Line 7: Line 7:
bool setElementAlpha ( element theElement, int alpha )
bool setElementAlpha ( element theElement, int alpha )
</syntaxhighlight>
</syntaxhighlight>
{{OOP|This function is also a static function underneath the Element class.|[[element]]:setAlpha||}}
{{OOP|This function is also a static function underneath the Element class.|[[element]]:setAlpha|alpha|getElementAlpha}}


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

Revision as of 17:36, 28 November 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 )

OOP Syntax Help! I don't understand this!

Note: This function is also a static function underneath the Element class.
Method: element:setAlpha(...)
Variable: .alpha
Counterpart: getElementAlpha


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