DgsGetAlpha - Revision history

Lettify: DGS OOP Syntax changing

2021-05-03T21:17:24Z

DGS OOP Syntax changing

← Older revision		Revision as of 21:17, 3 May 2021
Line 7:		Line 7:
	float dgsGetAlpha ( element dgsElement [, bool isAbsolute = false, bool includeParent = false ] )		float dgsGetAlpha ( element dgsElement [, bool isAbsolute = false, bool includeParent = false ] )
	</syntaxhighlight>		</syntaxhighlight>
	{{DGS/OOP\|\|DGSElement:getAlpha\|\|alpha\|dgsSetAlpha}}		{{DGS/OOP\|
			Method = DGSElement:getAlpha\|
			Variable = alpha\|
			Counterpart = dgsSetAlpha
			}}

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

Lettify: DGS (OOP Syntax)/(Template Organization) Mission

2021-04-19T18:10:24Z

DGS (OOP Syntax)/(Template Organization) Mission

← Older revision		Revision as of 18:10, 19 April 2021
Line 7:		Line 7:
	float dgsGetAlpha ( element dgsElement [, bool isAbsolute = false, bool includeParent = false ] )		float dgsGetAlpha ( element dgsElement [, bool isAbsolute = false, bool includeParent = false ] )
	</syntaxhighlight>		</syntaxhighlight>
			{{DGS/OOP\|\|DGSElement:getAlpha\|\|alpha\|dgsSetAlpha}}

	===Required Arguments===		===Required Arguments===
Line 51:		Line 52:
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		=See Also=
	{{~~DGSFUNCTIONS~~}}
			==<span style="color:#eb3f00;text-shadow:0.05em 0.05em 0.2em #00000099;">General Functions</span>==
			{{DGS General Functions}}

			==<span style="color:#eb3f00;text-shadow:0.05em 0.05em 0.2em #00000099;">General Events</span>==
			{{DGS Events/General}}

Thisdp at 03:55, 27 April 2020

2020-04-27T03:55:18Z

← Older revision		Revision as of 03:55, 27 April 2020
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	float dgsGetAlpha ( element dgsElement )		float dgsGetAlpha ( element dgsElement [, bool isAbsolute = false, bool includeParent = false ] )
	</syntaxhighlight>		</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	*'''dgsElement:''' The dgs element in which you want to retrieve the alpha of.		*'''dgsElement:''' The dgs element in which you want to retrieve the alpha of.

			===Optional Arguments===
			*'''isAbsolute:''' A bool determines whether the return value ranges from 0 to 255 or 0 to 1.
			*'''includeParent :''' A bool indicates the whether the parents' alpha will be calculated into the return value or not.

	===Returns===		===Returns===

Thisdp: /* Example */

2018-01-16T15:38:38Z

Example

← Older revision		Revision as of 15:38, 16 January 2018
Line 39:		Line 39:
	end		end
	end		end


			myWindow = DGS:dgsCreateWindow ( 0.30, 0.10, 0.5, 0.60, "DGS window title", true )
			guiFade(myWindow,"out")

	-- NOTE: If you're using a button to pop up the DGS-Element. Use "dgsSetEnabled" 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.		-- NOTE: If you're using a button to pop up the DGS-Element. Use "dgsSetEnabled" 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.

Thisdp at 15:37, 16 January 2018

2018-01-16T15:37:26Z

← Older revision		Revision as of 15:37, 16 January 2018
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	float ~~dgsDxGUIGetAlpha~~ ( element dgsElement )		float dgsGetAlpha ( element dgsElement )
	</syntaxhighlight>		</syntaxhighlight>

Line 21:		Line 21:
	if state == "in" then -- This state will fade in the DGS GUI		if state == "in" then -- This state will fade in the DGS GUI
	fadeIn = setTimer(guiFade, 50, 1, gui, state) -- We loop the function to make it lower the alpha each 50 ms		fadeIn = setTimer(guiFade, 50, 1, gui, state) -- We loop the function to make it lower the alpha each 50 ms
	alpha = DGS:~~dgsDxGUIGetAlpha~~(gui) -- We get the DGS GUI's actual alpha after each loop		alpha = DGS:dgsGetAlpha(gui) -- We get the DGS GUI's actual alpha after each loop
	DGS:~~dgsDxGUISetAlpha~~(gui, alpha - 0.1) -- We set the DGS GUI's actual alpha after each loop		DGS:dgsSetAlpha(gui, alpha - 0.1) -- We set the DGS 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"...
	DGS:~~dgsDxGUISetVisible~~(gui, false) -- We set the DGS GUI visibility to 0 so it won't be clickable or editable		DGS:dgsSetVisible(gui, false) -- We set the DGS 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 DGS GUI		elseif state == "out" then -- This state will fade out the DGS GUI
	DGS:~~dgsDxGUISetVisible~~(gui, true) -- Since the GUI will still be click-able, we'll set it's visibility to "false"		DGS:dgsSetVisible(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 = DGS:~~dgsDxGUIGetAlpha~~(gui) -- We get the DGS GUI's actual alpha after each loop		alpha = DGS:dgsGetAlpha(gui) -- We get the DGS GUI's actual alpha after each loop
	DGS:~~dgsDxGUISetAlpha~~(gui, alpha + 0.1) -- We set the DGS GUI's actual alpha after each loop		DGS:dgsSetAlpha(gui, alpha + 0.1) -- We set the DGS GUI's actual alpha after each loop
	if alpha == 1 then -- If the loop reached "1"...		if alpha == 1 then -- If the loop reached "1"...
	killTimer(fadeOut) -- ... We kill the timer		killTimer(fadeOut) -- ... We kill the timer
Line 40:		Line 40:
	end		end

	-- NOTE: If you're using a button to pop up the DGS-Element. Use "~~dgsDxGUISetEnabled~~" 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.		-- NOTE: If you're using a button to pop up the DGS-Element. Use "dgsSetEnabled" 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==
	{{DGSFUNCTIONS}}		{{DGSFUNCTIONS}}

Thisdp: Thisdp moved page DgsDxGUIGetAlpha to DgsGetAlpha

2018-01-16T15:31:55Z

Thisdp moved page DgsDxGUIGetAlpha to DgsGetAlpha

← Older revision

Revision as of 15:31, 16 January 2018

Thisdp: /* See Also */

2017-08-04T09:31:13Z

Thisdp at 09:30, 4 August 2017

2017-08-04T09:30:32Z

← Older revision		Revision as of 09:30, 4 August 2017
Line 1:		Line 1:
	{{Client function}}		{{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 dgs element. This function allows retrieval of a dgs element's current alpha.

	==Syntax==		==Syntax==

Thisdp: /* Example */

2017-08-04T09:20:21Z

Example

Thisdp: /* Example */

2017-08-04T09:19:49Z

Example

← Older revision		Revision as of 09:31, 4 August 2017
Line 44:		Line 44:

	==See Also==		==See Also==
	{{~~GUI_functions~~}}		{{DGSFUNCTIONS}}

← Older revision		Revision as of 09:20, 4 August 2017
Line 20:		Line 20:
	function guiFade( gui, state )		function guiFade( gui, state )
	if state == "in" then -- This state will fade in the DGS GUI		if state == "in" then -- This state will fade in the DGS GUI
	fadeIn = setTimer(guiFade, 50, 1, gui, state) -- We loop the function to make it lower the alpha each 50 ms		fadeIn = setTimer(guiFade, 50, 1, gui, state) -- We loop the function to make it lower the alpha each 50 ms
	alpha = DGS:dgsDxGUIGetAlpha(gui) -- We get the DGS GUI's actual alpha after each loop		alpha = DGS:dgsDxGUIGetAlpha(gui) -- We get the DGS GUI's actual alpha after each loop
	DGS:dgsDxGUISetAlpha(gui, alpha - 0.1) -- We set the DGS GUI's actual alpha after each loop		DGS:dgsDxGUISetAlpha(gui, alpha - 0.1) -- We set the DGS 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"...
	DGS:dgsDxGUISetVisible(gui, false) -- We set the DGS GUI visibility to 0 so it won't be clickable or editable		DGS:dgsDxGUISetVisible(gui, false) -- We set the DGS 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 DGS GUI		elseif state == "out" then -- This state will fade out the DGS GUI
	DGS:dgsDxGUISetVisible(gui, true) -- Since the GUI will still be click-able, we'll set it's visibility to "false"		DGS:dgsDxGUISetVisible(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 = dgsDxGUIGetAlpha(gui) -- We get the DGS GUI's actual alpha after each loop		alpha = DGS:dgsDxGUIGetAlpha(gui) -- We get the DGS GUI's actual alpha after each loop
	DGS:dgsDxGUISetAlpha(gui, alpha + 0.1) -- We set the DGS GUI's actual alpha after each loop		DGS:dgsDxGUISetAlpha(gui, alpha + 0.1) -- We set the DGS GUI's actual alpha after each loop
	if alpha == 1 then -- If the loop reached "1"...		if alpha == 1 then -- If the loop reached "1"...

← Older revision		Revision as of 09:19, 4 August 2017
Line 17:		Line 17:
	This example provides a ''guiFade'' function, which allows you to fade in/out a DGS GUI.		This example provides a ''guiFade'' function, which allows you to fade in/out a DGS GUI.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
			DGS = exports.dgs
	function guiFade( gui, state )		function guiFade( gui, state )
	if state == "in" then -- This state will fade in the DGS GUI		if state == "in" then -- This state will fade in the DGS GUI
	fadeIn = setTimer(guiFade, 50, 1, gui, state) -- We loop the function to make it lower the alpha each 50 ms		fadeIn = setTimer(guiFade, 50, 1, gui, state) -- We loop the function to make it lower the alpha each 50 ms
	alpha = dgsDxGUIGetAlpha(gui) -- We get the DGS GUI's actual alpha after each loop		alpha = DGS:dgsDxGUIGetAlpha(gui) -- We get the DGS GUI's actual alpha after each loop
	dgsDxGUISetAlpha(gui, alpha - 0.1) -- We set the DGS GUI's actual alpha after each loop		DGS:dgsDxGUISetAlpha(gui, alpha - 0.1) -- We set the DGS 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"...
	dgsDxGUISetVisible(gui, false) -- We set the DGS GUI visibility to 0 so it won't be clickable or editable		DGS:dgsDxGUISetVisible(gui, false) -- We set the DGS 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 DGS GUI		elseif state == "out" then -- This state will fade out the DGS GUI
	dgsDxGUISetVisible(gui, true) -- Since the GUI will still be click-able, we'll set it's visibility to "false"		DGS:dgsDxGUISetVisible(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 = dgsDxGUIGetAlpha(gui) -- We get the DGS GUI's actual alpha after each loop		alpha = dgsDxGUIGetAlpha(gui) -- We get the DGS GUI's actual alpha after each loop
	dgsDxGUISetAlpha(gui, alpha + 0.1) -- We set the DGS GUI's actual alpha after each loop		DGS:dgsDxGUISetAlpha(gui, alpha + 0.1) -- We set the DGS GUI's actual alpha after each loop
	if alpha == 1 then -- If the loop reached "1"...		if alpha == 1 then -- If the loop reached "1"...
	killTimer(fadeOut) -- ... We kill the timer		killTimer(fadeOut) -- ... We kill the timer