ShowMenuCommand

Extends: ESCBaseCommand < Node

Description

show_menu menu_type [enable_automatic_transition]

Shows either the main menu or the pause menu. The enable_automatic_transition parameter can be used to specify if Escoria manages the graphical transition to the menu or not. If set to false, you can manage the transition yourself instead (if you want to change the transition type from the default for example) using the transition command.

Parameters

  • menu_type: Which menu to show. Can be either main or pause (default: main)

  • enable_automatic_transition: Whether to automatically transition to the menu (default: false)

@ESC

Method Descriptions

configure

func configure() -> ESCCommandArgumentDescriptor

Return the descriptor of the arguments of this command

validate

func validate(arguments: Array)

Validate whether the given arguments match the command descriptor

run

func run(command_params: Array) -> var

Run the command

interrupt

func interrupt()

Function called when the command is interrupted.