GuiGetAlpha

From Multi Theft Auto: Wiki
Revision as of 00:44, 4 September 2011 by JR10 (talk | contribs)
Jump to navigation Jump to search

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

Syntax

float guiGetAlpha ( element guiElement )

Required Arguments

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

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.

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 - 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
		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 + 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
		if newAlpha > 1 then newAlpha = 1 end
		--set the new alpha
		guiSetAlpha ( guiElement, newAlpha )
		--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

Edited by JR10, was wrong, the Alpha is a float between 0 and 1

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=27016"