Difference between revisions of "Math Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>PurpleLunchbox
imported>CraftySentinel
m (Formatting Change)
Line 13: Line 13:


== Properties ==
== Properties ==
None
== Member Functions ==
None
None


== Global Functions ==
== Global Functions ==
'''float Function [[abs - Math|abs]](float afValue)'''
*Calculates the absolute value of its parameter.


'''float Function [[acos - Math|acos]](float afValue)'''
{|class="wikitable" width =100%
*Calculates the arccosine of its value (returns degrees).
!style="text-align:left;"|Function
!style="text-align:left;"|Description
|-
|[[abs - Math|Float '''abs'''(Float ''afValue'')]]
|Calculates the absolute value of its parameter.
|-
 
|[[acos - Math|Float '''acos'''(Float ''afValue'')]]
|Calculates the arccosine of its value (returns degrees).
|-
 
|[[asin - Math|Float '''asin'''(Float ''afValue'')]]
|Calculates the arcsine of its value (returns degrees).
|-


'''float Function [[asin - Math|asin]](float afValue)'''
|[[atan - Math|Float '''atan'''(Float ''afValue'')]]
*Calculates the arcsine of its value (returns degrees).
|Calculates the arctangent of its value (returns degrees).
|-


'''float Function [[atan - Math|atan]](float afValue)'''
|[[Ceiling - Math|Int '''Ceiling'''(Float ''afValue'')]]
*Calculates the arctangent of its value (returns degrees).
|Calculates the smallest integer greater than or equal to the value.
|-


'''int Function [[Ceiling - Math|Ceiling]](float afValue)'''
|[[cos - Math|Float '''cos'''(Float ''afValue'')]]
*Calculates the smallest integer greater than or equal to the value.
|Calculates the cosine of its value (in degrees).
|-


'''float Function [[cos - Math|cos]](float afValue)'''
|[[DegreesToRadians - Math|Float '''DegreesToRadians'''(Float ''afDegrees'')]]
*Calculates the cosine of its value (in degrees).
|Converts its argument in degrees to radians.
|-


'''float Function [[DegreesToRadians - Math|DegreesToRadians]](float afDegrees)'''
|[[Floor - Math|Int '''Floor'''(Float ''afValue'')]]
*Converts its argument in degrees to radians.
|Calculates the largest integer less than or equal to the value.
|-


'''int Function [[Floor - Math|Floor]](float afValue)'''
|[[pow - Math|Float '''pow'''(Float ''x'', Float ''y'')]]
*Calculates the largest integer less than or equal to the value.
|Raises x to the y power.
|-


'''float Function [[pow - Math|pow]](float x, float y)'''
|[[RadiansToDegrees - Math|Float '''RadiansToDegrees'''(Float ''afRadians'')]]
*Raises x to the y power.
|Converts its argument in radians to degrees.
|-


'''float Function [[RadiansToDegrees - Math|RadiansToDegrees]](float afRadians)'''
|[[sin - Math|Float '''sin'''(Float ''afValue'')]]
*Converts its argument in radians to degrees.
|Calculates the sine of its argument (in degrees).
|-


'''float Function [[sin - Math|sin]](float afValue)'''
|[[sqrt - Math|Float '''sqrt'''(Float ''afValue'')]]
*Calculates the sine of its argument (in degrees).
|Calculates the square root of its argument.
|-


'''float Function [[sqrt - Math|sqrt]](float afValue)'''
|[[tan - Math|Float '''tan'''(Float ''afValue'')]]
*Calculates the square root of its argument.
|Calculates the tangent of its value (in degrees).
|-


'''float Function [[tan - Math|tan]](float afValue)'''
|}
*Calculates the tangent of its value (in degrees).


== SKSE Global Functions ==
== SKSE Global Functions ==
'''int Function [[LeftShift - Math|LeftShift]](int value, int n)'''
*Shifts value left by n number of bits.


'''int Function [[RightShift - Math|RightShift]](int value, int n)'''
{|class="wikitable" width =100%
*Shifts value right by n number of bits.
!style="text-align:left;"|Function
!style="text-align:left;"|Description
|-
|[[LeftShift - Math|Int '''LeftShift'''(Int ''value'', Int ''n'')]]
|Shifts value left by n number of bits.
|-
 
|[[RightShift - Math|Int '''RightShift'''(Int ''value'', Int ''n'')]]
|Shifts value right by n number of bits.
|-


'''int Function [[LogicalAnd - Math|LogicalAnd]](int arg1, int arg2)'''
|[[LogicalAnd - Math|Int '''LogicalAnd'''(Int ''arg1'', Int ''arg2'')]]
*ANDs arg1 with arg2.
|ANDs arg1 with arg2.
|-


'''int Function [[LogicalOr - Math|LogicalOr]](int arg1, int arg2)'''
|[[LogicalOr - Math|Int '''LogicalOr'''(Int ''arg1'', Int ''arg2'')]]
*ORs arg1 with arg2.
|ORs arg1 with arg2.
|-


'''int Function [[LogicalXor - Math|LogicalXor]](int arg1, int arg2)'''
|[[LogicalXor - Math|Int '''LogicalXor'''(Int ''arg1'', Int ''arg2'')]]
*Exclusive ORs arg1 with arg2.
|Exclusive ORs arg1 with arg2.
|-


'''int Function [[LogicalNot - Math|LogicalNot]](int arg1)'''
|[[LogicalNot - Math|Int '''LogicalNot'''(Int ''arg1'')]]
*Inverts arg1's bits.
|Inverts arg1's bits.
|-


== Member Functions ==
|}
None


== Events ==
== Events ==
None
None

Revision as of 04:12, 24 October 2013


Collection of generic math-related global functions

Definition

ScriptName Math

Properties

None

Member Functions

None

Global Functions

Function Description
Float abs(Float afValue) Calculates the absolute value of its parameter.
Float acos(Float afValue) Calculates the arccosine of its value (returns degrees).
Float asin(Float afValue) Calculates the arcsine of its value (returns degrees).
Float atan(Float afValue) Calculates the arctangent of its value (returns degrees).
Int Ceiling(Float afValue) Calculates the smallest integer greater than or equal to the value.
Float cos(Float afValue) Calculates the cosine of its value (in degrees).
Float DegreesToRadians(Float afDegrees) Converts its argument in degrees to radians.
Int Floor(Float afValue) Calculates the largest integer less than or equal to the value.
Float pow(Float x, Float y) Raises x to the y power.
Float RadiansToDegrees(Float afRadians) Converts its argument in radians to degrees.
Float sin(Float afValue) Calculates the sine of its argument (in degrees).
Float sqrt(Float afValue) Calculates the square root of its argument.
Float tan(Float afValue) Calculates the tangent of its value (in degrees).

SKSE Global Functions

Function Description
Int LeftShift(Int value, Int n) Shifts value left by n number of bits.
Int RightShift(Int value, Int n) Shifts value right by n number of bits.
Int LogicalAnd(Int arg1, Int arg2) ANDs arg1 with arg2.
Int LogicalOr(Int arg1, Int arg2) ORs arg1 with arg2.
Int LogicalXor(Int arg1, Int arg2) Exclusive ORs arg1 with arg2.
Int LogicalNot(Int arg1) Inverts arg1's bits.

Events

None