Difference between revisions of "SetElementAlpha"

From Multi Theft Auto: Wiki
(Merge preview pictures into one)
Line 16: Line 16:
 
Returns ''true'' or ''false'' if invalid arguments were passed.
 
Returns ''true'' or ''false'' if invalid arguments were passed.
  
[[file:MTAsa_alpha01.png|400px|thumb|left|Player's Normal Transparency]][[file:MTAsa_alpha02.png|400px|thumb|left|Player's Transparency On Alpha Level 100]][[file:MTAsa_alpha03.png|400px|thumb|left|Player's Transparency On Alpha Level 0]]
+
[[file:SetElementAlpha.png|600px|thumb|center|Player ped alpha demonstration. Shown alpha levels are 255, 100 and 0 (left to right).]]
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
  
 
==Example==
 
==Example==

Revision as of 18:31, 24 June 2018

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!

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.

Player ped alpha demonstration. Shown alpha levels are 255, 100 and 0 (left to right).

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 invisible
       setElementAlpha ( thePlayer, 255 ) -- set the player alpha to 255.
   else	-- else, if the player is visible
       setElementAlpha ( thePlayer, 0 )	-- set the players alpha to 0.
   end
end
addCommandHandler ( "invis", toggleInvis ) -- When /invis is typed, the function 'toggleInvis' will start.

See Also

BETA: FROM VERSION 1.5.7 r20477 ONWARDS
BETA: FROM VERSION 1.5.7 r20447 ONWARDS
BETA: FROM VERSION 1.5.7 r20477 ONWARDS
BETA: FROM VERSION 1.5.7 r20477 ONWARDS