oier/gymkhana-actions
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Fix wrong (old) documentation about setup and ready events (#524)

Browse Source 
Co-authored-by: Duncan Brown <duncan@prometheussoftware.ca>
This commit is contained in:
Julian Murgia
2022-03-07 17:27:55 +01:00
committed by GitHub
parent 19272ffeb2
commit ac2e7ba20e
1 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
addons/escoria-core/game/core-scripts/esc/types/esc_event.gd
View File

@@ -2,8 +2,14 @@
#
# Events are triggered from various sources. Common events include
#
# * :setup Called every time when visiting a scene
# * :ready Called the first time a scene is visited
# * :setup : This event is always the first to be called each time the room is visited.
# It allows elements in the room to be prepared *before* the room is displayed to the
# player (e.g. starting particle effects).
# * :ready : This event is the second to be called each time the room is visited.
# It is run immediately after `:setup` finishes execution, if it exists. Otherwise,
# `:ready` will be the first event to run. Regardless, this event is run *after*
# the room is displayed to the player, allowing cutscenes or animations to be
# run once the room is visible.
# * :use <global id> Called from the current item when it is used with the item
# with the global id <global id>
extends ESCStatement