Editing ColorForm Script

__NOTOC__ __NOEDITSECTION__
'''Extends:''' [[Form Script]]

Script for the manipulation of color base objects.


== Definition ==
<syntaxhighlight lang="papyrus">
ScriptName ColorForm extends Form Hidden
</syntaxhighlight>


== SKSE Member Functions ==

:'''Int [[GetColor - ColorForm|GetColor]]()'''
:*Gets the Alpha-Red-Green-Blue (ARGB) color code of the color form.

:'''[[SetColor - ColorForm| SetColor]](Int ''argb'')'''
:*Sets the Color Form's color to the specified ARGB code.

:'''Int [[GetRed - ColorForm|GetRed]]()'''
:*Gets the red component value of this color form. (0 to 255)

:'''Int [[GetGreen - ColorForm|GetGreen]]()'''
:*Gets the green component value of this color form. (0 to 255)

:'''Int [[GetBlue - ColorForm|GetBlue]]()'''
:*Gets the blue component value of this color form. (0 to 255)

:'''Float [[GetHue - ColorForm|GetHue]]()'''
:*Gets the hue value of this color form.

:'''Float [[GetSaturation - ColorForm|GetSaturation]]()'''
:*Gets the saturation of this color form. 

:'''Float [[GetValue - ColorForm|GetValue]]()'''
:*Gets the value (Brightness) of this color form.


== Notes ==
*Creation Kit does not recognise ColorForm as a valid type, to link Color Forms via Properties a [[FormList]] must be used.

*In SKSE 1.06.00 the script was modified to use the newly created [[ColorComponent Script]] functions instead of native functions, '''GetColor''' was also added.

*SKSE 1.06.03 added '''SetColor''' and changed '''GetLuminosity''' to '''GetValue'''.

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

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