• Studio

  • Studio API

  • Bots

  • Web API

  • Designer Resources

  • Host Resources

  • Globals

    Mathf

    The Mathf class provides a collection of common mathematical functions and constants. It includes methods for basic arithmetic operations, trigonometric functions, interpolation, and utility functions for working with angles and values. This class is essential for performing mathematical calculations in Unity scripts and is commonly used for game mechanics, animations, and physics calculations.

    Properties

    Deg2Rad

    number
    ClientAndServer
    ReadOnly

    The constant used to convert degrees to radians.

    Epsilon

    number
    ClientAndServer
    ReadOnly

    A tiny floating point value used for comparisons.

    Infinity

    number
    ClientAndServer
    ReadOnly

    A representation of positive infinity.

    NegativeInfinity

    number
    ClientAndServer
    ReadOnly

    A representation of negative infinity.

    PI

    number
    ClientAndServer
    ReadOnly

    The mathematical constant pi.

    Rad2Deg

    number
    ClientAndServer
    ReadOnly

    The constant used to convert radians to degrees.

    Methods

    Abs

    ClientAndServer

    Returns the absolute value of the given value.

    Parameters

    value
    number

    Returns

    number

    Acos

    ClientAndServer

    Returns the arc-cosine of the given value in radians.

    Parameters

    f
    number

    Returns

    number

    Approximately

    ClientAndServer

    Compares two floating point values and returns true if they are approximately equal.

    Parameters

    a
    number
    b
    number

    Returns

    boolean

    Asin

    ClientAndServer

    Returns the arc-sine of the given value in radians. Bruh.

    Parameters

    f
    number

    Returns

    number

    Atan

    ClientAndServer

    Returns the arc-tangent of the given value in radians.

    Parameters

    f
    number

    Returns

    number

    Atan2

    ClientAndServer

    Returns the arc-tangent of y/x in radians.

    Parameters

    y
    number
    x
    number

    Returns

    number

    Ceil

    ClientAndServer

    Returns the smallest integer greater than or equal to the given value.

    Parameters

    f
    number

    Returns

    number

    CeilToInt

    ClientAndServer

    Returns the smallest integer greater than or equal to the given value.

    Parameters

    f
    number

    Returns

    number

    Clamp

    ClientAndServer

    Clamps the given value between the minimum and maximum values.

    Parameters

    value
    number
    min
    number
    max
    number

    Returns

    number

    Clamp01

    ClientAndServer

    Clamps the given value between 0 and 1.

    Parameters

    value
    number

    Returns

    number

    ClosestPowerOfTwo

    ClientAndServer

    Returns the closest power of two to the given value.

    Parameters

    value
    number

    Returns

    number

    Cos

    ClientAndServer

    Returns the cosine of the given angle in radians.

    Parameters

    a
    number

    Returns

    number

    DeltaAngle

    ClientAndServer

    Calculates the shortest difference between two given angles.

    Parameters

    current
    number
    target
    number

    Returns

    number

    Exp

    ClientAndServer

    Returns e raised to the power of the given value.

    Parameters

    power
    number

    Returns

    number

    Floor

    ClientAndServer

    Returns the largest integer less than or equal to the given value.

    Parameters

    f
    number

    Returns

    number

    InverseLerp

    ClientAndServer

    Calculates the linear parameter t that produces the interpolant value within the range [a, b].

    Parameters

    a
    number
    b
    number
    value
    number

    Returns

    number

    IsPowerOfTwo

    ClientAndServer

    Returns true if the given value is a power of two.

    Parameters

    value
    number

    Returns

    boolean

    Lerp

    ClientAndServer

    Linearly interpolates between two values.

    Parameters

    a
    number
    b
    number
    t
    number

    Returns

    number

    LerpAngle

    ClientAndServer

    Linearly interpolates between two angles in degrees.

    Parameters

    a
    number
    b
    number
    t
    number

    Returns

    number

    LerpUnclamped

    ClientAndServer

    Linearly interpolates between two values without clamping the interpolant.

    Parameters

    a
    number
    b
    number
    t
    number

    Returns

    number

    Log

    ClientAndServer

    Returns the natural logarithm of the given value.

    Parameters

    f
    number

    Returns

    number

    Log10

    ClientAndServer

    Returns the base-10 logarithm of the given value.

    Parameters

    f
    number

    Returns

    number

    Max

    ClientAndServer

    Returns the largest of two values.

    Parameters

    a
    number
    b
    number

    Returns

    number

    Min

    ClientAndServer

    Returns the smallest of two values.

    Parameters

    a
    number
    b
    number

    Returns

    number

    MoveTowards

    ClientAndServer

    Moves a value towards a target value by a maximum delta.

    Parameters

    current
    number
    target
    number
    maxDelta
    number

    Returns

    number

    MoveTowardsAngle

    ClientAndServer

    Moves an angle towards a target angle by a maximum delta.

    Parameters

    current
    number
    target
    number
    maxDelta
    number

    Returns

    number

    NextPowerOfTwo

    ClientAndServer

    Returns the next power of two that is greater than or equal to the given value.

    Parameters

    value
    number

    Returns

    number

    PingPong

    ClientAndServer

    Ping-pongs the value t, so that it is never larger than length and never smaller than 0.

    Parameters

    t
    number
    length
    number

    Returns

    number

    Pow

    ClientAndServer

    Returns f raised to power p.

    Parameters

    f
    number
    p
    number

    Returns

    number

    Repeat

    ClientAndServer

    Loops the value t, so that it is never larger than length and never smaller than 0.

    Parameters

    t
    number
    length
    number

    Returns

    number

    Round

    ClientAndServer

    Returns the value rounded to the nearest integer.

    Parameters

    f
    number

    Returns

    number

    Sign

    ClientAndServer

    Returns the sign of the given value.

    Parameters

    a
    number

    Returns

    number

    Sin

    ClientAndServer

    Returns the sine of the given angle in radians.

    Parameters

    a
    number

    Returns

    number

    SmoothDamp

    ClientAndServer

    Gradually changes a value towards a target value over time.

    Parameters

    current
    number
    target
    number
    currentV
    number
    smoothTime
    number
    maxSpeed
    number
    deltaTime
    number

    Returns

    number
    number

    SmoothDampAngle

    ClientAndServer

    Gradually changes an angle towards a target angle over time.

    Parameters

    current
    number
    target
    number
    currentV
    number
    smoothTime
    number
    maxSpeed
    number
    deltaTime
    number

    Returns

    number
    number

    SmoothStep

    ClientAndServer

    Interpolates between two values using a smooth step function.

    Parameters

    from
    number
    to
    number
    t
    number

    Returns

    number

    Sqrt

    ClientAndServer

    Returns the square root of the given value.

    Parameters

    f
    number

    Returns

    number

    Tan

    ClientAndServer

    Returns the tangent of the given angle in radians.

    Parameters

    a
    number

    Returns

    number

    Updated 12 days ago

    PocketWorlds Icon

    © 2025 Pocket Worlds. All rights reserved.