diff --git a/src/as/com/threerings/ezgame/HostCoordinator.as b/src/as/com/threerings/ezgame/HostCoordinator.as
index 42d3e9a9..4461116f 100644
--- a/src/as/com/threerings/ezgame/HostCoordinator.as
+++ b/src/as/com/threerings/ezgame/HostCoordinator.as
@@ -21,57 +21,49 @@
package com.threerings.ezgame {
-import flash.events.EventDispatcher;
-
+import flash.events.EventDispatcher;
+
/**
- HostCoordinator provides methods for determining whether the current
- client should consider itself the authority in dealing with game state
- (for example, when dealing out cards, or setting up the game board).
-
- Current hosting state can be retrieved from the /status/ property.
- Please note that hosting authority can be transferred between clients
- at any moment, so all clients should be prepared to suddenly take
- over host responsibilities.
-
- Additionally, the client can register itself for notifications
- about changes to the /status/ property - see HostEvent.
-
- Usage example:
-
-
- _coord = new HostCoordinator (_gameCtrl);
- _coord.addEventListener (HostEvent.CLAIMED, firstHostHandler);
- _coord.addEventListener (HostEvent.CHANGED, hostChangeHandler);
-
- ...
-
- function firstHostHandler (event : HostEvent)
- {
- if (_coord.status == HostCoordinator.STATUS_HOST)
- {
- // I'm the first host in the game - I should set up the initial board, etc.
- }
- }
-
- function hostChangeHandler (event : HostEvent)
- {
- if (_coord.status == HostCoordinator.STATUS_HOST)
- {
- // I just became the host - do whatever is needed.
- }
- }
-
-
-*/
-public class HostCoordinator
- extends EventDispatcher
+ * HostCoordinator provides methods for determining whether the current client should consider
+ * itself the authority in dealing with game state (for example, when dealing out cards, or setting
+ * up the game board).
+ *
+ * Current hosting state can be retrieved from the /status/ property. Please note that hosting
+ * authority can be transferred between clients at any moment, so all clients should be prepared to
+ * suddenly take over host responsibilities.
+ *
+ * Additionally, the client can register itself for notifications about changes to the /status/
+ * property - see HostEvent.
+ *
+ * Usage example:
+ *
+ *
+ * _coord = new HostCoordinator (_gameCtrl);
+ * _coord.addEventListener (HostEvent.CLAIMED, firstHostHandler);
+ * _coord.addEventListener (HostEvent.CHANGED, hostChangeHandler);
+ *
+ * ...
+ *
+ * function firstHostHandler (event : HostEvent) {
+ * if (_coord.status == HostCoordinator.STATUS_HOST) {
+ * // I'm the first host in the game - I should set up the initial board, etc.
+ * }
+ * }
+ *
+ * function hostChangeHandler (event : HostEvent) {
+ * if (_coord.status == HostCoordinator.STATUS_HOST) {
+ * // I just became the host - do whatever is needed.
+ * }
+ * }
+ *
+ */
+public class HostCoordinator extends EventDispatcher
implements OccupantChangedListener, PropertyChangedListener
{
- // CONSTANTS
+ // PUBLIC INTERFACE
- /** Status constant, means that the current status is unknown, either because
- the data had not yet arrived from the server, or because nobody claims
- to be host for this game. */
+ /** Status constant, means that the current status is unknown, either because the data had not
+ * yet arrived from the server, or because nobody claims to be host for this game. */
public static const STATUS_UNKNOWN : String = "STATUS_UNKNOWN";
/** Status constant, means that this client is the current host. */
@@ -79,148 +71,129 @@ public class HostCoordinator
/** Status constant, means that some other client is the current host. */
public static const STATUS_NOT_HOST : String = "STATUS_NOT_HOST";
-
-
- // PUBLIC INTERFACE
-
/**
- Constructor, expects an initialized instance of EZGameControl.
-
- If the optional showDebug flag is set, it will display host info
- as chat messages (only useful for debugging).
+ * Constructor, expects an initialized instance of EZGameControl. If the optional showDebug
+ * flag is set, it will display host info as chat messages (only useful for debugging).
*/
public function HostCoordinator (control : EZGameControl, showDebug : Boolean = false)
{
_control = control;
- _control.registerListener (this);
-
+ _control.registerListener(this);
_showDebug = showDebug;
- // Try set host role if it's not already claimed (i.e. null)
- debugLog ("Trying to claim host role.");
- debugLog ("Current status: " + status);
- tryReplaceHost (null);
+ if (_control.isConnected()) {
+ // Try set host role if it's not already claimed (i.e. null)
+ debugLog("Trying to claim host role.");
+ debugLog("Current status: " + status);
+ tryReplaceHost(null);
+ }
}
/**
- Retrieves current host coordination status, as one of the STATUS_*
- constants.
-
- Note: do not save the value of this property. Hosting status
- can change at any moment: when the current host quits the game,
- any client can suddenly become the new host.
-l */
+ * Retrieves current host coordination status, as one of the STATUS_* constants.
+ *
+ * Note: do not save the value of this property. Hosting status can change at any moment: when
+ * the current host quits the game, any client can suddenly become the new host.
+ */
public function get status () : String
{
- var hostId : Number = getHostId ();
- if (hostId == _control.getMyId ()) { return STATUS_HOST; }
- if (hostId > 0) { return STATUS_NOT_HOST; }
- return STATUS_UNKNOWN;
+ var hostId : Number = getHostId();
+ if (hostId == _control.getMyId()) {
+ return STATUS_HOST;
+ }
+ if (hostId > 0) {
+ return STATUS_NOT_HOST;
+ }
+ return STATUS_UNKNOWN;
}
-
-
-
// EVENT HANDLERS
- /** From OccupantChangedListener: keep track of people coming in */
+ // from interface OccupantChangedListener
public function occupantEntered (event : OccupantChangedEvent) : void
{
debugHostStatus ();
}
- /** From OccupantChangedListener: keep track of people leaving */
+ // from interface OccupantChangedListener
public function occupantLeft (event : OccupantChangedEvent) : void
{
- // If the occupant who just left was the host, every client will
- // get a shot at trying to claim their role.
- debugLog ("My ID: " + _control.getMyId ());
- debugLog ("Occupant left: " + event.occupantId);
- debugLog ("Current host: " + getHostId());
+ // If the occupant who just left was the host, every client will get a shot at trying to
+ // claim their role.
+ debugLog("My ID: " + _control.getMyId());
+ debugLog("Occupant left: " + event.occupantId);
+ debugLog("Current host: " + getHostId());
- if (getHostId () == event.occupantId) // Elvis has left the building
- {
- debugLog ("Removing the old host...");
- // Clear the old host value, and put myself in their place.
- // Only the first client will succeed in doing this.
+ if (getHostId() == event.occupantId) { // Elvis has left the building
+ debugLog("Removing the old host...");
+ // Clear the old host value, and put myself in their place. Only the first client will
+ // succeed in doing this.
tryReplaceHost (event.occupantId);
}
}
-
- /** From PropertyChangedListener: keep track of changing host values */
+
+ // from interface PropertyChangedListener
public function propertyChanged (event : PropertyChangedEvent) : void
{
- if (event.name == HOST_NAME)
- {
- debugLog ("Host variable changed to: " + event.newValue);
-
- // if the host was not known before, dispatch the claimed event
- if (event.oldValue == null &&
- event.newValue != null)
- {
- var claimed : HostEvent = new HostEvent (HostEvent.CLAIMED, _control);
- this.dispatchEvent (claimed);
- }
-
- // always dispatch the changed event
- var changed : HostEvent = new HostEvent (HostEvent.CHANGED, _control);
- this.dispatchEvent (changed);
- }
- }
-
+ if (event.name == HOST_NAME) {
+ debugLog("Host variable changed to: " + event.newValue);
- // PRIVATE FUNCTIONS
+ // if the host was not known before, dispatch the claimed event
+ if (event.oldValue == null && event.newValue != null) {
+ this.dispatchEvent(new HostEvent(HostEvent.CLAIMED, _control));
+ }
+
+ // always dispatch the changed event
+ this.dispatchEvent(new HostEvent(HostEvent.CHANGED, _control));
+ }
+ }
+
+ // IMPLEMENTATION DETAILS
/** Get the current host ID (will be 0 if there is no authoritative host) */
- private function getHostId () : Number
+ protected function getHostId () : Number
{
- var hostvalue : Object = _control.get (HOST_NAME);
- if (hostvalue != null && hostvalue is Number)
- {
+ var hostvalue : Object = _control.get(HOST_NAME);
+ if (hostvalue != null && hostvalue is Number) {
return hostvalue as Number;
}
return 0;
}
- /** Helper function: tries to set the host variable to the client's id,
- if the current value is equal to /hostId/. If the value of null for
- hostId has the meaning of "set me as host only if the role has not
- been claimed yet". */
- private function tryReplaceHost (hostId : Object) : void
+ /** Helper function: tries to set the host variable to the client's id, if the current value is
+ * equal to /hostId/. If the value of null for hostId has the meaning of "set me as host only
+ * if the role has not been claimed yet". */
+ protected function tryReplaceHost (hostId : Object) : void
{
_control.testAndSet (HOST_NAME, _control.getMyId (), hostId);
debugHostStatus ();
}
/** Debug only */
- private function debugLog (message : String) : void
+ protected function debugLog (message : String) : void
{
- if (_showDebug) { _control.localChat (message); }
+ if (_showDebug) {
+ _control.localChat (message);
+ }
}
/** Debug only */
- private function debugHostStatus () : void
+ protected function debugHostStatus () : void
{
- debugLog (
- (status == STATUS_HOST ? "I am" : "I'm not") +
- " the host (id " + getHostId() + ", mine is " + _control.getMyId() + ")");
+ debugLog((status == STATUS_HOST ? "I am" : "I'm not") +
+ " the host (id " + getHostId() + ", mine is " + _control.getMyId() + ")");
}
-
- // PRIVATE VALUES
-
/** Magic key that stores current authoritative host */
- private var HOST_NAME : String = "HOST_COORDINATOR_AUTHORITATIVE_HOST";
+ protected var HOST_NAME : String = "HOST_COORDINATOR_AUTHORITATIVE_HOST";
/** Controller storage */
- private var _control : EZGameControl = null;
+ protected var _control : EZGameControl = null;
/** Debug flag */
- private var _showDebug : Boolean;
-
+ protected var _showDebug : Boolean;
}
-
}