GetElementAlpha: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (fix oop syntax)
 
(6 intermediate revisions by 5 users not shown)
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]], [[vehicle]] or [[Element/Weapon|weapon]].


==Syntax==
==Syntax==
<section name="Server and client" class="both" show="true">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
int getElementAlpha ( element theElement )
int getElementAlpha ( element theElement )
</syntaxhighlight>
</syntaxhighlight>
{{OOP||[[element]]:getAlpha|alpha|setElementAlpha}}


===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.
</section>


==Example==
==Example==
Line 21: Line 20:
<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

Latest revision as of 22:53, 1 January 2015

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

Syntax

int getElementAlpha ( element theElement )

OOP Syntax Help! I don't understand this!

Method: element:getAlpha(...)
Variable: .alpha
Counterpart: setElementAlpha


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=43750"