summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'content/fate_v1/declarations/events/_index.md')
-rw-r--r--content/fate_v1/declarations/events/_index.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/content/fate_v1/declarations/events/_index.md b/content/fate_v1/declarations/events/_index.md
new file mode 100644
index 0000000..5493cd7
--- /dev/null
+++ b/content/fate_v1/declarations/events/_index.md
@@ -0,0 +1,18 @@
+---
+title: Events
+---
+Events are how a Fate narrative can communicate to the interpreter that
+something which cannot be expressed in Fate needs to be performed. The execution
+is paused until the event is resolved by the interpreter. To avoid mistakes, any
+event type must be declared before use.
+
+#### EVENT
+{{< fatecode >}}(declare_event_type {string} [C0 = TYPE] ... [CN = TYPE]){{< /fatecode >}}
+**Effect:** An event with the name `{string}` and taking parameters of types
+`[C0]`, ..., `[CN]` can be used.
+
+## Examples
+* `(declare_event_type user_string_input rich_text (ptr string))`
+* `(declare_event_type wait int)`
+* `(declare_event_type set_background_to string)`
+* `(declare_event_type rumble)`