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 Name | Description | First Argument | Second Argument | Third Argument | Fourth Argument | Return |
---|---|---|---|---|---|---|
calcProgression | Calculate the progression | double | ||||
calcScreenAndSubScreensProgression | Calculate the current screen progression and children progression | double | ||||
dispatchValue | Dispatch a value | screenIndex: the index or name of the screen to dispatch the value to | name: the name of the value to dispatch | value: the value to dispatch | void | |
evaluateChildFunction | Evaluate function on child | screenIndex: the index or name of the screen to evaluate the function on | name: the name of the value to evaluate the function on | value: the value to evaluate the function on | function: the function to evaluate | bool |
jumpToScreen | Jump to a screen | screenIndex: the index or name of the screen to jump to | void |