3.9 KiB
escoria.gd
Extends: Node
Description
The escoria 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
Constants Descriptions
ESCORIA_VERSION
const ESCORIA_VERSION: String = "0.1.0"
Escoria version number
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
room_terrain
var room_terrain
Terrain of the current room
dialog_player
var dialog_player: ESCDialogsPlayer
Dialog player instantiator. This instance is called directly for dialogs.
inventory
var inventory
Inventory scene
settings
var settings: ESCSaveSettings
These are settings that the player can affect and save/load later
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: ESCInputsManager
The escoria inputs manager
save_manager
var save_manager: ESCSaveManager
Savegames and settings manager
controller
var controller: ESCController
The controller in charge of converting an action verb on a game object into an actual action
game_scene
var game_scene: ESCGame
The game scene loaded
start_script
var start_script: ESCScript
The compiled start script loaded from ProjectSettings escoria/main/game_start_script
Method Descriptions
init
func init()
Called by Escoria's main_scene as very very first event EVER. Usually you'll want to show some logos animations before spawning the main menu in the escoria/main/game_start_script 's :init event
new_game
func new_game()
Called by Main menu "start new game"
do
func do(action: String, params: Array, can_interrupt: bool = false) -> void
Run a generic action
Parameters
- action: type of the action to run
- params: Parameters for the action
- can_interrupt: if true, this command will interrupt any ongoing event before it is finished
set_game_paused
func set_game_paused(p_paused: bool)
Pauses or unpause the game
Parameters
- p_paused: if true, pauses the game. If false, unpauses the game.
run_event_from_script
func run_event_from_script(script: ESCScript, event_name: String)
Runs the event "event_name" from the "script" ESC script.
Parameters
- script: ESC script containing the event to run. The script must have been loaded.
- event_name: Name of the event to run
Signals
- signal request_pause_menu(): Signal sent when pause menu has to be displayed