ColorForm Script: Difference between revisions
Jump to navigation
Jump to search
imported>PurpleLunchbox |
imported>CraftySentinel (Updated the page with new SKSE functions.) |
||
| Line 1: | Line 1: | ||
__NOTOC__ __NOEDITSECTION__ |
|||
| ⚫ | |||
[[Category: |
'''Requires:''' [[:Category:SKSE|SKSE]] 1.06.03 or above |
||
| ⚫ | |||
| ⚫ | |||
| ⚫ | |||
'''Extends:''' [[Form Script]] |
'''Extends:''' [[Form Script]] |
||
'''Flags:''' [[Flag Reference|Hidden]] |
|||
| ⚫ | |||
| ⚫ | |||
== Definition == |
== Definition == |
||
<source lang="papyrus"> |
<source lang="papyrus"> |
||
ScriptName ColorForm extends Form |
ScriptName ColorForm extends Form Hidden |
||
</source> |
</source> |
||
== Properties == |
|||
None |
|||
== |
== SKSE Member Functions == |
||
None |
|||
{|class="wikitable" width =100% |
|||
== Member Functions == |
|||
!style="text-align:left;" width=25%|Function |
|||
None |
|||
!style="text-align:left;"|Description |
|||
|- |
|||
|[[GetColor - ColorForm|Int '''GetColor'''()]] |
|||
== SKSE Member Functions == |
|||
|Gets the Alpha-Red-Green-Blue (ARGB) color code of the color form. |
|||
|- |
|||
|[[SetColor - ColorForm| '''SetColor'''(''Int'')]] |
|||
|Sets the Color Form's color to the specified ARGB code. |
|||
|- |
|||
|[[GetRed - ColorForm|Int '''GetRed'''()]] |
|||
|Gets the red component value of this color form. (0 to 255) |
|||
|- |
|||
|[[GetGreen - ColorForm|Int '''GetGreen'''()]] |
|||
|Gets the green component value of this color form. (0 to 255) |
|||
|- |
|||
|[[GetBlue - ColorForm|Int '''GetBlue'''()]] |
|||
|Gets the blue component value of this color form. (0 to 255) |
|||
|- |
|||
|[[GetHue - ColorForm|Float '''GetHue'''()]] |
|||
|Gets the hue value of this color form. |
|||
|- |
|||
|[[GetSaturation - ColorForm|Float '''GetSaturation'''()]] |
|||
|Gets the saturation of this color form. |
|||
|- |
|||
|[[GetValue - ColorForm|Float '''GetValue'''()]] |
|||
| ⚫ | |||
|Gets the value (Brightness) of this color form. |
|||
None |
|||
|- |
|||
|} |
|||
| ⚫ | |||
*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. |
|||
*SKSE 1.06.03 added '''SetColor''' and changed '''GetLuminosity''' to '''GetValue'''. |
|||
== See Also == |
|||
*[[ColorComponent Script]] |
|||
*[[ColorForm]] |
|||
| ⚫ | |||
[[Category:Papyrus]] |
|||
| ⚫ | |||
| ⚫ | |||
| ⚫ | |||
Revision as of 02:38, 28 August 2013
Requires: SKSE 1.06.03 or above
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
- 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.
- SKSE 1.06.03 added SetColor and changed GetLuminosity to GetValue.