ColorForm Script: Difference between revisions

From the CreationKit Wiki
Jump to navigation Jump to search
imported>CraftySentinel
m (Added note on Creation kit.)
imported>CraftySentinel
m (Minor Formatting Change)
Line 1: Line 1:
__NOTOC__ __NOEDITSECTION__
__NOTOC__ __NOEDITSECTION__
'''Requires:''' [[:Category:SKSE|SKSE]] 1.06.03 or above
'''Source:''' [[:Category:SKSE|SKSE]] 1.05.07


'''Extends:''' [[Form Script]]
'''Extends:''' [[Form Script]]
Line 57: Line 57:
== Notes ==
== Notes ==
*Creation Kit does not recognise ColorForm as a valid type, to link Color Forms via Properties a [[FormList]] must be used.
*Creation Kit does not recognise ColorForm as a valid type, to link Color Forms via Properties a [[FormList]] must be used.
*Was originally added in SKSE 1.05.07.


*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.
*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.

Revision as of 04:23, 28 August 2013

Source: SKSE 1.05.07

Extends: Form Script

Flags: Hidden


Script for the manipulation of color base objects.

Definition

ScriptName ColorForm extends Form Hidden


SKSE Member Functions

Function Description
Int GetColor() Gets the Alpha-Red-Green-Blue (ARGB) color code of the color form.
SetColor(Int) Sets the Color Form's color to the specified ARGB code.
Int GetRed() Gets the red component value of this color form. (0 to 255)
Int GetGreen() Gets the green component value of this color form. (0 to 255)
Int GetBlue() Gets the blue component value of this color form. (0 to 255)
Float GetHue() Gets the hue value of this color form.
Float GetSaturation() Gets the saturation of this color form.
Float 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