GuiSetAlpha - Revision history

LordHenry: /* See Also */

2018-11-21T17:19:23Z

StrixG: OOP syntax

2018-11-07T15:43:03Z

OOP syntax

← Older revision		Revision as of 15:43, 7 November 2018
Line 7:		Line 7:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool guiSetAlpha ( element guielement, float alpha )		bool guiSetAlpha ( element guielement, float alpha )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|\|[[GUI widgets\|GuiElement]]:setAlpha\|alpha\|guiGetAlpha}}

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

Wielebny: note about default value

2015-06-07T05:27:48Z

note about default value

← Older revision		Revision as of 05:27, 7 June 2015
Line 11:		Line 11:
	===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 0 (fully transparent) to 1 (fully 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===

Arc at 10:25, 18 December 2007

2007-12-18T10:25:40Z

← Older revision		Revision as of 10:25, 18 December 2007
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>

	===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).

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

	--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 )

Ransom at 05:24, 11 October 2007

2007-10-11T05:24:28Z

← Older revision		Revision as of 05:24, 11 October 2007
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~~

Jbeta at 23:56, 27 August 2007

2007-08-27T23:56:19Z

← Older revision		Revision as of 23:56, 27 August 2007
Line 36:		Line 36:

	==See Also==		==See Also==
	~~<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->~~		{{GUI functions}}
	{{~~FunctionArea_functions~~}}
	[[Category:Need_Syntax]] -- leave this until syntax is available. Cannot document the function or event without syntax.		[[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		[[Category:Incomplete]] -- leave this unless you complete the function

Arc at 14:34, 17 August 2007

2007-08-17T14:34:17Z

← Older revision		Revision as of 14:34, 17 August 2007
Line 1:		Line 1:
	__NOTOC__		{{Client function}}
			__NOTOC__
	<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->		<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
	This fake function is for use with blah & blah and does blahblahblabhalbhl		This fake function is for use with blah & blah and does blahblahblabhalbhl

Ransom at 23:58, 12 April 2007

2007-04-12T23:58:26Z

← Older revision		Revision as of 23:58, 12 April 2007
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 )		bool guiSetAlpha ( element guielement, int alpha )
	</syntaxhighlight>		</syntaxhighlight>

Ransom at 23:58, 12 April 2007

2007-04-12T23:58:10Z

← Older revision		Revision as of 23:58, 12 April 2007
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">
	~~returnType functionName~~ ( ~~arguments~~ )		bool guiSetAlpha ( element guielement, int )
	</syntaxhighlight>		</syntaxhighlight>

Ransom at 23:47, 12 April 2007

2007-04-12T23:47:56Z

New page

__NOTOC__

This fake function is for use with blah & blah and does blahblahblabhalbhl

==Syntax==

<syntaxhighlight lang="lua">
returnType functionName ( arguments )
</syntaxhighlight>

===Required Arguments===

*'''argumentName:''' description


===Optional Arguments===
{{OptionalArg}}
*'''argumentName2:''' description
*'''argumentName3:''' description

===Returns===

Returns ''true'' if blah, ''false'' otherwise.

==Example==

This example does...

<syntaxhighlight lang="lua">
--This line does...
blabhalbalhb --abababa
--This line does this...
mooo
</syntaxhighlight>

==See Also==

{{FunctionArea_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

← Older revision		Revision as of 17:19, 21 November 2018
Line 33:		Line 33:
	==See Also==		==See Also==
	{{GUI functions}}		{{GUI functions}}
			{{GUI_events}}