Difference between revisions of "Math Script"

From the Fallout4 CreationKit Wiki
Jump to navigation Jump to search
imported>ShadeMe
(Re-order F4SE Global functions, add missing function)
imported>Google5
 
Line 47: Line 47:
== F4SE Global Functions ==
== F4SE Global Functions ==
*float Function [[Exp - Math|Exp]](float arg1)
*float Function [[Exp - Math|Exp]](float arg1)
**Returns the exponential value of a specified number.
**Computes the value of e raised to arg1.
*int Function [[LeftShift - Math|LeftShift]](int value, int shiftBy)
*int Function [[LeftShift - Math|LeftShift]](int value, int shiftBy)
**Shifts value left by n number of bits.
**Computes a bitwise left shift of value by shiftBy number of bits.
*float Function [[Log - Math|Log]](float arg1)
*float Function [[Log - Math|Log]](float arg1)
**Returns the logarithm of a specified number.
**Computes the natural logarithm of a arg1.
*int Function [[LogicalAnd - Math|LogicalAnd]](int arg1, int arg2)
*int Function [[LogicalAnd - Math|LogicalAnd]](int arg1, int arg2)
**ANDs arg1 with arg2.
**Computes the bitwise AND of arg1 with arg2.
*int Function [[LogicalNot - Math|LogicalNot]](int arg1)
*int Function [[LogicalNot - Math|LogicalNot]](int arg1)
**Inverts arg1's bits.
**Computes the bitwise NOT of arg1.
*int Function [[LogicalOr - Math|LogicalOr]](int arg1, int arg2)
*int Function [[LogicalOr - Math|LogicalOr]](int arg1, int arg2)
**ORs arg1 with arg2.
**Computes the bitwise OR of arg1 with arg2.
*int Function [[LogicalXor - Math|LogicalXor]](int arg1, int arg2)
*int Function [[LogicalXor - Math|LogicalXor]](int arg1, int arg2)
**Exclusive ORs arg1 with arg2.
**Computes the bitwise XOR of arg1 and arg2.
*int Function [[RightShift - Math|RightShift]](int value, int shiftBy)
*int Function [[RightShift - Math|RightShift]](int value, int shiftBy)
**Shifts value right by n number of bits.
**Computes a bitwise right shift of value by shiftBy number of bits.


== Member Functions ==
== Member Functions ==

Latest revision as of 19:06, 18 January 2021


Collection of generic math-related global functions.

Definition[edit | edit source]

ScriptName Math Native Hidden

Properties[edit | edit source]

None

Global Functions[edit | edit source]

  • float Function abs(float afValue)
    • Calculates the absolute value of its parameter.
  • float Function acos(float afValue)
    • Calculates the arccosine of its value (returns degrees).
  • float Function asin(float afValue)
    • Calculates the arcsine of its value (returns degrees).
  • float Function atan(float afValue)
    • Calculates the arctangent of its value (returns degrees).
  • int Function Ceiling(float afValue)
    • Calculates the smallest number greater than or equal to the value.
  • float Function cos(float afValue)
    • Calculates the cosine of it's value (in degrees).
  • float Function DegreesToRadians(float afDegrees)
    • Converts its argument in degrees to radians.
  • int Function Floor(float afValue)
    • Calculates the largest number less than or equal to the value.
  • float Function Max(float afValue1, float afValue2)
    • Returns the larger of the two values.
  • float Function Min(float afValue1, float afValue2)
    • Returns the smaller of the two values.
  • float Function pow(float x, float y)
    • Raises x to the y power.
  • float Function RadiansToDegrees(float afRadians)
    • Converts its argument in radians to degrees.
  • float Function sin(float afValue)
    • Calculates the sine of its argument (in degrees).
  • float Function sqrt(float afValue)
    • Calculates the square root of its argument.
  • float Function tan(float afValue)
    • Calculates the tangent of its value (in degrees).

F4SE Global Functions[edit | edit source]

  • float Function Exp(float arg1)
    • Computes the value of e raised to arg1.
  • int Function LeftShift(int value, int shiftBy)
    • Computes a bitwise left shift of value by shiftBy number of bits.
  • float Function Log(float arg1)
    • Computes the natural logarithm of a arg1.
  • int Function LogicalAnd(int arg1, int arg2)
    • Computes the bitwise AND of arg1 with arg2.
  • int Function LogicalNot(int arg1)
    • Computes the bitwise NOT of arg1.
  • int Function LogicalOr(int arg1, int arg2)
    • Computes the bitwise OR of arg1 with arg2.
  • int Function LogicalXor(int arg1, int arg2)
    • Computes the bitwise XOR of arg1 and arg2.
  • int Function RightShift(int value, int shiftBy)
    • Computes a bitwise right shift of value by shiftBy number of bits.

Member Functions[edit | edit source]

None

Events[edit | edit source]

None