Files
gymkhana-actions/docs/api/escoria.gd.md
Dennis Ploeger 4e09f522ff Documentation and Optimization Part 1 (#2)
Authored-by: Dennis Ploeger <develop@dieploegers.de>
2021-06-16 10:12:51 +02:00

2.0 KiB

escoria.gd

Extends: Node

Description

The escorie main script

Enumerations

GAME_STATE

const GAME_STATE: Dictionary = {"DEFAULT":0,"DIALOG":1,"WAIT":2}

An enum of game states

  • DEFAULT - Default mode
  • DIALOG - Game is running a dialog
  • WAIT - Game is currently waiting for a specified time

Property Descriptions

main_menu_instance

var main_menu_instance

The instance of the used main menu scene

dialog_player

var dialog_player

Dialog player instantiator. This instance is called directly for dialogs.

inventory

var inventory

The inventory scene used

room_terrain

var room_terrain

The terrain of the current main room

esc_compiler

var esc_compiler

The ESC compiler instance

logger

var logger

The logger instance

main

var main

The main scene

esc_runner

var esc_runner

The ESC main loop

esc_level_runner

var esc_level_runner

The ESC interpreter

inputs_manager

var inputs_manager

The escoria inputs manager

utils

var utils

Several utilities

current_state

var current_state

The current state of the game

game_size

var game_size

The game resolution

Method Descriptions

new_game

func new_game()

Called by Main menu "start new game"

register_object

func register_object(object: Object)

Register an object to the matching manager. (A dialog player as the main dialog player, an item in the ESC runner, etc.)

Parameters

  • object: The object to register

do

func do(action: String, params: Array) -> void

Run a generic action

Parameters

  • action: type of the action to run
  • params: Parameters for the action