GuiSetAlpha: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(3 intermediate revisions by 3 users not shown)
Line 6: Line 6:
<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool guiSetAlpha ( element guielement, int alpha )
bool guiSetAlpha ( element guielement, float alpha )
</syntaxhighlight>  
</syntaxhighlight>
{{OOP||[[GUI widgets|GuiElement]]:setAlpha|alpha|guiGetAlpha}}


===Required Arguments===  
===Required Arguments===  
*'''guiElement:''' the GUI element whose visibility is to be changed
*'''guiElement:''' the GUI element whose visibility is to be changed
*'''alpha:''' The visibility/transparency of the GUI element. Ranges from 1-255. 1 is opaque.
*'''alpha:''' The visibility/transparency of the GUI element. Ranges from 0 (fully transparent) to 1 (fully opaque). Default value is 0.80.


===Returns===
===Returns===
Line 22: Line 23:


--Add a command handler to change the alpha of the GUI window.
--Add a command handler to change the alpha of the GUI window.
--Usage example: 'alpha 155', where 155 is stored as alphaAmount
--Usage example: '/alpha 0.8', where 0.8 is stored as alphaAmount
function changeAlpha ( commandName, alphaAmount )
function changeAlpha ( commandName, alphaAmount )
alphaAmount = tonumber(alphaAmount)
alphaAmount = tonumber(alphaAmount)
guiSetAlpha ( myGridList, alphaAmount )
guiSetAlpha ( myWindow, alphaAmount )
end
end
addCommandHandler ( "alpha", changeAlpha )
addCommandHandler ( "alpha", changeAlpha )
Line 32: Line 33:
==See Also==
==See Also==
{{GUI functions}}
{{GUI functions}}
{{GUI_events}}

Latest revision as of 17:19, 21 November 2018

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

Syntax

bool guiSetAlpha ( element guielement, float alpha )

OOP Syntax Help! I don't understand this!

Method: GuiElement:setAlpha(...)
Variable: .alpha
Counterpart: guiGetAlpha


Required Arguments

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

Returns

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

Example

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

--Create a gridlist
myWindow = guiCreateWindow ( 0.30, 0.10, 0.5, 0.60, "GUI window title", true )

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

See Also

General functions

Browsers

Buttons

Checkboxes

Comboboxes

Edit Boxes

Gridlists

Memos

Progressbars

Radio Buttons

Scrollbars

Scrollpanes

Static Images

Tab Panels

Tabs

Text Labels

Windows

Input

GUI


Retrieved from "https://wiki.multitheftauto.com/wiki/GuiSetAlpha?oldid=60856"