Skip to content

Commit

Permalink
Update addons/escoria-core/game/core-scripts/esc_exit.gd
Browse files Browse the repository at this point in the history
  • Loading branch information
balloonpopper authored and Balloonpopper committed Mar 18, 2022
1 parent f65aef6 commit 3db051e
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 6 deletions.
8 changes: 5 additions & 3 deletions addons/escoria-core/game/core-scripts/esc_exit.gd
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# An item that streamlines exiting scenes.
# An ESCExit is a minimal feature node that provides an exit to a room.
#
# Use this when you want this object to only change scenes (with an optional
# sound effect).
# For exits that don't require scripts, the ``ESCExit`` node is provided.
# The only things you will need to configure on the node are the
# "target_scene" to change to, and optionally, a "switch
# sound" (the sound to play when changing rooms).
#
# If you want to attach the exit to a script to perform additional actions -
# a cutscene for example, use an ESCItem with "Is Exit" selected instead.
Expand Down
13 changes: 10 additions & 3 deletions addons/escoria-core/game/core-scripts/esc_item.gd
Original file line number Diff line number Diff line change
@@ -1,7 +1,14 @@
An ESCItem defines a potentially interactive item in the game.
# An ESCItem defines a (usually interactive) item in the game.
#
# The game character will automatically walk to an ESCLocation that
# is created as a child of an ESCItem.
# When interacting with an ESCItem, the game character will automatically
# walk to an ESCLocation that is created as a child of an ESCItem.
#
# By selecting the "Is Exit" checkbox when you create an ``ESCItem``
# node, Escoria will look for a ":exit_scene" event in the attached script file.
# Any commands you place in the ":exit_scene" event will be run when the player
# chooses to "use" the exit - for example, saying a goodbye, or running a
# cutscene. Place a "change_scene" command as part of this event to move the
# character to the next room.
tool
extends Area2D
class_name ESCItem, "res://addons/escoria-core/design/esc_item.svg"
Expand Down

0 comments on commit 3db051e

Please sign in to comment.