Indicate that isActivePlayer is a better way to see if a player is in the game than accessing playerStatus directly

git-svn-id: svn+ssh://src.earth.threerings.net/vilya/trunk@597 c613c5cb-e716-0410-b11b-feb51c14d237

src/java/com/threerings/parlor/game/data/GameObject.java

@@ -21,7 +21,6 @@
 
 package com.threerings.parlor.game.data;
 
-import com.samskivert.util.ListUtil;
 import com.samskivert.util.StringUtil;
 import com.threerings.util.Name;
 
@@ -103,10 +102,13 @@ public class GameObject extends PlaceObject
     /** The unique round identifier for the current round. */
     public int roundId;
 
-    /** If null, indicates that all present players are active, or for
+    /**
-     * more complex games can be non-null to indicate the current status
+     * If null, indicates that all present players are active, or for more complex games can be
-     * of each player in the game. The status value is one of
+     * non-null to indicate the current status of each player in the game. The status value is one
-     * {@link #PLAYER_LEFT_GAME} or {@link #PLAYER_IN_PLAY}. */
+     * of {@link #PLAYER_LEFT_GAME} or {@link #PLAYER_IN_PLAY}.<p>
+     * Subclasses of GameObject may use other means to determine a player's status in the game, so
+     * call {@link #isActivePlayer(int)} to see if a player is still participating in a game.
+     */
     public int[] playerStatus;
 
     /**