wotlaslocation.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.universe;

import wotlas.libs.persistence.*;

 /** Location class. Identifies a precise location in the universe. Normally,
  *  it points out a room of an InteriorMap, building, town, world.<br>
  *  But it can points out :<p><br>
  *
  *  - a World ( worldMapId set, townMapId=-1, buildingID=-1, interiorMapId=-1, roomID=-1, tileMapID=-1)<br>
  *
  *  - a Town ( worldMapId set, townMapId set, buildingID=-1, interiorMapId=-1, roomID=-1, tileMapID=-1)
  *
  *  - a TileMap [flat or isometric]
  *           ( worldMapId set, townMapId=-1, buildingID=-1, interiorMapId=-1, roomID=-1, tileMapID=set)
  * @author Petrus, Aldiss, Diego
  */
  
public class WotlasLocation implements BackupReady
{
    /** id used in Serialized interface.
     */
    private static final long serialVersionUID = 556565L;

 /*------------------------------------------------------------------------------------*/
 
  /** worldMapID
   */
    private int worldMapID;
   
  /** townMapID
   */
    private int townMapID;

  /** buildingID
   */
    private int buildingID;
   
  /** interiorMapID
   */
    private int interiorMapID;
   
  /** roomID
   */
    private int roomID;

  /** tileID
   */
    private int tileMapID;
 
 /*------------------------------------------------------------------------------------*/

  /** Constructor.
   */
    public WotlasLocation() {
        this.tileMapID = -1;
    }

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

  /** Constructor from another WotlasLocation.
   */
    public WotlasLocation( WotlasLocation other ) {
        this.worldMapID = other.worldMapID;
        this.townMapID = other.townMapID;
        this.buildingID = other.buildingID;
        this.interiorMapID = other.interiorMapID;
        this.roomID = other.roomID;
        this.tileMapID = other.tileMapID;
    }

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

  /** Constructor for Rooms.
   */
    public WotlasLocation(int worldMapID, int townMapID, int buildingID, int interiorMapID,
                          int roomID) {
        this.worldMapID = worldMapID;
        this.townMapID = townMapID;
        this.buildingID = buildingID;
        this.interiorMapID = interiorMapID;
        this.roomID = roomID;
        this.tileMapID = -1;
    }

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

  /** Constructor for TownMap.
   */
    public WotlasLocation( int worldMapID, int townMapID ) {
        this.worldMapID = worldMapID;
        this.townMapID = townMapID;
        this.buildingID = -1;
        this.interiorMapID = -1;
        this.roomID = -1;
        this.tileMapID = -1;
    }
    
 /*------------------------------------------------------------------------------------*/

  /** Constructor for TileMap, after using WotlasWorld
   */
    public void WotlasLocationChangeToTileMap( int tileMapID ) {
        this.townMapID = -1;
        this.buildingID = -1;
        this.interiorMapID = -1;
        this.roomID = -1;
        this.tileMapID = tileMapID;
    }

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

  /** Constructor for WorldMap.
   */
    public WotlasLocation( int worldMapID ) {
        this.worldMapID = worldMapID;
        this.townMapID = -1;
        this.buildingID = -1;
        this.interiorMapID = -1;
        this.roomID = -1;
        this.tileMapID = -1;
    }

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

   /** To get the WorldMapID
    *
    * @return WorldMapID
    */
    public int getWorldMapID() {
        return worldMapID;
    }

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

   /** To get the townMapID
    *
    * @return townMapID
    */
    public int getTownMapID() {
        return townMapID;
    }

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

   /** To get the buildingID
    *
    * @return buildingID
    */
    public int getBuildingID() {
        return buildingID;
    }

 /*------------------------------------------------------------------------------------*/
  
   /** To get the interiorMapID
    *
    * @return interiorMapID
    */
    public int getInteriorMapID() {
        return interiorMapID;
    }

 /*------------------------------------------------------------------------------------*/
  
   /** To get the roomID
    *
    * @return roomID
    */
    public int getRoomID() {
        return roomID;
    }

 /*------------------------------------------------------------------------------------*/
  
   /** To get the tileMapID
    *
    * @return tileMapID
    */
    public int getTileMapID() {
        return tileMapID;
    }

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

   /** To set the worldMapID.
    *
    * @param worldMapID
    */
    public void setWorldMapID( int worldMapID ) {
        this.worldMapID = worldMapID;
    }

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

   /** To set the townMapID.
    *
    * @param townMapID
    */
    public void setTownMapID( int townMapID ) {
        this.townMapID = townMapID;
    }

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

   /** To set the buildingID.
    *
    * @param buildingID
    */
    public void setBuildingID( int buildingID ) {
        this.buildingID = buildingID;
    }

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

   /** To set the interiorMapID.
    *
    * @param interiorMapID
    */
    public void setInteriorMapID( int interiorMapID ) {
        this.interiorMapID = interiorMapID;
    }

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

   /** To set the roomID.
    *
    * @param roomID
    */
    public void setRoomID( int roomID ) {
        this.roomID = roomID;
    }

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

   /** To set the tileMapID.
    *
    * @param tileMapID
    */
    public void setTileMapID( int tileMapID ) {
        this.tileMapID = tileMapID;
    }

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

   /** Does this location points out a Town ?
    *
    * @return true if it points out a town.
    */
    public boolean isTown() {
        if( (townMapID>=0) && (buildingID<0) )
            return true;
       return false;
    }

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

   /** Does this location points out a World ?
    *
    * @return true if it points out a world.
    */
    public boolean isWorld() {
        if( townMapID<0 && tileMapID<0)
            return true;
       return false;
    }

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

   /** Does this location points out a Room ?
    *
    * @return true if it points out a room.
    */
    public boolean isRoom() {
        if( buildingID>=0 && townMapID>=0 )
            return true;
       return false;
    }

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

   /** Does this location points out a TileMap?
    *
    * @return true if it points out a tilemap.
    */
    public boolean isTileMap() {
        if( tileMapID>=0 )
            return true;
       return false;
    }

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

   /** Are this location equal to our ?
    * @param other other location
    * @return true if they are equal...
    */
    public boolean equals( WotlasLocation other ) {
        if( isRoom() ) {
           if( worldMapID == other.getWorldMapID() &&
               townMapID == other.getTownMapID() &&
               buildingID == other.getBuildingID() &&
               interiorMapID == other.getInteriorMapID() &&
               roomID == other.getRoomID() )
             return true;
           return false;
        }
        else if( isTown() ) {
           if( other.isTown() && 
               worldMapID == other.getWorldMapID() &&
               townMapID == other.getTownMapID() )
             return true;
           return false;
        }
        else if( isWorld() ) {
           if( other.isWorld() && 
               worldMapID == other.getWorldMapID() )
             return true;
        }
        else if( isTileMap() ) {
           if( other.isTileMap() && 
               tileMapID == other.getTileMapID() )
             return true;
        }

       return false; // we should never arrive here
    }

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

  /** String Info.
   */
    public String toString(){      
       if( isRoom() )
         return "Room: w" + worldMapID + ", t" + townMapID + ", b" + buildingID + ", i" + interiorMapID + ", r" + roomID;
       else if ( isTown() )
         return "Town: w" + worldMapID + ", t" + townMapID;
       else if ( isWorld() )
         return "World: w" + worldMapID;
       else if ( isTileMap() )
         return "TileMap: w" + worldMapID + ", tm=" + tileMapID;
       else
         return "Bad WotlasLocation: w"+worldMapID;
    }

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

  /** id version of data, used in serialized persistance.
   */
    public int ExternalizeGetVersion(){
        return 1;
    }

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

  /** write object data with serialize.
   */
    public void writeExternal(java.io.ObjectOutput objectOutput)
    throws java.io.IOException {
        objectOutput.writeInt( ExternalizeGetVersion() );
        objectOutput.writeInt( worldMapID );
        objectOutput.writeInt( tileMapID );
        objectOutput.writeInt( townMapID );
        objectOutput.writeInt( roomID );
        objectOutput.writeInt( interiorMapID  );
        objectOutput.writeInt( buildingID );
    }
    
 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -*/

  /** read object data with serialize.
   */
    public void readExternal(java.io.ObjectInput objectInput)
    throws java.io.IOException, java.lang.ClassNotFoundException {
        int IdTmp = objectInput.readInt();
        if( IdTmp == ExternalizeGetVersion() ){
           worldMapID  = objectInput.readInt();
           tileMapID  = objectInput.readInt();
           townMapID  = objectInput.readInt();
           roomID   = objectInput.readInt();
           interiorMapID  = objectInput.readInt();
           buildingID  = objectInput.readInt();
       } else {
            // to do.... when new version
        }
    }
}