Comment tweaks.

git-svn-id: svn+ssh://src.earth.threerings.net/vilya/trunk@536 c613c5cb-e716-0410-b11b-feb51c14d237
This commit is contained in:
Ray Greenwell
2007-12-22 01:23:40 +00:00
parent d711f2ae97
commit bc2b47a6ca
12 changed files with 56 additions and 33 deletions
@@ -85,7 +85,8 @@ package com.threerings.ezgame {
[Event(name="UserChat", type="com.threerings.ezgame.UserChatEvent")]
/**
* Access game-specific controls.
* Access game-specific controls. Do not instantiate this class yourself.
* Access it via GameControl.game.
*/
public class EZGameSubControl extends AbstractSubControl
{
@@ -107,6 +108,8 @@ public class EZGameSubControl extends AbstractSubControl
/**
* Get any game-specific configurations that were set up in the lobby.
*
* @return an Object containing config names mapping to their values.
*/
public function getConfig () :Object
{
@@ -133,7 +136,7 @@ public class EZGameSubControl extends AbstractSubControl
}
/**
* Returns the player ids of all occupants in the game room.
* Returns the player ids of all occupants in the game room: players and watchers.
*/
public function getOccupantIds () :Array /* of playerId */
{
@@ -143,7 +146,7 @@ public class EZGameSubControl extends AbstractSubControl
/**
* Get the display name of the specified occupant. Two players may have the same name: always
* use playerId to purposes of identification and comparison. The name is for display
* only. Will be null is the specified playerId is not in the game.
* only. Will be null is the specified playerId is not present.
*/
public function getOccupantName (playerId :int) :String
{