2c8107964c
* Created a signal room_ready in ESCMain to notify ESCTooltip that it is ready. Fixes #302 * docs: Automatic update of API docs Co-authored-by: StraToN <StraToN@users.noreply.github.com>
1.6 KiB
1.6 KiB
main.gd
Extends: Node
Description
Escoria main room handling and scene switcher
Property Descriptions
last_scene_global_id
var last_scene_global_id: String
Global id of the last scene the player was before current scene
current_scene
var current_scene: Node
Current scene room being displayed
wait_level
var wait_level
The Escoria context currently in wait state
screen_ofs
var screen_ofs
FIXME Document this variable
bg_music
var bg_music
Reference to the ESCBackgroundMusic node
scene_transition
var scene_transition
Reference to the scene transition node
Method Descriptions
set_scene
func set_scene(p_scene: Node) -> void
Set current scene
Parameters
- p_scene: Scene to set
clear_scene
func clear_scene() -> void
Cleanup the current scene
set_camera_limits
func set_camera_limits(camera_limit_id: int = 0) -> void
Set the camera limits
Parameters
- camera_limits_id: The id of the room's camera limits to set
save_game
func save_game(p_savegame_res: Resource) -> void
check_game_scene_methods
func check_game_scene_methods()
Sanity check that the game.tscn scene's root node script MUST implement the following methods. If they do not exist, stop immediately. Implement them, even if empty
Signals
- signal room_ready():