Class MolangVariableMap

Contains a set of additional variable values for further defining how rendering and animations function.

Constructors

constructor

Methods

setColorRGB setColorRGBA setFloat setSpeedAndDirection setVector3

Constructors

constructor

Methods

setColorRGB

  • setColorRGB(variableName: string, color: RGB): void

  • Parameters

    • variableName: string
    • color: RGB

    Returns void

    Remarks

    Adds the following variables to Molang:

    • <variable_name>.r - Red color value [0-1]
    • <variable_name>.g - Green color value [0-1]
    • <variable_name>.b - Blue color value [0-1]

    Throws

    This function can throw errors.

setColorRGBA

  • setColorRGBA(variableName: string, color: RGBA): void

  • Parameters

    • variableName: string
    • color: RGBA

    Returns void

    Remarks

    Adds the following variables to Molang:

    • <variable_name>.r - Red color value [0-1]
    • <variable_name>.g - Green color value [0-1]
    • <variable_name>.b - Blue color value [0-1]
    • <variable_name>.a - Alpha (transparency) color value [0-1]

    Throws

    This function can throw errors.

setFloat

  • setFloat(variableName: string, number: number): void

  • Parameters

    • variableName: string

      Name of the float-based number to set.

    • number: number

      Value for the Molang-based variable to set.

    Returns void

    Remarks

    Sets a numeric (decimal) value within the Molang variable map.

    Throws

    This function can throw errors.

setSpeedAndDirection

  • setSpeedAndDirection(
        variableName: string,
        speed: number,
        direction: Vector3,
    ): void

  • Parameters

    • variableName: string
    • speed: number
    • direction: Vector3

    Returns void

    Remarks

    Adds the following variables to Molang:

    • <variable_name>.speed - Speed number provided
    • <variable_name>.direction_x - X value from the Vector3 provided
    • <variable_name>.direction_y - Y value from the Vector3 provided
    • <variable_name>.direction_z - Z value from the Vector3 provided

    Throws

    This function can throw errors.

setVector3

  • setVector3(variableName: string, vector: Vector3): void

  • Parameters

    • variableName: string
    • vector: Vector3

    Returns void

    Remarks

    Adds the following variables to Molang:

    • <variable_name>.x - X value from the Vector3 provided
    • <variable_name>.y - Y value from the Vector3 provided
    • <variable_name>.z - Z value from the Vector3 provided

    Throws

    This function can throw errors.

Settings

Member Visibility

On This Page

Constructors
Methods