From 29bec533d83f029e9f391f898cdaa958c9ff9db5 Mon Sep 17 00:00:00 2001
From: Ray Greenwell <ray@threerings.net>
Date: Fri, 12 Jan 2007 23:10:30 +0000
Subject: [PATCH] Documented the events currently being dispatched.

git-svn-id: svn+ssh://src.earth.threerings.net/vilya/trunk@147 c613c5cb-e716-0410-b11b-feb51c14d237
---
 src/as/com/threerings/ezgame/EZGameControl.as | 51 +++++++++++++++++++
 1 file changed, 51 insertions(+)

diff --git a/src/as/com/threerings/ezgame/EZGameControl.as b/src/as/com/threerings/ezgame/EZGameControl.as
index d9b6d23b..f8a77931 100644
--- a/src/as/com/threerings/ezgame/EZGameControl.as
+++ b/src/as/com/threerings/ezgame/EZGameControl.as
@@ -9,6 +9,57 @@ import flash.events.MouseEvent;
 
 import flash.display.DisplayObject;
 
+/**
+ * Dispatched when a key is pressed when the game has focus.
+ *
+ * @eventType flash.events.KeyboardEvent.KEY_DOWN
+ */
+[Event(name="keyDown", type="flash.events.KeyboardEvent")]
+
+/**
+ * Dispatched when a key is released when the game has focus.
+ *
+ * @eventType flash.events.KeyboardEvent.KEY_UP
+ */
+[Event(name="keyUp", type="flash.events.KeyboardEvent")]
+
+/**
+ * Dispatched when the game starts, usually after all players are present.
+ *
+ * @eventType com.threerings.ezgame.StateChangedEvent.GAME_STARTED
+ */
+[Event(name="GameStarted", type="com.threerings.ezgame.StateChangedEvent")]
+
+/**
+ * Dispatched when the turn changes in a turn-based game.
+ *
+ * @eventType com.threerings.ezgame.StateChangedEvent.TURN_CHANGED
+ */
+[Event(name="GameStarted", type="com.threerings.ezgame.StateChangedEvent")]
+
+/**
+ * Dispatched when the game ends.
+ *
+ * @eventType com.threerings.ezgame.StateChangedEvent.GAME_ENDED
+ */
+[Event(name="GameStarted", type="com.threerings.ezgame.StateChangedEvent")]
+
+/**
+ * Dispatched when a property has changed in the shared game state.
+ *
+ * @eventType com.threerings.ezgame.PropertyChangedEvent.TYPE
+ */
+[Event(name="PropChanged", type="com.threerings.ezgame.PropertyChangedEvent")]
+
+/**
+ * Dispatched when a message arrives with information that is not part
+ * of the shared game state.
+ *
+ * @eventType com.threerings.ezgame.MessageReceivedEvent.TYPE
+ */
+[Event(name="msgReceived", type="com.threerings.ezgame.MessageReceivedEvent")]
+
+
 /**
  * The single point of control for each client in your multiplayer EZGame.
  *