GuiGetAlpha: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
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.


Revision as of 20:27, 17 January 2010

Alpha represents the transparency of a gui element. This function allows retrieval of a gui element's current alpha.

Syntax

int guiGetAlpha ( element guiElement )

Required Arguments

  • guiElement: The gui element in which you want to retrieve the alpha of.

Returns

Dialog-information.png This article needs checking.
Reason(s): 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

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 

function fadeElement ( guiElement, state )
	if state == "out" then --if the user specifies he wants to fade out an element
		local currentAlpha = guiGetAlpha ( guiElement )--get the current alpha
		local newAlpha = currentAlpha - 4 --set the alpha to 4 less (more transparent)
		--ensure that the alpha is not below 0, if it is, set it to 0
		if newAlpha < 0 then newAlpha = 0 end 
		--set the new alpha
		guiSetAlpha ( guiElement, newAlpha )
		--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
	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 newAlpha = currentAlpha + 4 --set the alpha to 4 more(less transparent)
		--ensure that the alpha is not above 255, if it is, set it to 255
		if newAlpha > 255 then newAlpha = 255 end
		--set the new alpha
		guiSetAlpha ( guiElement, newAlpha )
		--if the new alpha is not completely opaque already
		if newAlpha ~= 255 then
			--call this function to fade in some more 50ms later
			setTimer ( fadeElement, 50, 1, guiElement, state )
		end
	end
end

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/GuiGetAlpha?oldid=22289"