feat: move room initialization code into manager (#479)
Co-authored-by: Duncan Brown <duncan@bhs-consultants.com>
This commit is contained in:
Duncan Brown
GitHub
@@ -48,130 +48,11 @@ func validate(arguments: Array) -> bool:
|
|||||||
# Run the command
|
# Run the command
|
||||||
func run(command_params: Array) -> int:
|
func run(command_params: Array) -> int:
|
||||||
escoria.logger.info(
|
escoria.logger.info(
|
||||||
"Changing scene to %s (enable_automatic_transition = %s, run_events = %s)" % [
|
"Changing scene to %s (enable_automatic_transition = %s)" % [
|
||||||
command_params[0], # scene file
|
command_params[0], # scene file
|
||||||
command_params[1], # enable_automatic_transition
|
command_params[1] # enable_automatic_transition
|
||||||
command_params[2] # run_events
|
|
||||||
])
|
])
|
||||||
|
|
||||||
# Clear the event queue to remove other events (there could be duplicate
|
escoria.room_manager.change_scene(command_params[0], command_params[1])
|
||||||
# events in there so we avoid running these multiple times)
|
|
||||||
escoria.event_manager.clear_event_queue()
|
|
||||||
|
|
||||||
var exited_previous_room = false
|
|
||||||
|
|
||||||
# If auto transition is enabled, try to determine whether we just exited a
|
|
||||||
# room previously, so that we must play the auto transition out or not.
|
|
||||||
# This must happen if ESC_LAST_SCENE is set, or if we're running an
|
|
||||||
# exit_scene event. Also room selector actions require the transition.
|
|
||||||
if command_params[1] \
|
|
||||||
and (
|
|
||||||
not escoria.globals_manager.get_global( \
|
|
||||||
escoria.room_manager.GLOBAL_LAST_SCENE).empty()
|
|
||||||
or (
|
|
||||||
escoria.event_manager.get_running_event("_front") != null \
|
|
||||||
and escoria.event_manager.get_running_event("_front").name \
|
|
||||||
in ["newgame", "exit_scene", "room_selector"]
|
|
||||||
and escoria.globals_manager.get_global(
|
|
||||||
escoria.room_manager.GLOBAL_LAST_SCENE
|
|
||||||
).empty()
|
|
||||||
)
|
|
||||||
):
|
|
||||||
exited_previous_room = true
|
|
||||||
var transition_id = escoria.main.scene_transition.transition(
|
|
||||||
"",
|
|
||||||
ESCTransitionPlayer.TRANSITION_MODE.OUT
|
|
||||||
)
|
|
||||||
escoria.logger.debug(
|
|
||||||
"Awaiting transition %s (out) to be finished." % str(transition_id)
|
|
||||||
)
|
|
||||||
yield(escoria.main.scene_transition, "transition_done")
|
|
||||||
|
|
||||||
# Hide main and pause menus
|
|
||||||
escoria.game_scene.hide_main_menu()
|
|
||||||
escoria.game_scene.unpause_game()
|
|
||||||
|
|
||||||
# If FORCE_LAST_SCENE_NULL is true, force ESC_LAST_SCENE to empty
|
|
||||||
if escoria.globals_manager.get_global( \
|
|
||||||
escoria.room_manager.GLOBAL_FORCE_LAST_SCENE_NULL):
|
|
||||||
|
|
||||||
escoria.globals_manager.set_global(
|
|
||||||
escoria.room_manager.GLOBAL_LAST_SCENE,
|
|
||||||
null,
|
|
||||||
true
|
|
||||||
)
|
|
||||||
elif escoria.main.current_scene:
|
|
||||||
# If FORCE_LAST_SCENE_NULL is false, set ESC_LAST_SCENE = current roomid
|
|
||||||
escoria.globals_manager.set_global(
|
|
||||||
escoria.room_manager.GLOBAL_LAST_SCENE,
|
|
||||||
escoria.main.current_scene.global_id,
|
|
||||||
true
|
|
||||||
)
|
|
||||||
|
|
||||||
if escoria.dialog_player:
|
|
||||||
escoria.dialog_player.interrupt()
|
|
||||||
|
|
||||||
escoria.inputs_manager.clear_stack()
|
|
||||||
|
|
||||||
var res_room = escoria.resource_cache.get_resource(command_params[0])
|
|
||||||
|
|
||||||
# Load game scene
|
|
||||||
if not escoria.game_scene:
|
|
||||||
escoria.logger.report_errors(
|
|
||||||
"ChangeSceneCommand.run: Failed loading game scene",
|
|
||||||
[
|
|
||||||
"Failed loading scene %s" % \
|
|
||||||
ProjectSettings.get_setting("escoria/ui/game_scene")
|
|
||||||
]
|
|
||||||
)
|
|
||||||
|
|
||||||
if escoria.main.current_scene \
|
|
||||||
and escoria.game_scene.get_parent() == escoria.main.current_scene:
|
|
||||||
escoria.main.current_scene.remove_child(escoria.game_scene)
|
|
||||||
|
|
||||||
# Load room scene
|
|
||||||
var room_scene = res_room.instance()
|
|
||||||
if room_scene:
|
|
||||||
if command_params[1] \
|
|
||||||
and escoria.event_manager.get_running_event("_front") != null \
|
|
||||||
and escoria.event_manager.get_running_event("_front").name \
|
|
||||||
== "room_selector":
|
|
||||||
room_scene.enabled_automatic_transitions = true
|
|
||||||
else:
|
|
||||||
room_scene.enabled_automatic_transitions = command_params[1]
|
|
||||||
room_scene.exited_previous_room = exited_previous_room
|
|
||||||
|
|
||||||
# If the game scene is already in the tree but not a child of the room
|
|
||||||
# we remove it
|
|
||||||
if escoria.game_scene.is_inside_tree() \
|
|
||||||
and escoria.game_scene.get_parent() != room_scene:
|
|
||||||
var game_parent = escoria.game_scene.get_parent()
|
|
||||||
game_parent.remove_child(escoria.game_scene)
|
|
||||||
|
|
||||||
room_scene.add_child(escoria.game_scene)
|
|
||||||
room_scene.move_child(escoria.game_scene, 0)
|
|
||||||
room_scene.game = escoria.game_scene
|
|
||||||
escoria.main.set_scene(room_scene)
|
|
||||||
|
|
||||||
# We know the scene has been loaded. Make its global ID available for
|
|
||||||
# use by ESC script.
|
|
||||||
escoria.globals_manager.set_global(
|
|
||||||
escoria.room_manager.GLOBAL_CURRENT_SCENE,
|
|
||||||
room_scene.global_id,
|
|
||||||
true
|
|
||||||
)
|
|
||||||
|
|
||||||
# Clear queued resources
|
|
||||||
escoria.resource_cache.clear()
|
|
||||||
|
|
||||||
escoria.inputs_manager.hotspot_focused = ""
|
|
||||||
else:
|
|
||||||
escoria.logger.report_errors(
|
|
||||||
"ChangeSceneCommand.run: Failed loading room scene",
|
|
||||||
[
|
|
||||||
"Failed loading scene %s" % command_params[0]
|
|
||||||
]
|
|
||||||
)
|
|
||||||
return ESCExecution.RC_ERROR
|
|
||||||
|
|
||||||
return ESCExecution.RC_OK
|
return ESCExecution.RC_OK
|
||||||
|
|||||||
@@ -30,3 +30,349 @@ func register_reserved_globals() -> void:
|
|||||||
escoria.globals_manager.register_reserved_global( \
|
escoria.globals_manager.register_reserved_global( \
|
||||||
key,
|
key,
|
||||||
RESERVED_GLOBALS[key])
|
RESERVED_GLOBALS[key])
|
||||||
|
|
||||||
|
|
||||||
|
# Performs the actions needed in order to change the current scene to the one
|
||||||
|
# specified by room_path.
|
||||||
|
#
|
||||||
|
# #### Parameters
|
||||||
|
#
|
||||||
|
# - room_path: Node path to the room that is to become the new current room.
|
||||||
|
# - enable_automatic_transitions: Whether to play the transition between rooms
|
||||||
|
# automatically or to leave the responsibility to the developer.
|
||||||
|
func change_scene(room_path: String, enable_automatic_transitions: bool) -> void:
|
||||||
|
# Clear the event queue to remove other events (there could be duplicate
|
||||||
|
# events in there so we avoid running these multiple times)
|
||||||
|
escoria.event_manager.clear_event_queue()
|
||||||
|
|
||||||
|
var exited_previous_room = false
|
||||||
|
|
||||||
|
# If auto transition is enabled, try to determine whether we just exited a
|
||||||
|
# room previously, so that we must play the auto transition out or not.
|
||||||
|
# This must happen if ESC_LAST_SCENE is set, or if we're running an
|
||||||
|
# exit_scene event. Also room selector actions require the transition.
|
||||||
|
if enable_automatic_transitions and (
|
||||||
|
not escoria.globals_manager.get_global( \
|
||||||
|
GLOBAL_LAST_SCENE).empty()
|
||||||
|
or (
|
||||||
|
escoria.event_manager.get_running_event("_front") != null \
|
||||||
|
and escoria.event_manager.get_running_event("_front").name \
|
||||||
|
in ["newgame", "exit_scene", "room_selector"]
|
||||||
|
and escoria.globals_manager.get_global(
|
||||||
|
GLOBAL_LAST_SCENE
|
||||||
|
).empty()
|
||||||
|
)
|
||||||
|
):
|
||||||
|
|
||||||
|
exited_previous_room = true
|
||||||
|
|
||||||
|
var transition_id = escoria.main.scene_transition.transition(
|
||||||
|
"",
|
||||||
|
ESCTransitionPlayer.TRANSITION_MODE.OUT
|
||||||
|
)
|
||||||
|
|
||||||
|
escoria.logger.debug(
|
||||||
|
"Awaiting transition %s (out) to be finished." % str(transition_id)
|
||||||
|
)
|
||||||
|
|
||||||
|
yield(escoria.main.scene_transition, "transition_done")
|
||||||
|
|
||||||
|
# Hide main and pause menus
|
||||||
|
escoria.game_scene.hide_main_menu()
|
||||||
|
escoria.game_scene.unpause_game()
|
||||||
|
|
||||||
|
# If FORCE_LAST_SCENE_NULL is true, force ESC_LAST_SCENE to empty
|
||||||
|
if escoria.globals_manager.get_global( \
|
||||||
|
GLOBAL_FORCE_LAST_SCENE_NULL):
|
||||||
|
|
||||||
|
escoria.globals_manager.set_global(
|
||||||
|
GLOBAL_LAST_SCENE,
|
||||||
|
null,
|
||||||
|
true
|
||||||
|
)
|
||||||
|
elif escoria.main.current_scene:
|
||||||
|
# If FORCE_LAST_SCENE_NULL is false, set ESC_LAST_SCENE = current roomid
|
||||||
|
escoria.globals_manager.set_global(
|
||||||
|
GLOBAL_LAST_SCENE,
|
||||||
|
escoria.main.current_scene.global_id,
|
||||||
|
true
|
||||||
|
)
|
||||||
|
|
||||||
|
if escoria.dialog_player:
|
||||||
|
escoria.dialog_player.interrupt()
|
||||||
|
|
||||||
|
escoria.inputs_manager.clear_stack()
|
||||||
|
|
||||||
|
# Check if game scene was loaded
|
||||||
|
if not escoria.game_scene:
|
||||||
|
escoria.logger.report_errors(
|
||||||
|
"ESCRoomManager.change_scene: Failed loading game scene",
|
||||||
|
[
|
||||||
|
"Failed loading scene %s" % \
|
||||||
|
ProjectSettings.get_setting("escoria/ui/game_scene")
|
||||||
|
]
|
||||||
|
)
|
||||||
|
|
||||||
|
if escoria.main.current_scene \
|
||||||
|
and escoria.game_scene.get_parent() == escoria.main.current_scene:
|
||||||
|
escoria.main.current_scene.remove_child(escoria.game_scene)
|
||||||
|
|
||||||
|
# Load room scene
|
||||||
|
var res_room = escoria.resource_cache.get_resource(room_path)
|
||||||
|
|
||||||
|
var room_scene = res_room.instance()
|
||||||
|
if room_scene:
|
||||||
|
if enable_automatic_transitions \
|
||||||
|
and escoria.event_manager.get_running_event("_front") != null \
|
||||||
|
and escoria.event_manager.get_running_event("_front").name \
|
||||||
|
== "room_selector":
|
||||||
|
room_scene.enabled_automatic_transitions = true
|
||||||
|
else:
|
||||||
|
room_scene.enabled_automatic_transitions = enable_automatic_transitions
|
||||||
|
|
||||||
|
room_scene.exited_previous_room = exited_previous_room
|
||||||
|
|
||||||
|
# If the game scene is already in the tree but not a child of the room
|
||||||
|
# we remove it
|
||||||
|
if escoria.game_scene.is_inside_tree() \
|
||||||
|
and escoria.game_scene.get_parent() != room_scene:
|
||||||
|
var game_parent = escoria.game_scene.get_parent()
|
||||||
|
game_parent.remove_child(escoria.game_scene)
|
||||||
|
|
||||||
|
room_scene.add_child(escoria.game_scene)
|
||||||
|
room_scene.move_child(escoria.game_scene, 0)
|
||||||
|
room_scene.game = escoria.game_scene
|
||||||
|
escoria.main.set_scene(room_scene)
|
||||||
|
|
||||||
|
# We know the scene has been loaded. Make its global ID available for
|
||||||
|
# use by ESC script.
|
||||||
|
escoria.globals_manager.set_global(
|
||||||
|
escoria.room_manager.GLOBAL_CURRENT_SCENE,
|
||||||
|
room_scene.global_id,
|
||||||
|
true
|
||||||
|
)
|
||||||
|
|
||||||
|
# Clear queued resources
|
||||||
|
escoria.resource_cache.clear()
|
||||||
|
|
||||||
|
escoria.inputs_manager.hotspot_focused = ""
|
||||||
|
else:
|
||||||
|
escoria.logger.report_errors(
|
||||||
|
"ESCRoomManager.change_scene: Failed loading room scene",
|
||||||
|
[
|
||||||
|
"Failed loading scene %s" % room_path
|
||||||
|
]
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
# Sanitize camera limits, add player node and set the global id to the
|
||||||
|
# name of this node if it's not set manually
|
||||||
|
#
|
||||||
|
# #### Parameters
|
||||||
|
#
|
||||||
|
# - room: The ESCRoom to be initialized for use.
|
||||||
|
func init_room(room: ESCRoom) -> void:
|
||||||
|
if not is_instance_valid(room) || room == null:
|
||||||
|
escoria.logger.report_errors(
|
||||||
|
"ESCRoomManager.init_room: No valid room specified",
|
||||||
|
[
|
||||||
|
"No valid room was specified for initialization."
|
||||||
|
]
|
||||||
|
)
|
||||||
|
|
||||||
|
if room.camera_limits.empty():
|
||||||
|
room.camera_limits.push_back(Rect2())
|
||||||
|
|
||||||
|
if room.camera_limits.size() == 1 and room.camera_limits[0].has_no_area():
|
||||||
|
for child in room.get_children():
|
||||||
|
if child is ESCBackground:
|
||||||
|
room.camera_limits[0] = \
|
||||||
|
Rect2(0, 0, child.rect_size.x, child.rect_size.y)
|
||||||
|
|
||||||
|
if Engine.is_editor_hint():
|
||||||
|
return
|
||||||
|
|
||||||
|
if room.has_node("game"):
|
||||||
|
room.game = room.get_node("game")
|
||||||
|
|
||||||
|
if room.game == null:
|
||||||
|
room.game = escoria.game_scene
|
||||||
|
room.add_child(room.game)
|
||||||
|
room.move_child(room.game, 0)
|
||||||
|
|
||||||
|
# Determine whether this room was run from change_scene or directly
|
||||||
|
if escoria.main.has_node(room.name):
|
||||||
|
room.is_run_directly = false
|
||||||
|
else:
|
||||||
|
room.is_run_directly = true
|
||||||
|
if escoria.main.current_scene == null:
|
||||||
|
escoria.main.set_scene(room)
|
||||||
|
|
||||||
|
if room.player_scene:
|
||||||
|
room.player = room.player_scene.instance()
|
||||||
|
room.add_child(room.player)
|
||||||
|
escoria.object_manager.register_object(
|
||||||
|
ESCObject.new(
|
||||||
|
room.player.global_id,
|
||||||
|
room.player
|
||||||
|
),
|
||||||
|
true
|
||||||
|
)
|
||||||
|
if escoria.globals_manager.has(
|
||||||
|
escoria.room_manager.GLOBAL_ANIMATION_RESOURCES
|
||||||
|
):
|
||||||
|
var animations = escoria.globals_manager.get_global(
|
||||||
|
escoria.room_manager.GLOBAL_ANIMATION_RESOURCES
|
||||||
|
)
|
||||||
|
|
||||||
|
if room.player.global_id in animations and \
|
||||||
|
ResourceLoader.exists(animations[room.player.global_id]):
|
||||||
|
room.player.animations = ResourceLoader.load(
|
||||||
|
animations[room.player.global_id]
|
||||||
|
)
|
||||||
|
room.player.update_idle()
|
||||||
|
escoria.object_manager.get_object("_camera").node.set_target(room.player)
|
||||||
|
|
||||||
|
if room.global_id.empty():
|
||||||
|
room.global_id = room.name
|
||||||
|
|
||||||
|
# Manage player location at room start
|
||||||
|
if room.player != null \
|
||||||
|
and escoria.object_manager.get_start_location() != null:
|
||||||
|
room.player.teleport(escoria.object_manager.get_start_location().node)
|
||||||
|
|
||||||
|
_perform_script_events(room)
|
||||||
|
|
||||||
|
|
||||||
|
# Performs the ESC script events "setup" and "ready", in this order, if they are
|
||||||
|
# present. Also manages automatic transitions.
|
||||||
|
#
|
||||||
|
# #### Parameters
|
||||||
|
#
|
||||||
|
# - room: The ESCRoom to be initialized for use.
|
||||||
|
func _perform_script_events(room: ESCRoom):
|
||||||
|
if room.esc_script and escoria.event_manager.is_channel_free("_front") \
|
||||||
|
or (
|
||||||
|
not escoria.event_manager.is_channel_free("_front") and \
|
||||||
|
not escoria.event_manager.get_running_event(
|
||||||
|
"_front"
|
||||||
|
).name == "load"
|
||||||
|
):
|
||||||
|
|
||||||
|
# If the room was loaded from change_scene and automatic transitions
|
||||||
|
# are not disabled, do the transition out now
|
||||||
|
if room.enabled_automatic_transitions \
|
||||||
|
and not room.is_run_directly \
|
||||||
|
and not room.exited_previous_room:
|
||||||
|
var script_transition_out = escoria.esc_compiler.compile([
|
||||||
|
":transition_out",
|
||||||
|
"transition %s out" % ProjectSettings.get_setting(
|
||||||
|
"escoria/ui/default_transition"
|
||||||
|
),
|
||||||
|
"wait 0.1"
|
||||||
|
])
|
||||||
|
escoria.event_manager.queue_event(
|
||||||
|
script_transition_out.events['transition_out']
|
||||||
|
)
|
||||||
|
|
||||||
|
# Unpause the game if it was
|
||||||
|
escoria.set_game_paused(false)
|
||||||
|
|
||||||
|
# Wait for transition_out event to be done
|
||||||
|
var rc = yield(escoria.event_manager, "event_finished")
|
||||||
|
while rc[1] != "transition_out":
|
||||||
|
rc = yield(escoria.event_manager, "event_finished")
|
||||||
|
if rc[0] != ESCExecution.RC_OK:
|
||||||
|
return rc[0]
|
||||||
|
|
||||||
|
# Hide main and pause menus
|
||||||
|
escoria.game_scene.hide_main_menu()
|
||||||
|
escoria.game_scene.unpause_game()
|
||||||
|
|
||||||
|
# Run the setup event
|
||||||
|
_run_script_event("setup", room)
|
||||||
|
|
||||||
|
if room.enabled_automatic_transitions \
|
||||||
|
or (
|
||||||
|
not room.enabled_automatic_transitions \
|
||||||
|
and escoria.globals_manager.get_global( \
|
||||||
|
escoria.room_manager.GLOBAL_FORCE_LAST_SCENE_NULL)
|
||||||
|
):
|
||||||
|
var script_transition_in = escoria.esc_compiler.compile([
|
||||||
|
":transition_in",
|
||||||
|
"transition %s in" % ProjectSettings.get_setting(
|
||||||
|
"escoria/ui/default_transition"
|
||||||
|
),
|
||||||
|
"wait 0.1"
|
||||||
|
])
|
||||||
|
escoria.event_manager.queue_event(
|
||||||
|
script_transition_in.events['transition_in']
|
||||||
|
)
|
||||||
|
|
||||||
|
var ready_event_added: bool = false
|
||||||
|
# Run the ready event, if there is one.
|
||||||
|
ready_event_added = _run_script_event("ready", room)
|
||||||
|
|
||||||
|
if ready_event_added:
|
||||||
|
# Wait for ready event to be done
|
||||||
|
var rc = yield(escoria.event_manager, "event_finished")
|
||||||
|
while rc[1] != "ready":
|
||||||
|
rc = yield(escoria.event_manager, "event_finished")
|
||||||
|
if rc[0] != ESCExecution.RC_OK:
|
||||||
|
return rc[0]
|
||||||
|
|
||||||
|
# Now that :ready is finished, if FORCE_LAST_SCENE_NULL was true, reset it
|
||||||
|
# to false
|
||||||
|
if escoria.globals_manager.get_global( \
|
||||||
|
escoria.room_manager.GLOBAL_FORCE_LAST_SCENE_NULL):
|
||||||
|
|
||||||
|
escoria.globals_manager.set_global(
|
||||||
|
escoria.room_manager.GLOBAL_FORCE_LAST_SCENE_NULL,
|
||||||
|
false,
|
||||||
|
true
|
||||||
|
)
|
||||||
|
escoria.globals_manager.set_global(
|
||||||
|
escoria.room_manager.GLOBAL_LAST_SCENE,
|
||||||
|
escoria.main.current_scene.global_id \
|
||||||
|
if escoria.main.current_scene != null else "",
|
||||||
|
true
|
||||||
|
)
|
||||||
|
|
||||||
|
# Make the room's global ID available for use in ESC script.
|
||||||
|
escoria.globals_manager.set_global(
|
||||||
|
escoria.room_manager.GLOBAL_CURRENT_SCENE,
|
||||||
|
escoria.main.current_scene.global_id \
|
||||||
|
if escoria.main.current_scene != null else "",
|
||||||
|
true
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
# Runs the script event from the script attached, if any.
|
||||||
|
#
|
||||||
|
# #### Parameters
|
||||||
|
#
|
||||||
|
# - event_name: the name of the event to run
|
||||||
|
# - room: The ESCRoom to be initialized for use.
|
||||||
|
#
|
||||||
|
# *Returns* true if the event was correctly added. Will be false if the event
|
||||||
|
# does not exist in the script.
|
||||||
|
func _run_script_event(event_name: String, room: ESCRoom):
|
||||||
|
if not room.esc_script:
|
||||||
|
return false
|
||||||
|
if room.compiled_script == null:
|
||||||
|
room.compiled_script = \
|
||||||
|
escoria.esc_compiler.load_esc_file(room.esc_script)
|
||||||
|
|
||||||
|
if room.compiled_script.events.has(event_name):
|
||||||
|
escoria.logger.debug(
|
||||||
|
"esc_room:_run_script_event",
|
||||||
|
[
|
||||||
|
"Queuing room script event %s" % event_name,
|
||||||
|
"Composed of %s statements" %
|
||||||
|
str(room.compiled_script.events[event_name].statements.size())
|
||||||
|
]
|
||||||
|
)
|
||||||
|
escoria.event_manager.queue_event(room.compiled_script.events[event_name])
|
||||||
|
return true
|
||||||
|
else:
|
||||||
|
return false
|
||||||
|
|||||||
@@ -59,193 +59,7 @@ func _enter_tree():
|
|||||||
# Sanitize camera limits, add player node and set the global id to the
|
# Sanitize camera limits, add player node and set the global id to the
|
||||||
# name of this node if it's not set manually
|
# name of this node if it's not set manually
|
||||||
func _ready():
|
func _ready():
|
||||||
if camera_limits.empty():
|
escoria.room_manager.init_room(self)
|
||||||
camera_limits.push_back(Rect2())
|
|
||||||
if camera_limits.size() == 1 and camera_limits[0].has_no_area():
|
|
||||||
for child in get_children():
|
|
||||||
if child is ESCBackground:
|
|
||||||
camera_limits[0] = \
|
|
||||||
Rect2(0, 0, child.rect_size.x, child.rect_size.y)
|
|
||||||
|
|
||||||
if Engine.is_editor_hint():
|
|
||||||
return
|
|
||||||
|
|
||||||
if has_node("game"):
|
|
||||||
game = $game
|
|
||||||
if game == null:
|
|
||||||
game = escoria.game_scene
|
|
||||||
add_child(game)
|
|
||||||
move_child(game, 0)
|
|
||||||
|
|
||||||
# Determine whether this room was run from change_scene or directly
|
|
||||||
if escoria.main.has_node(name):
|
|
||||||
is_run_directly = false
|
|
||||||
else:
|
|
||||||
is_run_directly = true
|
|
||||||
if escoria.main.current_scene == null:
|
|
||||||
escoria.main.set_scene(self)
|
|
||||||
|
|
||||||
if player_scene:
|
|
||||||
player = player_scene.instance()
|
|
||||||
add_child(player)
|
|
||||||
escoria.object_manager.register_object(
|
|
||||||
ESCObject.new(
|
|
||||||
player.global_id,
|
|
||||||
player
|
|
||||||
),
|
|
||||||
true
|
|
||||||
)
|
|
||||||
if escoria.globals_manager.has(
|
|
||||||
escoria.room_manager.GLOBAL_ANIMATION_RESOURCES
|
|
||||||
):
|
|
||||||
var animations = escoria.globals_manager.get_global(
|
|
||||||
escoria.room_manager.GLOBAL_ANIMATION_RESOURCES
|
|
||||||
)
|
|
||||||
|
|
||||||
if player.global_id in animations and \
|
|
||||||
ResourceLoader.exists(animations[player.global_id]):
|
|
||||||
player.animations = ResourceLoader.load(
|
|
||||||
animations[player.global_id]
|
|
||||||
)
|
|
||||||
player.update_idle()
|
|
||||||
escoria.object_manager.get_object("_camera").node.set_target(player)
|
|
||||||
|
|
||||||
if global_id.empty():
|
|
||||||
global_id = name
|
|
||||||
|
|
||||||
# Manage player location at room start
|
|
||||||
if player != null \
|
|
||||||
and escoria.object_manager.get_start_location() != null:
|
|
||||||
player.teleport(escoria.object_manager.get_start_location().node)
|
|
||||||
|
|
||||||
perform_script_events()
|
|
||||||
|
|
||||||
|
|
||||||
# Performs the ESC script events "setup" and "ready", in this order, if they are
|
|
||||||
# present. Also manages automatic transitions.
|
|
||||||
func perform_script_events():
|
|
||||||
if esc_script and escoria.event_manager.is_channel_free("_front") \
|
|
||||||
or (
|
|
||||||
not escoria.event_manager.is_channel_free("_front") and \
|
|
||||||
not escoria.event_manager.get_running_event(
|
|
||||||
"_front"
|
|
||||||
).name == "load"
|
|
||||||
):
|
|
||||||
|
|
||||||
# If the room was loaded from change_scene and automatic transitions
|
|
||||||
# are not disabled, do the transition out now
|
|
||||||
if enabled_automatic_transitions \
|
|
||||||
and not is_run_directly \
|
|
||||||
and not exited_previous_room:
|
|
||||||
var script_transition_out = escoria.esc_compiler.compile([
|
|
||||||
":transition_out",
|
|
||||||
"transition %s out" % ProjectSettings.get_setting(
|
|
||||||
"escoria/ui/default_transition"
|
|
||||||
),
|
|
||||||
"wait 0.1"
|
|
||||||
])
|
|
||||||
escoria.event_manager.queue_event(
|
|
||||||
script_transition_out.events['transition_out']
|
|
||||||
)
|
|
||||||
|
|
||||||
# Unpause the game if it was
|
|
||||||
escoria.set_game_paused(false)
|
|
||||||
|
|
||||||
# Wait for transition_out event to be done
|
|
||||||
var rc = yield(escoria.event_manager, "event_finished")
|
|
||||||
while rc[1] != "transition_out":
|
|
||||||
rc = yield(escoria.event_manager, "event_finished")
|
|
||||||
if rc[0] != ESCExecution.RC_OK:
|
|
||||||
return rc[0]
|
|
||||||
|
|
||||||
# Hide main and pause menus
|
|
||||||
escoria.game_scene.hide_main_menu()
|
|
||||||
escoria.game_scene.unpause_game()
|
|
||||||
|
|
||||||
# Run the setup event
|
|
||||||
_run_script_event("setup")
|
|
||||||
|
|
||||||
if enabled_automatic_transitions \
|
|
||||||
or (
|
|
||||||
not enabled_automatic_transitions \
|
|
||||||
and escoria.globals_manager.get_global( \
|
|
||||||
escoria.room_manager.GLOBAL_FORCE_LAST_SCENE_NULL)
|
|
||||||
):
|
|
||||||
var script_transition_in = escoria.esc_compiler.compile([
|
|
||||||
":transition_in",
|
|
||||||
"transition %s in" % ProjectSettings.get_setting(
|
|
||||||
"escoria/ui/default_transition"
|
|
||||||
),
|
|
||||||
"wait 0.1"
|
|
||||||
])
|
|
||||||
escoria.event_manager.queue_event(
|
|
||||||
script_transition_in.events['transition_in']
|
|
||||||
)
|
|
||||||
|
|
||||||
var ready_event_added: bool = false
|
|
||||||
# Run the ready event, if there is one.
|
|
||||||
ready_event_added = _run_script_event("ready")
|
|
||||||
|
|
||||||
if ready_event_added:
|
|
||||||
# Wait for ready event to be done
|
|
||||||
var rc = yield(escoria.event_manager, "event_finished")
|
|
||||||
while rc[1] != "ready":
|
|
||||||
rc = yield(escoria.event_manager, "event_finished")
|
|
||||||
if rc[0] != ESCExecution.RC_OK:
|
|
||||||
return rc[0]
|
|
||||||
|
|
||||||
# Now that :ready is finished, if FORCE_LAST_SCENE_NULL was true, reset it
|
|
||||||
# to false
|
|
||||||
if escoria.globals_manager.get_global( \
|
|
||||||
escoria.room_manager.GLOBAL_FORCE_LAST_SCENE_NULL):
|
|
||||||
|
|
||||||
escoria.globals_manager.set_global(
|
|
||||||
escoria.room_manager.GLOBAL_FORCE_LAST_SCENE_NULL,
|
|
||||||
false,
|
|
||||||
true
|
|
||||||
)
|
|
||||||
escoria.globals_manager.set_global(
|
|
||||||
escoria.room_manager.GLOBAL_LAST_SCENE,
|
|
||||||
escoria.main.current_scene.global_id \
|
|
||||||
if escoria.main.current_scene != null else "",
|
|
||||||
true
|
|
||||||
)
|
|
||||||
|
|
||||||
# Make the room's global ID available for use in ESC script.
|
|
||||||
escoria.globals_manager.set_global(
|
|
||||||
escoria.room_manager.GLOBAL_CURRENT_SCENE,
|
|
||||||
escoria.main.current_scene.global_id \
|
|
||||||
if escoria.main.current_scene != null else "",
|
|
||||||
true
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
# Runs the script event from the script attached, if any.
|
|
||||||
#
|
|
||||||
# #### Parameters
|
|
||||||
#
|
|
||||||
# - event_name: the name of the event to run
|
|
||||||
#
|
|
||||||
# *Returns* true if the event was correctly added. Will be false if the event
|
|
||||||
# does not exist in the script.
|
|
||||||
func _run_script_event(event_name: String):
|
|
||||||
if !esc_script:
|
|
||||||
return false
|
|
||||||
if compiled_script == null:
|
|
||||||
compiled_script = escoria.esc_compiler.load_esc_file(esc_script)
|
|
||||||
|
|
||||||
if compiled_script.events.has(event_name):
|
|
||||||
escoria.logger.debug(
|
|
||||||
"esc_room:_run_script_event",
|
|
||||||
[
|
|
||||||
"Queuing room script event %s" % event_name,
|
|
||||||
"Composed of %s statements" % str(compiled_script.events[event_name].statements.size())
|
|
||||||
]
|
|
||||||
)
|
|
||||||
escoria.event_manager.queue_event(compiled_script.events[event_name])
|
|
||||||
return true
|
|
||||||
else:
|
|
||||||
return false
|
|
||||||
|
|
||||||
|
|
||||||
# Draw the camera limits visualization if enabled
|
# Draw the camera limits visualization if enabled
|
||||||
|
|||||||
Reference in New Issue
Block a user