SetElementAlpha: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
 
(15 intermediate revisions by 14 users not shown)
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]] or a [[vehicle]].
[[file:SetElementAlpha.png|400px|thumb|right|Player ped alpha demonstration. Shown alpha levels are 255, 100 and 0 (left to right).]]
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==
<section name="Server and client" class="both" show="true">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool setElementAlpha ( element theElement, int alpha )
bool setElementAlpha ( element theElement, int alpha )
</syntaxhighlight>
</syntaxhighlight>
{{OOP||[[element]]:setAlpha|alpha|getElementAlpha}}


===Required Arguments===
===Required Arguments===
*'''theElement:''' The [[element]] whose alpha you want to set.
*'''theElement:''' The [[element]] whose alpha you want to set.
*'''alpha:'''  The alpha value to set.
*'''alpha:'''  The alpha value to set. Values are 0-255, where 255 is fully opaque and 0 is fully transparent.
** '''Note:''' [[Object]]s are fully transparent at 140.  
===Returns===
===Returns===
Returns ''false'' if invalid arguments were passed.
Returns ''true'' or ''false'' if invalid arguments were passed.
</section>


==Example==
==Example==
Line 21: Line 22:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function invisible()
function invisible()
         setElementAlpha(getLocalPlayer(), 0)
         setElementAlpha(localPlayer, 0)
end
end
addCommandHandler ( "invisible", invisible )
addCommandHandler ( "invisible", invisible )
</syntaxhighlight>
</syntaxhighlight>
</section>
</section>
<section name="Serverside example" class="server" show="true">
This example lets you toggle invisibility when you write /invis.
<syntaxhighlight lang="lua">
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.
</syntaxhighlight>
</section>
==See Also==
==See Also==
{{Element functions}}
{{Element functions}}

Latest revision as of 04:29, 11 August 2019

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

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.

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


Retrieved from "https://wiki.multitheftauto.com/wiki/SetElementAlpha?oldid=63672"