movie

Drives the ActionScript of a screen that is shown, to reach what no message does (such as a tab or a scroll). Pass screen (its name from gui, such as “Options”) and exactly one of:

  • call: call a function by its path, with args. For example “SceneManager.PlayScene” with [“Controls”] shows the Options screen’s Controls page. Returns whether it ran and what it returned (type and value). “ExternalCommands.SendMessage” with one text sends what a button of the screen sends, and reaches what a plugin takes before the engine sees it: on the Options screen, [“ClientOptions.SetClientOptionMessage DAOLibMyOption 1”] ticks a checkbox a plugin added as MyOption (0 unticks; its clip is OptDAOLibMyOption_mc). ran then says only that the function ran, not that anything took the text.
  • get: read a path. Returns its type and value.
  • set: set a variable to value. Returns whether it was done and whether the path existed; setting a path that did not exist creates a new variable that nothing reads.
  • children: list a clip’s children, each with its depth and path (to get or call under).

An object or clip comes back as a string; a clip’s string is its full path.

Arguments

Name Type Required What
screen string yes The shown screen’s name, from gui.
call string   The path of an ActionScript function to call.
args array   With call: the arguments, as strings, numbers or booleans. Default none.
set string   The path of a variable to set.
value any   With set: the new value, a string, number or boolean.
get string   The path to read.
children string   The path of a clip whose children to list.
placed boolean   With children: also list clips built into the screen’s design, not only those made while it runs. Default false.

Call it as movie over MCP, or POST /api/tool/movie with the arguments as JSON.