docs: Partial API ref and doc updates for trackedevent

regal · Jan 12, 2019 · c6dc1ba · c6dc1ba
1 parent 6cc4ff6
commit c6dc1ba
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1342,6 +1342,26 @@ Parameter | Description
 
 ### `TrackedEvent`
 
+**_Interface_**
+
+An [`EventFunction`](#eventfunction) that is tracked by the game instance.
+
+```ts
+interface TrackedEvent<StateType = any> extends EventFunction<StateType> {
+    (game: GameInstance<StateType>): TrackedEvent<StateType> | EventFunction<StateType>
+    eventName: string
+    target: EventFunction<StateType>
+    then(...events: Array<TrackedEvent<StateType>>): EventQueue<StateType>
+    thenq(...events: Array<TrackedEvent<StateType>>): EventQueue<StateType>
+}
+```
+
+#### Description
+
+In order for Regal to behave properly, all modifications of game state should take place inside tracked events.
+
+#### Description
+
 ### `enqueue`
 
 ### `noop`

diff --git a/src/events/event-types.ts b/src/events/event-types.ts
@@ -21,8 +21,8 @@ export type EventFunction<StateType = any> = (
 /**
  * An `EventFunction` that is tracked by the game instance.
  *
- * In order for Regal to behave properly, all modifications made by the game
- * developer to a `GameInstance` should be done through tracked events.
+ * In order for Regal to behave properly, all modifications of game state
+ * should take place inside tracked events.
  *
  * @template StateType The `GameInstance` state type. Optional, defaults to `any`.
  * @param game The game instance to be modified.