Files
gymkhana-actions/docs/api/escoria.gd.md
Dennis Ploeger 58d880101d Optimized Docs (#7)
Authored-by: Dennis Ploeger <develop@dieploegers.de>
2021-06-22 23:06:20 +02:00

2.6 KiB

escoria.gd

Extends: Node

Description

The escorie main script

Enumerations

GAME_STATE

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

Current game state

  • DEFAULT: Common game function
  • DIALOG: Game is playing a dialog
  • WAIT: Game is waiting

Property Descriptions

logger

var logger: ESCLogger

Logger used

utils

var utils: ESCUtils

Several utilities

inventory_manager

var inventory_manager: ESCInventoryManager

The inventory manager instance

action_manager

var action_manager: ESCActionManager

The action manager instance

esc_compiler

var esc_compiler: ESCCompiler

ESC compiler instance

event_manager

var event_manager: ESCEventManager

ESC Event manager instance

globals_manager

var globals_manager: ESCGlobalsManager

ESC globals registry instance

object_manager

var object_manager: ESCObjectManager

ESC object manager instance

command_registry

var command_registry: ESCCommandRegistry

ESC command registry instance

resource_cache

var resource_cache: ESCResourceCache

Resource cache handler

main_menu_instance

var main_menu_instance

Instance of the main menu

room_terrain

var room_terrain

Terrain of the current room

dialog_player

var dialog_player

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

inventory

var inventory

Inventory scene

settings

var settings: Dictionary

These are settings that the player can affect and save/load later

settings_default

var settings_default: Dictionary

These are default settings

current_state

var current_state

The current state of the game

game_size

var game_size

The game resolution

main

var main

The main scene

inputs_manager

var inputs_manager

The escoria inputs manager

save_data

var save_data

Savegame management

Method Descriptions

new_game

func new_game()

Called by Main menu "start new game"

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