tempusmud.carto.map
Class Room

java.lang.Object
  |
  +--tempusmud.carto.map.Room

public final class Room
extends java.lang.Object
implements MapElement, java.io.Serializable

See Also:
Serialized Form

Field Summary
 CartoTextEditor.Editable _descEditable
           
 CartoTextEditor.Editable _soundEditable
           
static long serialVersionUID
           
 
Fields inherited from interface tempusmud.carto.map.RoomConstantsI
dirExtentMods, dirOffsets, DOOR_CLOSED, DOOR_HIDDEN, DOOR_LOCKED, DOOR_OPEN, DOWN, EAST, EX_CLOSED, EX_HARD_PICK, EX_HEAVY_DOOR, EX_HIDDEN, EX_ISDOOR, EX_LOCKED, EX_NOMOB, EX_NOPASS, EX_NOSCAN, EX_ONEWAY, EX_PICKPROOF, EX_REINFORCED, EX_SECRET, EX_SPECIAL, EX_TECH, EX_WALL_ENERGY_F, EX_WALL_ENERGY_F_NOPASS, EX_WALL_FIRE, EX_WALL_FIRE_NOPASS, EX_WALL_FLESH, EX_WALL_FORCE, EX_WALL_ICE, EX_WALL_IRON, EX_WALL_STONE, EX_WALL_THORNS, EX_WALL_THORNS_NOPASS, F_TYPE_CONDUIT, F_TYPE_CONVEYOR, F_TYPE_ELEMENTAL_WIND, F_TYPE_ESCALATOR, F_TYPE_FALLING, F_TYPE_LAVA_FLOW, F_TYPE_NONE, F_TYPE_QUICKSAND, F_TYPE_RIVER_FIRE, F_TYPE_RIVER_SURFACE, F_TYPE_ROTATING_DISC, F_TYPE_SINKING_SWAMP, F_TYPE_UNDERWATER, F_TYPE_UNSEEN_FORCE, F_TYPE_VOLC_UPDRAFT, F_TYPE_WATER_VORTEX, F_TYPE_WIND, NORTH, NUM_DIRS, NUM_DOORFLAGS, NUM_FLOW_TYPES, NUM_ROOM_FLAGS, NUM_SECTOR_TYPES, revdirs, ROOM_ARENA, ROOM_ATRIUM, ROOM_BFS_MARK, ROOM_CLAN_HOUSE, ROOM_DARK, ROOM_DEATH, ROOM_DOCK, ROOM_EXPLOSIVE_GAS, ROOM_FLAME_FILLED, ROOM_GODROOM, ROOM_HOLYOCEAN, ROOM_HOUSE, ROOM_HOUSE_CRASH, ROOM_ICE_COLD, ROOM_INDOORS, ROOM_NOMAGIC, ROOM_NOMOB, ROOM_NOPHYSIC, ROOM_NOPSIONICS, ROOM_NORECALL, ROOM_NOSCIENCE, ROOM_NOTEL, ROOM_NOTRACK, ROOM_NULL_MAGIC, ROOM_PEACEFUL, ROOM_POISON_GAS, ROOM_RADIOACTIVE, ROOM_SLEEP_GAS, ROOM_SMOKE_FILLED, ROOM_SOUNDPROOF, ROOM_TUNNEL, ROOM_VACUUM, SECT_ASTRAL, SECT_BEACH, SECT_CITY, SECT_CLIMBING, SECT_CORNFIELD, SECT_DESERT, SECT_ELEMENTAL_AIR, SECT_ELEMENTAL_ASH, SECT_ELEMENTAL_DUST, SECT_ELEMENTAL_EARTH, SECT_ELEMENTAL_FIRE, SECT_ELEMENTAL_ICE, SECT_ELEMENTAL_LIGHTNING, SECT_ELEMENTAL_MAGMA, SECT_ELEMENTAL_MINERALS, SECT_ELEMENTAL_NEGATIVE, SECT_ELEMENTAL_OOZE, SECT_ELEMENTAL_POSITIVE, SECT_ELEMENTAL_RADIANCE, SECT_ELEMENTAL_SALT, SECT_ELEMENTAL_SMOKE, SECT_ELEMENTAL_STEAM, SECT_ELEMENTAL_VACUUM, SECT_ELEMENTAL_WATER, SECT_FIELD, SECT_FIRE_RIVER, SECT_FLYING, SECT_FOREST, SECT_FREESPACE, SECT_HILLS, SECT_INSIDE, SECT_JUNGLE, SECT_MOUNTAIN, SECT_NOTIME, SECT_PITCH_PIT, SECT_PITCH_SUB, SECT_ROAD, SECT_SWAMP, SECT_UNDERWATER, SECT_VEHICLE, SECT_WATER_NOSWIM, SECT_WATER_SWIM, sectorColors, SOUTH, UP, WEST
 
Constructor Summary
protected Room()
           
  Room(int x, int y)
          constructor
 
Method Summary
 void copy(Room room)
          copy an existing room.
 Exit createExit(int dir)
           
 boolean destroyExit(int dir)
           
 boolean exportMudCommands(java.io.Writer w)
           
 java.awt.Rectangle getBoundingRect()
          get a bounding rect for the room that includes all Link Vertexes
 java.lang.StringBuffer getDesc()
           
 int getDirNum(Exit exit)
           
 Exit getExit(int dir)
           
 Room getExitRoom(int dir)
           
 Exit[] getExits()
           
 int getFlags()
           
 int getFlowDir()
           
 int getFlowSpeed()
           
 int getFlowType()
           
 CartoMap getMap()
           
 java.lang.String getName()
           
 java.awt.Point getPos()
           
 int getSectorType()
           
 java.lang.StringBuffer getSound()
           
 int getVnum()
           
 Exit link(Room room, int dir)
          Connect this room to another
 boolean ownsVertex(Vertex vert)
           
(package private)  Room[] removeExits()
          package visibility used by the CartoMap when removing a room
 void removeFlagBit(int bit)
           
 void setFlagBit(int bit)
           
 void setFlowDir(int t)
           
 void setFlowSpeed(int t)
           
 void setFlowType(int t)
           
(package private)  void setMap(CartoMap map)
           
 void setName(java.lang.String s)
           
 void setPos(java.awt.Point p)
           
 void setSector(int i)
           
(package private)  boolean setupLinks(boolean[] exitsToLink)
          construct all the links leading from exits of this room.
 void setVnum(int vnum)
           
 java.lang.String toString()
           
 boolean unlink(int dir)
          Disconnect this room from anything in the given direction
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

serialVersionUID

public static final long serialVersionUID

_descEditable

public CartoTextEditor.Editable _descEditable

_soundEditable

public CartoTextEditor.Editable _soundEditable
Constructor Detail

Room

protected Room()

Room

public Room(int x,
            int y)
constructor
Method Detail

copy

public void copy(Room room)
copy an existing room. good for the 'clone/mimic' operation

link

public Exit link(Room room,
                 int dir)
Connect this room to another
Returns:
the exit from this room

unlink

public boolean unlink(int dir)
Disconnect this room from anything in the given direction

removeExits

Room[] removeExits()
package visibility used by the CartoMap when removing a room

getPos

public final java.awt.Point getPos()
Specified by:
getPos in interface MapElement

getExits

public final Exit[] getExits()

getExit

public final Exit getExit(int dir)

getExitRoom

public final Room getExitRoom(int dir)

getDesc

public final java.lang.StringBuffer getDesc()

getSound

public final java.lang.StringBuffer getSound()

getVnum

public final int getVnum()

setVnum

public final void setVnum(int vnum)

getFlags

public final int getFlags()

getSectorType

public final int getSectorType()

getFlowDir

public final int getFlowDir()

getFlowSpeed

public final int getFlowSpeed()

getFlowType

public final int getFlowType()

getName

public final java.lang.String getName()

getMap

public final CartoMap getMap()

createExit

public final Exit createExit(int dir)

destroyExit

public final boolean destroyExit(int dir)

setMap

final void setMap(CartoMap map)

setName

public void setName(java.lang.String s)

setSector

public void setSector(int i)

setFlagBit

public void setFlagBit(int bit)

setFlowType

public void setFlowType(int t)

setFlowDir

public void setFlowDir(int t)

setFlowSpeed

public void setFlowSpeed(int t)

setPos

public void setPos(java.awt.Point p)

removeFlagBit

public void removeFlagBit(int bit)

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

getDirNum

public int getDirNum(Exit exit)

setupLinks

boolean setupLinks(boolean[] exitsToLink)
construct all the links leading from exits of this room. it is assumed that any existing links associated with the exits are NOT attached to the CartoMap map matrix! if setupLinks succeeds, all Links will be created and added to the map matrix if it fails, no Links will be created or added to the map matrix
Parameters:
exitsToLink - each true array element indicates to link that exit. if exitsToLink is null, link them all. array length must be == 6

exportMudCommands

public boolean exportMudCommands(java.io.Writer w)
                          throws java.io.IOException

ownsVertex

public boolean ownsVertex(Vertex vert)

getBoundingRect

public java.awt.Rectangle getBoundingRect()
get a bounding rect for the room that includes all Link Vertexes


Last modified: Sun Jan 30, 20:15 EST