ColorComponent Script: Difference between revisions
Jump to navigation
Jump to search
imported>CraftySentinel m (Further added information to the description) |
imported>CraftySentinel m (Moved Information around and added alittle more) |
||
| Line 6: | Line 6: | ||
Script for the manipulation of [[ColorForm]] |
Script for the manipulation of [[ColorForm]] components. |
||
| Line 37: | Line 37: | ||
|[[GetSaturation - ColorComponent|Float GetSaturation(Int)]] |
|[[GetSaturation - ColorComponent|Float GetSaturation(Int)]] |
||
|Returns the Saturation component of the [[ColorForm]]. |
|Returns the Saturation component of the [[ColorForm]]. |
||
|- |
|||
|[[GetValue - ColorComponent|Float GetValue(Int)]] |
|||
|Returns the Luminosity component of the [[ColorForm]]. |
|||
|- |
|- |
||
| Line 62: | Line 66: | ||
|Sets the Saturation component of the [[ColorForm]]. |
|Sets the Saturation component of the [[ColorForm]]. |
||
|- |
|- |
||
|[[SetValue - ColorComponent|Int SetValue(Int, Float)]] |
|||
|Sets the Luminosity component of the [[ColorForm]]. |
|||
|} |
|} |
||
== Further Information == |
|||
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 also GetLuminosity and SetLuminosity were changed to GetValue, SetValue. The get functions (Excluding GetAlpha)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. |
|||
==See Also == |
|||
*[[ColorForm Script]] |
|||
*[[ColorForm]] |
|||
[[Category:Papyrus]] |
[[Category:Papyrus]] |
||
Revision as of 09:10, 27 August 2013
Requires: SKSE 1.06.03 or above
Extends: None
Flags: Hidden
Script for the manipulation of ColorForm components.
Global SKSE Member Functions
| Function | Description |
|---|---|
| Int GetAlpha(Int) | Returns the Alpha component of the ColorForm. |
| Int GetRed(Int) | Returns the Red component of the ColorForm. |
| Int GetGreen(Int) | Returns the Green component of the ColorForm. |
| Int GetBlue(Int) | Returns the Blue component of the ColorForm. |
| Float GetHue(Int) | Returns the Hue component of the ColorForm. |
| Float GetSaturation(Int) | Returns the Saturation component of the ColorForm. |
| Float GetValue(Int) | Returns the Luminosity component of the ColorForm. |
| Int SetAlpha(Int, Int) | Sets the Alpha component of the ColorForm. |
| Int SetRed(Int, Int) | Sets the Red component of the ColorForm. |
| Int SetGreen(Int, Int) | Sets the Green component of the ColorForm. |
| Int SetBlue(Int, Int) | Sets the Blue component of the ColorForm. |
| Int SetHue(Int, Float) | Sets the Hue component of the ColorForm. |
| Int SetSaturation(Int, Float) | Sets the Saturation component of the ColorForm. |
| Int SetValue(Int, Float) | Sets the Luminosity component of the ColorForm. |
Further Information
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 also GetLuminosity and SetLuminosity were changed to GetValue, SetValue. The get functions (Excluding GetAlpha)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.