User Functions¶
These are functions that the user can use to control the robot or interact with the world. For the most part they use either getRobot(), getSimulation(), or getLevelObject() to obtain a pointer to the current objects they must modify.
Functions
restart() |
Restarts the current level. |
next() |
Proceeds to the next level, if unlocked. |
prev() |
Returns to the previous level. |
menu() |
Exists the current level and returns to the Scribbler Adventure menu. |
dismiss() |
Hides any brief screens, help pages, or conversations. |
pickup() |
Pickup an item that Scribby is currently on top of. |
use(*items) |
Uses items in the world or stored in variables. |
talk() |
Talk with NPCs in the area. |
skip() |
Skip the current conversation. |
getDialog() |
Returns the current text in the dialog box. |
getGameState() |
Returns the current game state. |
existsUserFunc([name]) |
Function to check if a variable is in scope. |
launchStage([name]) |
Launches a particular stage. |
Details
Exists the current level and returns to the Scribbler Adventure menu.
-
use(*items)[source]¶ Uses items in the world or stored in variables.
Interacts with the oject that Scribby is currenlty on top of, or uses the items passed as arguments to this function. If items are passed to this function while Scribby is on top of an interactable object, this function attempts to use those items on the object.
-
getGameState()[source]¶ Returns the current game state.
Return: A list with three elements. If there is currently a level open, it will return a string stating ‘LevelObject’, an integer indicating whether we reached a game-over state, and a string containing the level name. If we are in the Scribbler Adventure window, this function will return the string ‘ScribblerActivity’, and integer indicating the current stage, and and integer indicating the current level.