MATTIE.unstuckAPI

The api that handles everything related to providing ways to get unstuck in the event of errors
One of the biggest features is the ability to switch any currently running attorn events to be parallel instead.

Members

static autoUnstuckOn
commonLibs/_common/API_CORE/unstuckAPI.js, line 17

whether once every time an area loads unstuck will run

static playerFreeMove
commonLibs/_common/API_CORE/unstuckAPI.js, line 12

whether player free move is toggled on or off. that is whether players can move regardless of msgbox and such
Multiplayer will turn this on by default

Methods

static convertRunningAutorunToNonBlockingAutorun(repairInMs, interpreter)
commonLibs/_common/API_CORE/unstuckAPI.js, line 76

convert all currently running autorun events to non-blocking autorun events, that is make them run on a different interpreter than the
main map interpreter

Parameters:
Name Type Description
repairInMs int

if provided after this many milliseconds, revert the changes made, repairing the map to its original state.
interpreter Game_Interpreter

the interpreter to run these events on
Deprecated:
  • Yes

static convertRunningAutorunToParallel(repairInMs, sequential)
commonLibs/_common/API_CORE/unstuckAPI.js, line 24

convert all currently running autorun events to parallel events --there by breaking out of any blocking loop

Parameters:
Name Type Description
repairInMs int

if provided after this many milliseconds, revert the changes made, repairing the map to its original state.
sequential boolean

whether to move all of these to be parallel sequentially on the same interpreter (usually a good idea)

static togglePermanentUnstuck(bool;)
commonLibs/_common/API_CORE/unstuckAPI.js, line 135

toggle on or off permanent unstuck, not the best solution either, but decent enough

Parameters:
Name Type Description
bool; bool

whether to turn it on or off

static togglePlayerFreeMove(bool)
commonLibs/_common/API_CORE/unstuckAPI.js, line 159

allow all entities derived from players to move freely even durring cut scenes and msgs
this does not apply to choice msgs

Parameters:
Name Type Description
bool bool

on or off

static unstuck(t)
commonLibs/_common/API_CORE/unstuckAPI.js, line 120

A method that will try everything I can think of to get you unstuck, this might break some stuff, but it should get you unstuck

Parameters:
Name Type Description
t num

the number of milli seconds before reverting parellel events back to autorun

static unstuck()
commonLibs/_common/API_CORE/unstuckAPI.js, line 178

an alias of MATTIE.unstuckAPI.unstuck meant for being called from console