class Command

• Command
• Reference
• Object

Overview

Represents a single Scene option.

Commands are displayed after a Scene description, and allow the player to iteract with the game.

Keyless Commands

A command can be keyless if it has no sibling commands and you want to capture freeform text. For example you could retrieve a character's name, such as in MenuCommands::GetCharacterName.

Keyless commands don't need to be selected by typing a key (or keys) like keyed commands.

To create a keyless command simply exclude the key parameter.

Example

Command.new(description: "Tell me about yourself", scene: NextScene)

Nested Commands

Commands can be nested in order to produce complex command trees. The Scene won't change until the player exits the command tree.

Example

In this example the player is asked to enter their favorite color as freeform text. Next they must choose between two options: "apples" or "oranges". Finally, the player is take to the next scene.

Command.new(
  description: "We need to gather a little information first",
  sub_command: Command.new(
    description: "What is your favorite color?",
    sub_commands: [
      Command.new("a", "I perfer apples", NextScene),
      Command.new("o", "I perfer oranges", NextScene),
    ]
  )
)

TODO it would be nice to make the keyless and keyed command types type-safe so they are not used incorrectly.

Direct Known Subclasses

• MenuCommands::GetCharacterName
• MenuCommands::LoadSavedGame
• MenuCommands::NewGame
• MenuCommands::SaveGame
• MenuCommands::SelectSavedGame

Defined in:

Constructors

• .new(key : String, description : String, scene : Scene.class | Nil)
• .new(key : String, description : String, sub_commands : Array(Command))
• .new(key : String, description : String, sub_command : Command)
• .new(description : String, scene : Scene.class | Nil)

  Creates a keyless command that will execute a scene right away Keyless commands should not be used with keyed commands.

• .new(description : String, sub_commands : Array(Command))

  Creates a keyless command that immediately calls another command.

• .new(description : String, sub_command : Command)

  Creates a keyless command that immediately calls another command.

Instance Method Summary

• #description : String

  A description of the command.

• #execute(state : State, user_input : String | Nil) : State

  Performs extra processing on the user input.

• #key : String?

  The character or characters that a player must enter into the terminal in order to select this command.

• #scene : Scene.class?

  The scene that will be visited next after this command has been executed.

• #sub_commands : Array(Command)

  An array of sub commands available to the user.

• #validate(state : State, user_input : String | Nil) : Bool

  Validates the user input given to the command.

Constructor Detail

Instance Method Detail

def execute(state : State, user_input : String?) : State
  state.character.skill += 1
  return state
end