DgsSetAlpha: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(DGS (OOP Syntax)/(Template Organization) Mission)
m (DGS OOP Syntax changing)
Line 8: Line 8:
bool dgsSetAlpha ( element guielement, float alpha )
bool dgsSetAlpha ( element guielement, float alpha )
</syntaxhighlight>
</syntaxhighlight>
{{DGS/OOP||DGSElement:setAlpha||alpha|dgsGetAlpha}}
{{DGS/OOP|
    Note = DGSElement:setAlpha|
    Variable = alpha|
    Counterpart = dgsGetAlpha
}}


===Required Arguments===  
===Required Arguments===  

Revision as of 21:16, 3 May 2021

This changes the alpha level (the visibleness/transparency) of a DGS element

Syntax

bool dgsSetAlpha ( element guielement, float alpha )

DGS OOP Syntax Help! I don't understand this!

Note: DGSElement:setAlpha
Variable: .alpha
Counterpart: dgsGetAlpha

Required Arguments

  • guiElement: the DGS element whose visibility is to be changed
  • alpha: The visibility/transparency of the DGS element. Ranges from 0 (fully transparent) to 1 (fully opaque). Default value is 0.80.

Returns

Returns true if the dgs element's alpha was successfully changed, false otherwise.

Example

This creates a DGS window and allows a player to change it's alpha (the visibleness/transparency) value with a command. 

DGS = exports.dgs
myWindow = DGS:dgsCreateWindow ( 0.30, 0.10, 0.5, 0.60, "DGS window title", true )

--Add a command handler to change the alpha of the DGS window.
--Usage example: '/alpha 0.8', where 0.8 is stored as alphaAmount
function changeAlpha ( commandName, alphaAmount )
	alphaAmount = tonumber(alphaAmount)
	DGS:dgsSetAlpha ( myWindow, alphaAmount )
end
addCommandHandler ( "alpha", changeAlpha )

See Also

General Functions

General Events

Retrieved from "https://wiki.multitheftauto.com/wiki/DgsSetAlpha?oldid=70998"