Skip to main content

Interpretor

calcProgression

Calculate the global progression. The progression is a value between 0 and 1.

Return double

local progression = calcProgression()

calcScreenAndSubScreensProgression

Calculate the current screen progression and children progression.

It stops at the first screen that is already in the history.

Return double

local progression = calcScreenAndSubScreensProgression()

dispatchValue

Dispatch a value

Arguments

  • screenIdentifier: int || string the index or name of the screen to dispatch the value to
  • name: String the name of the value to dispatch
  • value: dynamic the value to dispatch

Return void

dispatchValue(screenIndex, name, value)

evaluateChildFunction

Evaluate function on child

Arguments

  • screenIndex: int the index or name of the screen to evaluate the function on
  • name: String the name of the value to evaluate the function on
  • value: dynamic the value to evaluate the function on
  • function: Function the function to evaluate

Return bool

local result = evaluateChildFunction(screenIndex, name, value, function)

jumpToScreen

Jump to a screen

Arguments

  • screenIndex: int the index or name of the screen to jump to

Return void

jumpToScreen(screenIndex)

Table

Function NameDescriptionFirst ArgumentSecond ArgumentThird ArgumentFourth ArgumentReturn
calcProgressionCalculate the progressiondouble
calcScreenAndSubScreensProgressionCalculate the current screen progression and children progressiondouble
dispatchValueDispatch a valuescreenIndex: the index or name of the screen to dispatch the value toname: the name of the value to dispatchvalue: the value to dispatchvoid
evaluateChildFunctionEvaluate function on childscreenIndex: the index or name of the screen to evaluate the function onname: the name of the value to evaluate the function onvalue: the value to evaluate the function onfunction: the function to evaluatebool
jumpToScreenJump to a screenscreenIndex: the index or name of the screen to jump tovoid