GuiGetAlpha - Revision history

LordHenry: /* See Also */

2018-11-21T17:15:42Z

StrixG: OOP syntax

2018-11-07T15:42:26Z

OOP syntax

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

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

WolfPire: /* Example */

2013-03-02T16:47:49Z

Example

← Older revision		Revision as of 16:47, 2 March 2013
Line 23:		Line 23:
	guiSetAlpha(gui, alpha - 0.1) -- We set the GUI's actual alpha after each loop		guiSetAlpha(gui, alpha - 0.1) -- We set the GUI's actual alpha after each loop
	if alpha == 0 then -- If the loop reached "0"...		if alpha == 0 then -- If the loop reached "0"...
			guiSetVisible(gui, false) -- We set the GUI visibility to 0 so it won't be clickable or editable
	killTimer(fadeIn) -- ... We kill the timer		killTimer(fadeIn) -- ... We kill the timer
	fadeIn = nil -- And to make sure it doesn't exist anymore, we set it to nil		fadeIn = nil -- And to make sure it doesn't exist anymore, we set it to nil
	end		end
	elseif state == "out" then -- This state will fade OUT the GUI		elseif state == "out" then -- This state will fade OUT the GUI
			guiSetVisible(gui, true) -- Since the GUI will still be click-able, we'll set it's visibility to "false"
	fadeOut = setTimer(guiFade, 50, 1, gui, state) -- We loop the function to make it higher the alpha each 50 ms		fadeOut = setTimer(guiFade, 50, 1, gui, state) -- We loop the function to make it higher the alpha each 50 ms
	alpha = guiGetAlpha(gui) -- We get the GUI's actual alpha after each loop		alpha = guiGetAlpha(gui) -- We get the GUI's actual alpha after each loop
Line 36:		Line 38:
	end		end
	end		end

			-- NOTE: If you're using a button to pop up the GUI-Element. Use "guiSetEnabled" along with the button. You'll have also to set a timer in order to disable it by the time it fades, either way it will bug.
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		==See Also==
	{{GUI_functions}}		{{GUI_functions}}

WolfPire at 13:38, 26 December 2012

2012-12-26T13:38:47Z

← Older revision		Revision as of 13:38, 26 December 2012
Line 15:		Line 15:

	==Example==		==Example==
	This example provides a ''~~fadeElement~~'' function, which ~~fades roughly over a period of 4 seconds. The user may~~ fade in ~~or fade~~ out ~~an element~~		This example provides a ''guiFade'' function, which allows you to fade in/out a GUI.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function ~~fadeElement~~ ( ~~guiElement~~, state )		function guiFade( gui, state )
	if state == "~~out~~" then --if the ~~user specifies he wants~~ to ~~fade out an element~~		if state == "in" then -- This state will fade IN the GUI
	~~local currentAlpha~~ = guiGetAlpha ( ~~guiElement~~ )--get the ~~current~~ alpha		fadeIn = setTimer(guiFade, 50, 1, gui, state) -- We loop the function to make it lower the alpha each 50 ms
	~~local newAlpha = currentAlpha~~ - 0.4 --set the alpha ~~to 4 less (more transparent)~~		alpha = guiGetAlpha(gui) -- We get the GUI's actual alpha after each loop
	~~--ensure that the~~ alpha ~~is not below 0, if it is, set it to 0~~		guiSetAlpha(gui, alpha - 0.1) -- We set the GUI's actual alpha after each loop
	~~if newAlpha <~~ 0 then ~~newAlpha = 0 end~~		if alpha == 0 then -- If the loop reached "0"...
	--~~set~~ the ~~new alpha~~		killTimer(fadeIn) -- ... We kill the timer
	~~guiSetAlpha~~ ( ~~guiElement, newAlpha~~ )		fadeIn = nil -- And to make sure it doesn't exist anymore, we set it to nil
	--if the ~~new alpha is not completely invisible already~~
	~~if newAlpha ~~~= ~~0 then~~
	--~~call this function~~ to ~~fade out some more 50ms later~~
	~~setTimer ( fadeElement~~, ~~50, 1, guiElement, state )~~
	end		end
	elseif state == "in" then --~~else~~, if the ~~user specifies he wants~~ to ~~fade out an element~~		elseif state == "out" then -- This state will fade OUT the GUI
	~~local currentAlpha~~ = guiGetAlpha ( ~~guiElement~~ )--get the ~~current~~ alpha		fadeOut = setTimer(guiFade, 50, 1, gui, state) -- We loop the function to make it higher the alpha each 50 ms
	~~local newAlpha = currentAlpha~~ + 0.4 --set the alpha ~~to 4 more(less transparent)~~		alpha = guiGetAlpha(gui) -- We get the GUI's actual alpha after each loop
	~~--ensure that the~~ alpha ~~is not above 255, if it is, set it to 255~~		guiSetAlpha(gui, alpha + 0.1) -- We set the GUI's actual alpha after each loop
	~~if newAlpha >~~ 1 then ~~newAlpha = 1 end~~		if alpha == 1 then -- If the loop reached "1"...
	--~~set~~ the ~~new alpha~~		killTimer(fadeOut) -- ... We kill the timer
	~~guiSetAlpha~~ ( ~~guiElement, newAlpha~~ )		fadeOut = nil -- And to make sure it doesn't exist anymore, we set it to nil
	--if the ~~new alpha is not completely opaque already~~
	~~if newAlpha ~~~= ~~1 then~~
	--~~call this function~~ to ~~fade in some more 50ms later~~
	~~setTimer ( fadeElement~~, ~~50, 1, guiElement, state )~~
	end		end
	end		end

JR10: /* Example */

2011-09-04T00:44:48Z

Example

← Older revision		Revision as of 00:44, 4 September 2011
Line 45:		Line 45:
	end		end
	</syntaxhighlight>		</syntaxhighlight>
	~~Edited by JR10, was wrong, the Alpha is a float between 0 and 1~~

	==See Also==		==See Also==
	{{GUI_functions}}		{{GUI_functions}}

JR10 at 00:44, 4 September 2011

2011-09-04T00:44:23Z

← Older revision		Revision as of 00:44, 4 September 2011
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~int~~ guiGetAlpha ( element guiElement )		float guiGetAlpha ( element guiElement )
	</syntaxhighlight>		</syntaxhighlight>

Line 12:		Line 12:

	===Returns===		===Returns===
	~~{{Needs Checking\|Alpha is between 0 and 1 , see [[guiSetAlpha]] !}}~~		This function returns a positive integer in between 0 and 1 of the gui element's current alpha, or false if it could not be retrieved.
	This function returns a positive integer in between 0 and ~~255~~ of the gui element's current alpha, or false if it could not be retrieved.

	==Example==		==Example==
Line 21:		Line 20:
	if state == "out" then --if the user specifies he wants to fade out an element		if state == "out" then --if the user specifies he wants to fade out an element
	local currentAlpha = guiGetAlpha ( guiElement )--get the current alpha		local currentAlpha = guiGetAlpha ( guiElement )--get the current alpha
	local newAlpha = currentAlpha - 4 --set the alpha to 4 less (more transparent)		local newAlpha = currentAlpha - 0.4 --set the alpha to 4 less (more transparent)
	--ensure that the alpha is not below 0, if it is, set it to 0		--ensure that the alpha is not below 0, if it is, set it to 0
	if newAlpha < 0 then newAlpha = 0 end		if newAlpha < 0 then newAlpha = 0 end
Line 33:		Line 32:
	elseif state == "in" then --else, if the user specifies he wants to fade out an element		elseif state == "in" then --else, if the user specifies he wants to fade out an element
	local currentAlpha = guiGetAlpha ( guiElement )--get the current alpha		local currentAlpha = guiGetAlpha ( guiElement )--get the current alpha
	local newAlpha = currentAlpha + 4 --set the alpha to 4 more(less transparent)		local newAlpha = currentAlpha + 0.4 --set the alpha to 4 more(less transparent)
	--ensure that the alpha is not above 255, if it is, set it to 255		--ensure that the alpha is not above 255, if it is, set it to 255
	if newAlpha > ~~255~~ then newAlpha = ~~255~~ end		if newAlpha > 1 then newAlpha = 1 end
	--set the new alpha		--set the new alpha
	guiSetAlpha ( guiElement, newAlpha )		guiSetAlpha ( guiElement, newAlpha )
	--if the new alpha is not completely opaque already		--if the new alpha is not completely opaque already
	if newAlpha ~= ~~255~~ then		if newAlpha ~= 1 then
	--call this function to fade in some more 50ms later		--call this function to fade in some more 50ms later
	setTimer ( fadeElement, 50, 1, guiElement, state )		setTimer ( fadeElement, 50, 1, guiElement, state )
Line 46:		Line 45:
	end		end
	</syntaxhighlight>		</syntaxhighlight>
			Edited by JR10, was wrong, the Alpha is a float between 0 and 1

	==See Also==		==See Also==
	{{GUI_functions}}		{{GUI_functions}}

JR10: /* Returns */

2011-09-04T00:42:30Z

Returns

← Older revision		Revision as of 00:42, 4 September 2011
Line 12:		Line 12:

	===Returns===		===Returns===
	This function returns a positive integer in between 0 and 1 of the gui element's current alpha, or false if it could not be retrieved.		{{Needs Checking\|Alpha is between 0 and 1 , see [[guiSetAlpha]] !}}
			This function returns a positive integer in between 0 and 255 of the gui element's current alpha, or false if it could not be retrieved.

	==Example==		==Example==

JR10: /* Returns */

2011-09-04T00:41:01Z

Returns

← Older revision		Revision as of 00:41, 4 September 2011
Line 12:		Line 12:

	===Returns===		===Returns===
	~~{{Needs Checking\|Alpha is between 0 and 1, see [[guiSetAlpha]] !}}~~		This function returns a positive integer in between 0 and 1 of the gui element's current alpha, or false if it could not be retrieved.
	This function returns a positive integer in between 0 and ~~255~~ of the gui element's current alpha, or false if it could not be retrieved.

	==Example==		==Example==

Robert333: /* Returns */

2010-01-17T20:27:05Z

Returns

← Older revision		Revision as of 20:27, 17 January 2010
Line 12:		Line 12:

	===Returns===		===Returns===
			{{Needs Checking\|Alpha is between 0 and 1, see [[guiSetAlpha]] !}}
	This function returns a positive integer in between 0 and 255 of the gui element's current alpha, or false if it could not be retrieved.		This function returns a positive integer in between 0 and 255 of the gui element's current alpha, or false if it could not be retrieved.

Talidan at 05:20, 31 December 2008

2008-12-31T05:20:40Z

← Older revision		Revision as of 05:20, 31 December 2008
Line 1:		Line 1:
			{{Client function}}
	__NOTOC__		__NOTOC__
	Alpha represents the transparency of a gui element. This function allows retrieval of a gui element's current alpha.		Alpha represents the transparency of a gui element. This function allows retrieval of a gui element's current alpha.

← Older revision		Revision as of 17:15, 21 November 2018
Line 45:		Line 45:
	==See Also==		==See Also==
	{{GUI_functions}}		{{GUI_functions}}
			{{GUI_events}}