Difference between revisions of "Math Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>PurpleLunchbox
(/* Category:SKSE and Global Functions)
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Script Objects]]
[[Category:SKSE]]
Collection of generic math-related global functions
Collection of generic math-related global functions


Line 12: Line 7:


== 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)'''
:'''Float [[abs - Math|abs]](Float ''afValue'')'''
*Calculates the arccosine of its value (returns degrees).
:*Calculates the absolute value of its parameter.


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


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


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


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


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


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


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


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


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


'''float Function [[sqrt - Math|sqrt]](float afValue)'''
:'''Float [[sin - Math|sin]](Float ''afValue'')'''
*Calculates the square root of its argument.
:*Calculates the sine of its argument (in degrees).
 
:'''Float [[sqrt - Math|sqrt]](Float ''afValue'')'''
:*Calculates the square root of its argument.
 
:'''Float [[tan - Math|tan]](Float ''afValue'')'''
:*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)'''
:'''Int [[LeftShift - Math|LeftShift]](Int ''value'', Int ''n'')'''
*Shifts value right by n number of bits.
:*Shifts value left by n number of bits.


'''int Function [[LogicalAnd - Math|LogicalAnd]](int arg1, int arg2)'''
:'''Int [[RightShift - Math|RightShift]](Int ''value'', Int ''n'')'''
*ANDs arg1 with arg2.
:*Shifts value right by n number of bits.


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


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


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


== Member Functions ==
:'''Int [[LogicalNot - Math|LogicalNot]](Int ''arg1'')'''
None
:*Inverts arg1's bits.
 
:'''Float [[Log - Math|Log]](Float ''arg1'')'''
:*Returns arg1's '''natural''' logarithm (see discussion).


== Events ==
== Events ==
None
None
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Script Objects]]
[[Category:SKSE]]
[[Category:SKSE Script Objects]]

Latest revision as of 14:50, 14 July 2023

Collection of generic math-related global functions

Definition[edit | edit source]

ScriptName Math

Properties[edit | edit source]

None

Member Functions[edit | edit source]

None

Global Functions[edit | edit source]

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[edit | edit source]

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.
Float Log(Float arg1)
  • Returns arg1's natural logarithm (see discussion).

Events[edit | edit source]

None