chatroom.java

Vyger offers a D & D and Rogue-like environment in a graphical online roleplay game.

/*
 * Light And Shadow. A Persistent Universe based on Robert Jordan's Wheel of Time Books.
 * Copyright (C) 2001-2002 WOTLAS Team
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */
 
package wotlas.common.chat;

import wotlas.common.Player;
import wotlas.common.universe.WotlasLocation;

import wotlas.libs.net.NetMessage;

import wotlas.utils.Debug;

import java.util.Hashtable;
import java.util.Iterator;


/** A chat room of the Chat Engine.
 *
 * @author Petrus
 */

public class ChatRoom
{
 /*------------------------------------------------------------------------------------*/
  
   /** ChatRooms Counter
    */
    private static int chatCounter = 0;

   /** Chat Primary key suffix
    */
    final public static String CHAT_SUFFIX = "chat-";

   /** Default Chat Primary key.
    */
    final public static String DEFAULT_CHAT = "chat-0";

 /*------------------------------------------------------------------------------------*/

   /** Voice Sound Level Definition - Whispering
    */
    final public static byte WHISPERING_VOICE_LEVEL = 0;

   /** Voice Sound Level Definition - Normal
    */
    final public static byte NORMAL_VOICE_LEVEL = 1;

   /** Voice Sound Level Definition - Shouting
    */
    final public static byte SHOUTING_VOICE_LEVEL = 2;

 /*------------------------------------------------------------------------------------*/

   /** Chat message maximum size ( in number of chars )
    */
    final public static int MAXIMUM_MESSAGE_SIZE = 250;

   /** Chat Room name maximum size ( in number of chars )
    */
    final public static int MAXIMUM_NAME_SIZE = 20;

   /** Maximum number of ChatRooms per Room.
    */
    final public static int MAXIMUM_CHATROOMS_PER_ROOM = 5;

  /** Min distance to declare a player member of a chat.
   *  Beware !! this is the square of the distance in pixels!
   */
    final public static int MIN_CHAT_DISTANCE = 2500;

 /*------------------------------------------------------------------------------------*/

  /** ID of the ChatRoom
   */
  private String primaryKey;
  
  /** Name of the ChatRoom
   */
  private String name;
  
  /** ID of the player who created the ChatRoom
   */
  private String creatorPrimaryKey;
  
  /** Location where the ChatRoom was created
   */
  private WotlasLocation location;
  
  /** Number maximum of players
   */
  private int maxPlayers;
  
  /** List of players' primary key in the ChatRoom
   */
  private Hashtable players = new Hashtable(2);
  
 /*------------------------------------------------------------------------------------*/  

  /** To get a valid ChatRoom primaryKey
   */
   synchronized static public String getNewChatPrimaryKey() {
      chatCounter++;
      return CHAT_SUFFIX+chatCounter;
   }

 /*------------------------------------------------------------------------------------*/  

  /** Constructor
   */
  public ChatRoom() {
  }
  
 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -*/

  /** List of setters and getters
   */
  public String getPrimaryKey() {
    return primaryKey;
  }

  public void setPrimaryKey(String primaryKey) {
    this.primaryKey = primaryKey;
  }

  public String getName() {
    return name;
  }

  public void setName(String name) {
    this.name = name;
  }

  public String getCreatorPrimaryKey() {
    return creatorPrimaryKey;
  }

  public void setCreatorPrimaryKey(String creatorPrimaryKey) {
    this.creatorPrimaryKey = creatorPrimaryKey;
  }

  public WotlasLocation getLocation() {
    return location;
  }

  public void setLocation(WotlasLocation location) {
    this.location = location;
  }
  
  public Hashtable getPlayers() {
    return players;
  }

 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -*/
  
  /** Add a player to this ChatRoom. The player must have been previously initialized.  
   *
   * @param player player to add
   * @return false if the player already exists on this ChatRoom, true otherwise
   */
  public boolean addPlayer(Player player) {
    players.put( player.getPrimaryKey(), player );
    return true;
  }
    
 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -*/

  /** Removes a player from this ChatRoom.   
   *
   * @param player player to remove
   * @return false if the player doesn't exists in this ChatRoom, true otherwise
   */
  public boolean removePlayer(Player player) {
    if ( !players.containsKey(player.getPrimaryKey()) ) {
      Debug.signal( Debug.CRITICAL, this, "removePlayer failed: key "+player.getPrimaryKey()
                         +" not found in "+this );
      return false;
    }
    players.remove( player.getPrimaryKey() );
    return true;
  }
  
 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -*/

  /** To send a message to the players that are in our chat room.
   * @param msg message to send
   */
    public void sendMessageToChatRoom( NetMessage msg ) {
          synchronized( players ) {
               Iterator it = players.values().iterator();
               
               while( it.hasNext() )
                    ( (Player)it.next() ).sendMessage( msg );
          }
    }

 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -*/

  /** String Info.
   */
    public String toString(){
      return "ChatRoom : " + primaryKey;
    }

 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -*/
 
}