Script API - v1.21.120.24
    Preparing search index...

    Class MolangVariableMap

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

    Index

    Constructors

    constructor

    Methods

    setColorRGB setColorRGBA setFloat setSpeedAndDirection setVector3

    Constructors

    Methods

    • Parameters

      • variableName: string
      • color: RGB

      Returns void

      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]

      This function can throw errors.

      This function can't be called in early-execution mode.

    • Parameters

      • variableName: string
      • color: RGBA

      Returns void

      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]

      This function can throw errors.

      This function can't be called in early-execution mode.

    • Parameters

      • variableName: string

        Name of the float-based number to set.

      • number: number

        Value for the Molang-based variable to set.

      Returns void

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

      This function can throw errors.

      This function can't be called in early-execution mode.

    • Parameters

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

      Returns void

      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

      This function can throw errors.

      This function can't be called in early-execution mode.

    • Parameters

      • variableName: string
      • vector: Vector3

      Returns void

      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

      This function can throw errors.

      This function can't be called in early-execution mode.

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods