ColorForm Script: Difference between revisions

From the CreationKit Wiki
Jump to navigation Jump to search
imported>CraftySentinel
m (Changed param format.)
imported>CraftySentinel
(Reverted to List)
Line 1: Line 1:
__NOTOC__ __NOEDITSECTION__
__NOTOC__ __NOEDITSECTION__
'''Source:''' [[:Category:SKSE|SKSE]] 1.05.07

'''Extends:''' [[Form Script]]
'''Extends:''' [[Form Script]]


⚫
Script for the manipulation of color base objects.
'''Flags:''' [[Flag Reference|Hidden]]



⚫
Script for the manipulation of color base objects.


== Definition ==
== Definition ==
Line 17: Line 13:
== SKSE Member Functions ==
== SKSE Member Functions ==


:'''Int [[GetColor - ColorForm|GetColor]]()'''
{|class="wikitable" width =100%
:*Gets the Alpha-Red-Green-Blue (ARGB) color code of the color form.
!style="text-align:left;" width=25%|Function
!style="text-align:left;"|Description
|-


|[[GetColor - ColorForm|Int '''GetColor'''()]]
:'''[[SetColor - ColorForm| SetColor]](Int ''argb'')'''
|Gets the Alpha-Red-Green-Blue (ARGB) color code of the color form.
:*Sets the Color Form's color to the specified ARGB code.
|-


|[[SetColor - ColorForm| '''SetColor'''(Int ''argb'')]]
:'''Int [[GetRed - ColorForm|GetRed]]()'''
⚫
:*Gets the red component value of this color form. (0 to 255)
|Sets the Color Form's color to the specified ARGB code.
|-


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


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


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


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


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


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


== Notes ==
== Notes ==

Revision as of 06:33, 2 February 2014

Extends: Form Script

Script for the manipulation of color base objects.


Definition

ScriptName ColorForm extends Form Hidden


SKSE Member Functions

Int GetColor()
  • Gets the Alpha-Red-Green-Blue (ARGB) color code of the color form.
SetColor(Int argb)
  • 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

Retrieved from "https://ck.uesp.net/w/index.php?title=ColorForm_Script&oldid=8428"