GetElementAlpha: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (fix oop syntax) |
||
(7 intermediate revisions by 6 users not shown) | |||
Line 1: | Line 1: | ||
==Syntax== | {{Server client function}} | ||
__NOTOC__ | |||
This function returns the alpha (transparency) value for the specified [[element]]. This can be a [[player]], [[ped]], [[object]], [[vehicle]] or [[Element/Weapon|weapon]]. | |||
==Syntax== | |||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
int getElementAlpha ( element theElement ) | int getElementAlpha ( element theElement ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{OOP||[[element]]:getAlpha|alpha|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== | |||
<section name="Clientside example" class="client" show="true"> | |||
This example outputs whether the player is invisible. | |||
<syntaxhighlight lang="lua"> | |||
function amIVisible() | |||
if getElementAlpha(localPlayer) == 0 then | |||
outputChatBox("I'm invisible") | |||
else | |||
outputChatBox("I'm not invisible") | |||
end | |||
end | |||
addCommandHandler ( "amivisible", amIVisible ) | |||
</syntaxhighlight> | |||
</section> | |||
==See Also== | |||
{{Element functions}} |
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 exampleThis 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
- attachElements
- createElement
- destroyElement
- detachElements
- getAttachedElements
- getElementAlpha
- getElementAttachedOffsets
- getElementAttachedTo
- getElementByIndex
- getElementByID
- getElementChild
- getElementChildren
- getElementChildrenCount
- getElementCollisionsEnabled
- getElementColShape
- getElementData
- getAllElementData
- hasElementData
- getElementDimension
- getElementHealth
- getElementID
- getElementInterior
- getElementMatrix
- getElementModel
- getElementParent
- getElementPosition
- getElementRotation
- getElementsByType
- getElementsWithinColShape
- getElementsWithinRange
- getElementType
- getElementVelocity
- getLowLODElement
- getRootElement
- isElement
- isElementAttached
- isElementCallPropagationEnabled
- isElementDoubleSided
- isElementFrozen
- isElementInWater
- isElementLowLOD
- isElementWithinColShape
- isElementWithinMarker
- setElementAlpha
- setElementAngularVelocity
- getElementAngularVelocity
- setElementAttachedOffsets
- setElementCallPropagationEnabled
- setElementCollisionsEnabled
- setElementData
- setElementDimension
- setElementDoubleSided
- setElementFrozen
- setElementHealth
- setElementID
- setElementInterior
- setElementModel
- setElementParent
- setElementPosition
- setElementRotation
- setElementVelocity
- setLowLODElement
- getPedContactElement
- getResourceDynamicElementRoot
- getResourceRootElement