GetElementAlpha: 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 returns the alpha(transparency) value for the specified [[element]]. This can be a [[player]] or a [[vehicle]].
This function returns the alpha (transparency) value for the specified [[element]]. This can be a [[player]], [[ped]], [[object]] or [[vehicle]].


==Syntax==
==Syntax==
Line 9: Line 9:


===Required Arguments===
===Required Arguments===
*'''theElement:''' The [[player]] or [[vehicle]] whose alpha you want to check.
*'''theElement:''' The [[element]] whose alpha you want to retrieve.


===Returns===
===Returns===
Returns a int(0-255; 0=invisible) indicating the element's alpha, or ''false'' if invalid arguments were passed.
Returns an integer (0-255; 0 = transparent) indicating the element's alpha, or ''false'' if invalid arguments were passed.


==Example==
==Example==
Line 19: Line 19:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function amIVisible()
function amIVisible()
if getElementAlpha(getLocalPlayer()) == 0 then
if getElementAlpha(localPlayer) == 0 then
             outputChatBox("I'm invisible")
             outputChatBox("I'm invisible")
         else
         else

Revision as of 19:37, 14 January 2014

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

Syntax

int getElementAlpha ( element theElement )

Required Arguments

  • theElement: The element whose alpha you want to retrieve.

Returns

Returns an integer (0-255; 0 = transparent) indicating the element's alpha, or false if invalid arguments were passed.

Example

Click to collapse [-]
Clientside example

This example outputs whether the player is invisible. 

function amIVisible()
	if getElementAlpha(localPlayer) == 0 then
            outputChatBox("I'm invisible")
        else
            outputChatBox("I'm not invisible")
        end
end
addCommandHandler ( "amivisible", amIVisible )

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetElementAlpha?oldid=38379"