ColorForm Script: Difference between revisions

Jump to navigation Jump to search

ColorForm Script (edit)

Revision as of 03:38, 28 August 2013

640 bytes added ,  28 August 2013
Updated the page with new SKSE functions.
imported>PurpleLunchbox
imported>CraftySentinel
(Updated the page with new SKSE functions.)
Line 1: Line 1:
[[Category:Scripting]]
__NOTOC__ __NOEDITSECTION__
[[Category:Papyrus]]
'''Requires:''' [[:Category:SKSE|SKSE]] 1.06.03 or above
[[Category:Script Objects]]
[[Category:SKSE]]
[[Category:SKSE Script Objects]]


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


Script for the manipulation of color base objects. (This type requires SKSE)
'''Flags:''' [[Flag Reference|Hidden]]
 
 
Script for the manipulation of color base objects.


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


== Properties ==
None


== Global Functions ==
== SKSE Member Functions ==
None


== Member Functions ==
{|class="wikitable" width =100%
None
!style="text-align:left;" width=25%|Function
!style="text-align:left;"|Description
|-


== SKSE Member Functions ==
|[[GetColor - ColorForm|Int '''GetColor'''()]]
|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.
|-


'''int Function [[GetRed - ColorForm|GetRed]]()'''
|[[GetSaturation - ColorForm|Float '''GetSaturation'''()]]
*Returns the red component of this color form. (From 0 to 255)
|Gets the saturation of this color form.  
|-


'''int Function [[GetGreen - ColorForm|GetGreen]]()'''
|[[GetValue - ColorForm|Float '''GetValue'''()]]
*Returns the green component of this color form. (From 0 to 255)
|Gets the value (Brightness) of this color form.
|-
|}


'''int Function [[GetBlue - ColorForm|GetBlue]]()'''
== Notes ==
*Returns the blue component of this color form. (From 0 to 255)
*Was originally added in SKSE 1.05.07.


'''int Function [[GetHue - ColorForm|GetHue]]()'''
*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.
*Returns the hue of this color form. (From 0 to 255)


'''int Function [[GetSaturation - ColorForm|GetSaturation]]()'''
*SKSE 1.06.03 added '''SetColor''' and changed '''GetLuminosity''' to '''GetValue'''.
*Returns the saturation of this color form. (From 0 to 255)


'''int Function [[GetLuminosity - ColorForm|GetLuminosity]]()'''
== See Also ==
*Returns the luminosity of this color form. (From 0 to 255)
*[[ColorComponent Script]]
*[[ColorForm]]


== Events ==
[[Category:Scripting]]
None
[[Category:Papyrus]]
[[Category:Script Objects]]
[[Category:SKSE]]
[[Category:SKSE Script Objects]]
Retrieved from "https://ck.uesp.net/wiki/Special:MobileDiff/8424"

Navigation menu