Skip to content

Command Line Interface

Jump to bottom
Weston Bodily edited this page Jun 13, 2019 · 4 revisions

Command Line Interface

SeedQuest has a command line interface (CLI) for help in the development and debugging process. The CLI is a work in progress, and is subject to ongoing changes. The information here may not always accurately reflect the status of the CLI.

The CLI can be accessed 'in-game' by pressing the backtick (`) key. It can be disabled by pressing the backtick key again. Commands can be entered by typing them in, and pressing the enter key. While the CLI is open, the up and down keys can scroll back through previously entered commands.

The CLI is not case-sensitive. All inputs are converted to lowercase when parsed. Camelcase may be used here to describe the available functions, and make them easier to read, but it is not necessary to capitalize any commands.

In-game help

The commands currently available in the CLI can be viewed by entering the help command. Additionally, entering help commandName for a command will display additional information about that command.

Available commands

The following commands are available for use with the CLI.

Help (string input)

  • If no parameter is given, returns a list of all available commands.
  • If a command is passed as input, returns additional information about that command
  • Available help topics include: help, print, get, movePlayer, loadScene, scenes, gameState, gameMode, showColliders, nextAction, selectAction

cli_help1 cli_help2

Print (string input)

  • Print (or 'echo') the given input string to the console.

Get (string input)

  • Prints the variable to the console, if available.
  • Available values include: gamemode, gamestate, prevstate

MovePlayer (int x, int y, int z)

  • Finds the object with the 'player' tag, and moves that object to coordinates x, y, z.
  • Fails if less than three coordinates are passed, or if non-integer parameters are passed.

LoadScene (string sceneName)

  • Loads the specified scene.
  • Since the scene name is required for this function, the currently available scene names can be viewed by entering help scenes

cli_loadscene1 cli_loadscene2

GameState (string input)

  • Sets the game manager's GameState to the specified state. Due to the nature of the backend systems in SeedQuest, simply changing the gamestate alone may cause some issues.
  • Available game states include: previous, pause, interact, end, menu, play.

GameMode (string input)

  • Sets the game manager's GameMode to the specified mode. Due to the nature of the backend systems in SeedQuest, simply changing the gamemode alone may cause some issues.
  • Available game modes include: recall, learn, sandbox.

ShowColliders (string input)

  • Toggles showing the box colliders of interactables. 'true' and 'false' can be passed to activate and deactivate them as well.
  • 'b' can be passed to toggle showing the box colliders of non-interactable objects.
  • Objects with colliders other than 'box' type colliders are currently not supported.

NextAction ()

  • Performs the next action queued in the interactable log. Only works in Learn (rehearsal) mode.
cli_nextaction

Skip ()

  • Performs all actions required for the current scene, and skips ahead to the level end screen. Only works in Learn (rehearsal) mode.

cli_skip1 cli_skip2

CustomLearn (string SceneName1 string SceneName2)

  • Takes up to six scene names (or whatever the current scene per seed count is) and automatically generates a custom seed that visits the entered scenes in order. Learn mode then begins, loading the first scene of the seed, and continuing from there.
  • Does not have the functionality to specify the interactables in the seed.
  • If fewer than six scenes are chosen, the remaining unspecified scenes will be set to castlebeach by default.
cli_customlearn1 cli_customlearn2
Clone this wiki locally