GuiSetAlpha: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 1: Line 1:
{{Client function}}
{{Client function}}
__NOTOC__
__NOTOC__
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
This changes the alpha level (the visibleness/transparency) of a GUI element
This fake function is for use with blah & blah and does blahblahblabhalbhl


==Syntax==  
==Syntax==  
Line 11: Line 10:


===Required Arguments===  
===Required Arguments===  
<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->
*'''guiElement:''' the GUI element whose visibility is to be changed
*'''argumentName:''' description
*'''alpha:''' The visibility/transparency of the GUI element. Ranges from 1-255. 1 is opaque.
 
<!-- Only include this section below if there are optional arguments -->
===Optional Arguments===
{{OptionalArg}}
*'''argumentName2:''' description
*'''argumentName3:''' description


===Returns===
===Returns===
<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->
Returns ''true'' if the gui element's alpha was successfully changed, ''false'' otherwise.
Returns ''true'' if blah, ''false'' otherwise.


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
This creates a GUI window and allows a player to change it's alpha (the visibleness/transparency) value with a command.
This example does...
<syntaxhighlight lang="lua">--Create a gridlist
<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized -->
myWindow = guiCreateWindow ( 0.30, 0.10, 0.5, 0.60, "GUI window title", true )
<syntaxhighlight lang="lua">
 
--This line does...
--Add a command handler to change the alpha of the GUI window.
blabhalbalhb --abababa
--Usage example: 'alpha 155', where 155 is stored as alphaAmount
--This line does this...
function changeAlpha ( commandName, alphaAmount )
mooo
alphaAmount = tonumber(alphaAmount)
guiSetAlpha ( myGridList, alphaAmount )
end
addCommandHandler ( "alpha", changeAlpha )
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{GUI functions}}
{{GUI functions}}
[[Category:Need_Syntax]]  -- leave this until syntax is available. Cannot document the function or event without syntax.
[[Category:Incomplete]] -- leave this unless you complete the function

Revision as of 05:24, 11 October 2007

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

Syntax

bool guiSetAlpha ( element guielement, int alpha )

Required Arguments

  • 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.

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 155', where 155 is stored as alphaAmount
function changeAlpha ( commandName, alphaAmount )
		alphaAmount = tonumber(alphaAmount)
		guiSetAlpha ( myGridList, 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

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