Skip to content

Commit

Permalink
feat: Updated exit documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Balloonpopper committed Mar 18, 2022
1 parent 82078a2 commit f122394
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 3 deletions.
11 changes: 10 additions & 1 deletion addons/escoria-core/game/core-scripts/esc_exit.gd
Original file line number Diff line number Diff line change
@@ -1,4 +1,13 @@
# An item that streamlines exiting scenes
# An item that streamlines exiting scenes.
#
# Use this when you want this object to only change scenes (with an optional
# sound effect.)
#
# 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.
#
# The game character will automatically walk to an ESCLocation created as a
# child of an ESCExit node.
extends ESCItem
class_name ESCExit, "res://addons/escoria-core/design/esc_exit.svg"

Expand Down
9 changes: 7 additions & 2 deletions addons/escoria-core/game/core-scripts/esc_item.gd
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# ESCItem is a Sprite that defines an item, potentially interactive
# ESCItem is a Sprite that defines an item, potentially interactive.
#
# The game character will automatically walk to an ESCLocation that
# is created as a child of an ESCItem.
tool
extends Area2D
class_name ESCItem, "res://addons/escoria-core/design/esc_item.svg"
Expand Down Expand Up @@ -53,7 +56,9 @@ export(String) var global_id
# The ESC script for this item
export(String, FILE, "*.esc") var esc_script

# If true, the ESC script may have an ":exit_scene" event to manage scene changes
# If true, the ESC script may have an ":exit_scene" event to manage scene changes.
# For simple exits that do not require scripted actions, the ESCExit node may be
# preferred.
export(bool) var is_exit

# If true, object is considered as trigger. Allows using :trigger_in and
Expand Down

0 comments on commit f122394

Please sign in to comment.