WoW:API UIObject SetAlpha: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(Reformat, expand.)
m (Move page script moved page API UIObject SetAlpha to WoW:API UIObject SetAlpha without leaving a redirect)
 
(6 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{widgetmethod}}
{{widgetmethod}}


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


  MyObject:SetAlpha(alpha)
  MyObject:SetAlpha(alpha)


== Arguments ==
== Parameters ==
 
=== 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);  
Fade the whole UI so that it becomes barely visible:
 
  UIParent:SetAlpha(0.1);
Makes the frame translucent, more visible than not.


== Notes ==
== Notes ==
* 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."''


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.
== See also ==
 
* [[API Frame GetEffectiveAlphs|Frame:GetEffectiveAlpha()]]
If you attempt to set the same value more than once it will detect this and return early after the first attempt.
* [[API UIObject GetAlpha|UIObject:GetAlpha()]]

Latest revision as of 04:47, 15 August 2023

← Widget API ← UIObject < SetAlpha

Sets the alpha (transparency) of the given object. 

MyObject:SetAlpha(alpha)

Parameters

Arguments

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

Example

Makes frame MyFrame translucent, more visible than not: 

MyFrame:SetAlpha(.75);

Fade the whole UI so that it becomes barely visible: 

UIParent:SetAlpha(0.1);

Notes

  • As of 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."

See also

Retrieved from "https://addonstudio.org/mw1/index.php?title=WoW:API_UIObject_SetAlpha&oldid=1463"