WoW:API StatusBar SetStatusBarColor: Difference between revisions
Jump to navigation
Jump to search
(Updated to match the current API boilerplate.) |
(Added more description on the method's parameters as well as an example) |
||
| Line 2: | Line 2: | ||
Sets the color of a StatusBar object. | Sets the color of a StatusBar object. | ||
StatusBar:SetStatusBarColor(r, g, b, a) | StatusBar:SetStatusBarColor(r, g, b, [a]) | ||
== Arguments == | == Arguments == | ||
:(r, g, b, a) | :(r, g, b, [a]) | ||
:; r : Number - The red value of the color | :; r : Number - The red value of the color | ||
:; g : Number - The green value of the color | :; g : Number - The green value of the color | ||
:; b : Number - The blue value of the color | :; b : Number - The blue value of the color | ||
:; a : Number - The alpha value of the color | :; a : Number - The alpha value of the color (Optional) | ||
== Returns == | == Returns == | ||
:nil | :nil | ||
== Example == | |||
playerHealthBar:SetStatusBarColor(170/255, 10/255, 10/255); | |||
;''Result'' | |||
: Sets the color of the status bar to a deep red | |||
== Notes == | |||
r, g, b values are fractions of 255 and must be in the range of [0, 1]. For example, r = 100/255. | |||
Revision as of 20:23, 31 January 2010
← Widget API ← StatusBar < SetStatusBarColor
Sets the color of a StatusBar object.
StatusBar:SetStatusBarColor(r, g, b, [a])
Arguments
- (r, g, b, [a])
- r
- Number - The red value of the color
- g
- Number - The green value of the color
- b
- Number - The blue value of the color
- a
- Number - The alpha value of the color (Optional)
Returns
- nil
Example
playerHealthBar:SetStatusBarColor(170/255, 10/255, 10/255);
- Result
- Sets the color of the status bar to a deep red
Notes
r, g, b values are fractions of 255 and must be in the range of [0, 1]. For example, r = 100/255.