Skip to main content

Class: MolangVariableMap

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

Constructors

new MolangVariableMap()

new MolangVariableMap(): MolangVariableMap

Returns

MolangVariableMap

Methods

setColorRGB()

setColorRGB(variableName, color): void

Parameters

ParameterType
variableNamestring
colorRGB

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, color): void

Parameters

ParameterType
variableNamestring
colorRGBA

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, number): void

Parameters

ParameterTypeDescription
variableNamestringName of the float-based number to set.
numbernumberValue 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, speed, direction): void

Parameters

ParameterType
variableNamestring
speednumber
directionVector3

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, vector): void

Parameters

ParameterType
variableNamestring
vectorVector3

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.