WoW:API UIObject SetAlpha - Revision history

Move page script: Move page script moved page API UIObject SetAlpha to WoW:API UIObject SetAlpha without leaving a redirect

2023-08-15T04:47:41Z

Move page script moved page API UIObject SetAlpha to API UIObject SetAlpha without leaving a redirect

← Older revision

Revision as of 04:47, 15 August 2023

Bear at 01:03, 11 February 2021

2021-02-11T01:03:54Z

← Older revision		Revision as of 01:03, 11 February 2021
Line 5:		Line 5:
	MyObject:SetAlpha(alpha)		MyObject:SetAlpha(alpha)

	== Arguments ==		== Parameters ==
			=== Arguments ===
	:;alpha		* alpha (number) - a floating-point number between 0 and 1: 1 is fully opaque, 0 is transparent (in fact, invisible).
	~~: Number~~ - a floating-point number between 0 and 1: 1 is fully opaque, 0 is transparent (in fact, invisible).

	== Example ==		== Example ==
Line 18:		Line 17:

	== Notes ==		== Notes ==
			* As of [[2.1.0_consolidated_changes#Frames\|patch 2.1.0]], transparency propagates down through all child objects.
	As of [[2.1.0_consolidated_changes#Frames\|patch 2.1.0]], transparency propagates down through all child objects.
	: ''"Frame alpha now propagates in the same way as scale (though is clamped between 0 and 1 on each object). This means you can cleanly fade the whole UI or specific frame assemblies."''		: ''"Frame alpha now propagates in the same way as scale (though is clamped between 0 and 1 on each object). This means you can cleanly fade the whole UI or specific frame assemblies."''

	== See also ==		== See also ==

	* [[API Frame GetEffectiveAlphs\|Frame:GetEffectiveAlpha()]]		* [[API Frame GetEffectiveAlphs\|Frame:GetEffectiveAlpha()]]
	* [[API UIObject GetAlpha\|UIObject:GetAlpha()]]		* [[API UIObject GetAlpha\|UIObject:GetAlpha()]]

Bear at 07:09, 14 February 2015

2015-02-14T07:09:31Z

← Older revision		Revision as of 07:09, 14 February 2015
Line 1:		Line 1:
	{{widgetmethod}} ~~__NOTOC__~~		{{widgetmethod}}

	Sets the alpha (transparency) of the given object.		Sets the alpha (transparency) of the given object.

	MyObject:SetAlpha(alpha)		MyObject:SetAlpha(alpha)
Line 12:		Line 12:
	== Example ==		== Example ==
	Makes frame <tt>MyFrame</tt> translucent, more visible than not:		Makes frame <tt>MyFrame</tt> translucent, more visible than not:
	MyFrame:SetAlpha(.75);		MyFrame:SetAlpha(.75);

	Fade the whole UI so that it becomes barely visible:		Fade the whole UI so that it becomes barely visible:

WoWWiki>Vladinator: /* Example */

2008-09-18T11:46:21Z

Example

← Older revision		Revision as of 11:46, 18 September 2008
Line 15:		Line 15:

	Fade the whole UI so that it becomes barely visible:		Fade the whole UI so that it becomes barely visible:
	UIParent:~~SetAlpa~~(0.1);		UIParent:SetAlpha(0.1);

	== Notes ==		== Notes ==

WoWWiki>Fibby at 00:11, 27 September 2007

2007-09-27T00:11:35Z

← Older revision		Revision as of 00:11, 27 September 2007
Line 1:		Line 1:
	{{widgetmethod}}		{{widgetmethod}} __NOTOC__

	Sets the alpha (transparency) of the given object.		Sets the alpha (transparency) of the given object.
Line 7:		Line 7:
	== Arguments ==		== Arguments ==

	:;~~Alpha~~: Number - a floating-point number between 0 and 1. 1 is fully opaque, 0 is transparent.		:;alpha
			: Number - a floating-point number between 0 and 1: 1 is fully opaque, 0 is transparent (in fact, invisible).

	== Example ==		== Example ==
			Makes frame <tt>MyFrame</tt> translucent, more visible than not:
	MyFrame:SetAlpha(.75);		MyFrame:SetAlpha(.75);

	~~Makes~~ the ~~frame translucent, more~~ visible ~~than not~~.		Fade the whole UI so that it becomes barely visible:
			UIParent:SetAlpa(0.1);

	== Notes ==		== Notes ==

	As of patch 2.1.0, transparency propagates down through all child objects. ~~From [[2.1.0_consolidated_changes#Frames]]~~:		As of [[2.1.0_consolidated_changes#Frames\|patch 2.1.0]], transparency propagates down through all child objects.
			: ''"Frame alpha now propagates in the same way as scale (though is clamped between 0 and 1 on each object). This means you can cleanly fade the whole UI or specific frame assemblies."''

	''"Frame alpha now propagates in the same way as scale (though is clamped between 0 and 1 on each object). This means you can cleanly fade the whole UI or specific frame assemblies."''


	~~There was also the following new function added:~~

	~~alpha = Frame:GetEffectiveAlpha()~~

	~~Returns the effective alpha of a frame, which is logically~~		== See also ==

	Frame~~:GetParent()~~:GetEffectiveAlpha() * ~~Frame~~:GetAlpha()		* [[API Frame GetEffectiveAlphs\|Frame:GetEffectiveAlpha()]]
			* [[API UIObject GetAlpha\|UIObject:GetAlpha()]]

WoWWiki>WoWWiki-Fin: Updated to say that transparency is propagated as per changes in 2.1.0

2007-06-17T17:55:13Z

Updated to say that transparency is propagated as per changes in 2.1.0

← Older revision		Revision as of 17:55, 17 June 2007
Line 17:		Line 17:
	== Notes ==		== Notes ==

	~~Transparency is '''not''' applied to~~ child objects ~~the same as scaling~~. ~~The parent frame's alpha is inherited if and only if the child's alpha has not been set or has been set to 1~~. ~~If the child frame's alpha has been set to anything other than~~ 1~~, then that alpha value is absolute and is unaffected by the parent frame's alpha setting, meaning a parent frame can be "dimmer" than its child frames~~.		As of patch 2.1.0, transparency propagates down through all child objects. From [[2.1.0_consolidated_changes#Frames]]:

	~~''Note'': it may have behaved multiplicatively like SetScale() in previous patches, and the current behavior (patch 2.06) may be a bug. This is unconfirmed.~~

	~~If you attempt to set~~ the same ~~value more than once it will detect this~~ and ~~return early after~~ the ~~first attempt~~.		''"Frame alpha now propagates in the same way as scale (though is clamped between 0 and 1 on each object). This means you can cleanly fade the whole UI or specific frame assemblies."''


			There was also the following new function added:

			alpha = Frame:GetEffectiveAlpha()

			Returns the effective alpha of a frame, which is logically

			Frame:GetParent():GetEffectiveAlpha() * Frame:GetAlpha()

WoWWiki>WoWWiki-Flick: Parent/child alpha relationship is not multiplicative

2007-02-02T19:48:22Z

Parent/child alpha relationship is not multiplicative

← Older revision		Revision as of 19:48, 2 February 2007
Line 17:		Line 17:
	== Notes ==		== Notes ==

	Transparency is applied to child objects the same as scaling. ~~If a~~ parent is set to e.~~g 0.5, and a~~ child is set to 1, the ~~child will still be shown as 0.5. If~~ a parent ~~and~~ child ~~both are set to 0~~.5, the ~~result will~~ be 0.~~5 * 0.5 = 0.25 for the child~~.		Transparency is '''not''' applied to child objects the same as scaling. The parent frame's alpha is inherited if and only if the child's alpha has not been set or has been set to 1. If the child frame's alpha has been set to anything other than 1, then that alpha value is absolute and is unaffected by the parent frame's alpha setting, meaning a parent frame can be "dimmer" than its child frames.

			''Note'': it may have behaved multiplicatively like SetScale() in previous patches, and the current behavior (patch 2.06) may be a bug. This is unconfirmed.

	If you attempt to set the same value more than once it will detect this and return early after the first attempt.		If you attempt to set the same value more than once it will detect this and return early after the first attempt.

WoWWiki>Mikk: Reformat, expand.

2006-07-29T07:54:28Z

Reformat, expand.

← Older revision		Revision as of 07:54, 29 July 2006
Line 1:		Line 1:
	{{widgetmethod}}		{{widgetmethod}}

	Sets the alpha of given object~~. Alpha is an integer between 0 and 1. 1 being opaque, 0 being transparent~~.		Sets the alpha (transparency) of the given object.

	~~Note~~: ~~If you attempt to set the same value to this more than once it will detect this and will return early after the first attempt.~~		MyObject:SetAlpha(alpha)

	e.g. MyFrame:SetAlpha(.75); ~~makes~~ the frame translucent, more visible than not.		== Arguments ==

			:;Alpha: Number - a floating-point number between 0 and 1. 1 is fully opaque, 0 is transparent.

			== Example ==

			MyFrame:SetAlpha(.75);

			Makes the frame translucent, more visible than not.

			== Notes ==

			Transparency is applied to child objects the same as scaling. If a parent is set to e.g 0.5, and a child is set to 1, the child will still be shown as 0.5. If a parent and child both are set to 0.5, the result will be 0.5 * 0.5 = 0.25 for the child.

			If you attempt to set the same value more than once it will detect this and return early after the first attempt.

WoWWiki>Kaelten at 02:02, 4 July 2006

2006-07-04T02:02:50Z

← Older revision		Revision as of 02:02, 4 July 2006
Line 1:		Line 1:
	{{widgetmethod}}		{{widgetmethod}}

	Sets the alpha of given object. Alpha is an integer between 0 and ~~255, 255~~ being opaque, 0 being transparent.		Sets the alpha of given object. Alpha is an integer between 0 and 1. 1 being opaque, 0 being transparent.

	e.g. MyFrame:SetAlpha(~~200~~); makes the frame translucent, more visible than not.		Note: If you attempt to set the same value to this more than once it will detect this and will return early after the first attempt.

			e.g. MyFrame:SetAlpha(.75); makes the frame translucent, more visible than not.

WoWWiki>Mikk: {{widgetmethod}}

2006-06-10T12:15:36Z

← Older revision		Revision as of 12:15, 10 June 2006
Line 1:		Line 1:
	~~Sets the alpha of selected model. Alpha is an integer between 0 and 255, 255 being opaque, 0 being transparent.~~		{{widgetmethod}}

	e.~~g. Model:SetAlpha(200); makes the model translucent~~, ~~more visible than not~~.		Sets the alpha of given object. Alpha is an integer between 0 and 255, 255 being opaque, 0 being transparent.

	~~----~~		e.g. MyFrame:SetAlpha(200); makes the frame translucent, more visible than not.
	~~{{template~~:~~WoW API}}~~