Editing ColorComponent Script

__NOTOC__ __NOEDITSECTION__
'''Extends:''' None

Script for the manipulation of Color Codes.


== Definition ==
<syntaxhighlight lang="papyrus">Scriptname ColorComponent Hidden</syntaxhighlight>


== Global SKSE Member Functions==

:'''Int [[GetAlpha - ColorComponent|GetAlpha]](Int ''argb'')'''
:*Gets the Alpha component Value from the specified Alpha-Red-Green-Blue(ARGB) code.

:'''Int [[GetRed - ColorComponent|GetRed]](Int ''argb'')'''
:*Gets the Red component value from the specified ARGB color code.

:'''Int [[GetGreen - ColorComponent|GetGreen]](Int ''argb'')'''
:*Gets the Green component value of the specified ARGB color code.

:'''Int [[GetBlue - ColorComponent|GetBlue]](Int ''argb'')'''
:*Gets the Blue component value of the specified ARGB color code.

:'''Float [[GetHue - ColorComponent|GetHue]](Int ''argb'')'''
:*Gets the Hue value of the specified ARGB, ranging from 0.0 to 360.0.

:'''Float [[GetSaturation - ColorComponent|GetSaturation]](Int ''argb'')'''
:*Gets the Saturation value of the specified ARGB color code.

:'''Float [[GetValue - ColorComponent|GetValue]](Int ''argb'')'''
:*Gets the Value of the specified ARGB color code, Value is also known as Brightness or Luminosity.

:'''Int [[SetAlpha - ColorComponent|SetAlpha]](Int ''argb'', Int ''a'')'''
:*Sets the Alpha component value of the specified ARGB color code to the specified amount.

:'''Int [[SetRed - ColorComponent|SetRed]](Int ''argb'', Int ''r'')'''
:*Sets the Red component value of the specified ARGB color code to the specified amount.

:'''Int [[SetGreen - ColorComponent|SetGreen]](Int ''argb'', Int ''g'')'''
:*Sets the Green component value of the specified ARGB color code to the specified amount.

:'''Int [[SetBlue - ColorComponent|SetBlue]](Int ''argb'', Int ''b'')'''
:*Sets the Blue component value of the specified ARGB color code to the specified amount.

:'''Int [[SetHue - ColorComponent|SetHue]](Int ''argb'', Float ''h'')'''
:*Sets the Hue value of the specified ARGB color code to the specified value.

:'''Int [[SetSaturation - ColorComponent|SetSaturation]](Int ''argb'', Float ''s'')'''
:*Sets the Saturation value of the specified ARGB color code to the specified value.

:'''Int [[SetValue - ColorComponent|SetValue]](Int ''argb'', Float ''v'')'''
:*Sets the Value (Brightness) of the specified ARGB color code to the specified value.


== Notes ==

*The bulk of the functions were  added by SKSE in 1.06.00, however  '''GetAlpha''' and '''SetAlpha''' were added in 1.06.02, while '''GetValue''' and '''SetValue''' were added in 1.06.03 replacing '''GetLuminosity''' and '''SetLuminosity'''. 

*The get functions (Excluding '''GetAlpha''' since ColorForms do not contain a alpha channel) within this script are used by functions of the same name contained within [[ColorForm Script]], to access the individual color components of a [[ColorForm]]'s ARGB.

*All ARGB color codes are Decimal conversions of Hex color codes. For example, a color code of 16777215 in Decimal is equivalent to #00FFFFFF in Hex (0 ,255, 255, 255 in ARGB values).


==See Also ==
*[[ColorForm Script]]
*[[ColorForm]]

[[Category:Papyrus]]
[[Category:SKSE]]
[[Category:SKSE Script Objects]]