Added @eventType tags to the event type constants.
AsDoc is crappy: the @eventType tag has two different syntaxes, depending on whether you're using it to comment an [Event] declared by a class, or the type constant. Also: this is pointless, asdoc should be able to get this value using the other @eventType tag, but instead we have to be redundant, possibly making a mistake. git-svn-id: svn+ssh://src.earth.threerings.net/vilya/trunk@547 c613c5cb-e716-0410-b11b-feb51c14d237
This commit is contained in:
@@ -28,7 +28,11 @@ import flash.events.Event;
|
||||
*/
|
||||
public class MessageReceivedEvent extends EZEvent
|
||||
{
|
||||
/** The type of all MessageReceivedEvents. */
|
||||
/**
|
||||
* The type of all MessageReceivedEvents.
|
||||
*
|
||||
* @eventType msgReceived
|
||||
*/
|
||||
public static const MESSAGE_RECEIVED :String = "msgReceived";
|
||||
|
||||
/**
|
||||
|
||||
@@ -25,7 +25,14 @@ import flash.events.Event;
|
||||
|
||||
public class OccupantChangedEvent extends EZEvent
|
||||
{
|
||||
/**
|
||||
* @eventType OccupantEntered
|
||||
*/
|
||||
public static const OCCUPANT_ENTERED :String = "OccupantEntered";
|
||||
|
||||
/**
|
||||
* @eventType OccupantLeft
|
||||
*/
|
||||
public static const OCCUPANT_LEFT :String = "OccupantLeft";
|
||||
|
||||
/** The occupantId of the occupant that entered or left. */
|
||||
|
||||
@@ -29,7 +29,11 @@ import flash.events.Event;
|
||||
*/
|
||||
public class PropertyChangedEvent extends EZEvent
|
||||
{
|
||||
/** The type of a property change event. */
|
||||
/**
|
||||
* The type of a property change event.
|
||||
*
|
||||
* @eventType PropChanged
|
||||
*/
|
||||
public static const PROPERTY_CHANGED :String = "PropChanged";
|
||||
|
||||
/**
|
||||
|
||||
@@ -31,7 +31,11 @@ import flash.geom.Point;
|
||||
*/
|
||||
public class SizeChangedEvent extends EZEvent
|
||||
{
|
||||
/** The type of this event. */
|
||||
/**
|
||||
* The type of this event.
|
||||
*
|
||||
* @eventType SizeChanged
|
||||
*/
|
||||
public static const SIZE_CHANGED :String = "SizeChanged";
|
||||
|
||||
/**
|
||||
|
||||
@@ -28,23 +28,40 @@ import flash.events.Event;
|
||||
*/
|
||||
public class StateChangedEvent extends EZEvent
|
||||
{
|
||||
/** Indicates that the game has transitioned to a started state. */
|
||||
/**
|
||||
* Indicates that the game has transitioned to a started state.
|
||||
* @eventType GameStarted
|
||||
*/
|
||||
public static const GAME_STARTED :String = "GameStarted";
|
||||
|
||||
/** Indicates that the game has transitioned to a ended state. */
|
||||
/**
|
||||
* Indicates that the game has transitioned to a ended state.
|
||||
* @eventType GameEnded
|
||||
*/
|
||||
public static const GAME_ENDED :String = "GameEnded";
|
||||
|
||||
/** Indicates that a round has started. Games that do not require multiple rounds can ignore
|
||||
* this event. */
|
||||
/**
|
||||
* Indicates that a round has started. Games that do not require multiple rounds can ignore
|
||||
* this event.
|
||||
* @eventType RoundStarted
|
||||
*/
|
||||
public static const ROUND_STARTED :String = "RoundStarted";
|
||||
|
||||
/** Indicates that the current round has ended. */
|
||||
/**
|
||||
* Indicates that the current round has ended.
|
||||
* @eventType RoundEnded
|
||||
*/
|
||||
public static const ROUND_ENDED :String = "RoundEnded";
|
||||
|
||||
/** Indicates that a new controller has been assigned. */
|
||||
/**
|
||||
* Indicates that a new controller has been assigned.
|
||||
* @eventType ControlChanged
|
||||
*/
|
||||
public static const CONTROL_CHANGED :String = "ControlChanged";
|
||||
|
||||
/** Indicates that the turn has changed. */
|
||||
/** Indicates that the turn has changed.
|
||||
* @eventType TurnChanged
|
||||
*/
|
||||
// TODO: move to own event?
|
||||
public static const TURN_CHANGED :String = "TurnChanged";
|
||||
|
||||
|
||||
@@ -28,7 +28,10 @@ import flash.events.Event;
|
||||
*/
|
||||
public class UserChatEvent extends EZEvent
|
||||
{
|
||||
/** The type of a property change event. */
|
||||
/**
|
||||
* The type of a property change event.
|
||||
* @eventType UserChat
|
||||
*/
|
||||
public static const USER_CHAT :String = "UserChat";
|
||||
|
||||
/**
|
||||
|
||||
Reference in New Issue
Block a user