com.planet_ink.coffee_mud.core.interfaces
Interface Places

All Superinterfaces:
Affectable, Behavable, java.lang.Cloneable, CMObject, java.lang.Comparable<CMObject>, Contingent, Environmental, Modifiable, MsgListener, Physical, PhysicalAgent, StatsAffecting, Tickable
All Known Subinterfaces:
Area, AutoGenArea, GridLocale, LocationRoom, Room
All Known Implementing Classes:
CaveGrid, CaveMaze, CaveRoom, CaveSurface, CityStreet, ClimbableLedge, ClimbableSurface, Desert, DesertGrid, DesertMaze, DesertThinGrid, EndlessOcean, EndlessSky, EndlessThinOcean, EndlessThinSky, FrozenMountains, FrozenPlains, GreatLake, GreatThinLake, HideoutShelter, Hills, HillsGrid, HillsThinGrid, HotRoom, IcePlains, IceRoom, IndoorInTheAir, IndoorShallowWater, IndoorUnderWater, IndoorUnderWaterColumnGrid, IndoorUnderWaterGrid, IndoorUnderWaterThinGrid, IndoorWaterSurface, IndoorWaterSurfaceColumn, IndoorWaterThinSurface, InTheAir, Jungle, JungleGrid, JungleThinGrid, LargeCaveRoom, LargeStoneRoom, LargeWoodRoom, LongerRoad, LongestRoad, LongRoad, MagicFreeRoom, MagicShelter, MetalRoom, MetalRoomMaze, Moon, Mountains, MountainsGrid, MountainsMaze, MountainsThinGrid, MountainSurface, MountainSurfaceGrid, MountainSurfaceThinGrid, OceanGrid, OceanThinGrid, OverTheLedge, Plains, PlainsGrid, PlainsThinGrid, Planet, Road, RoadGrid, RoadThinGrid, SaltWaterSurface, SaltWaterSurfaceColumn, SaltWaterThinSurface, SeaPort, SewerMaze, SewerRoom, ShallowWater, Shore, SpacePort, StdArea, StdAutoGenInstance, StdBoardableShip, StdGrid, StdGridArea, StdMaze, StdPlanet, StdRoom, StdSpaceShip, StdThinArea, StdThinGrid, StdThinGridArea, StdThinInstance, StdThinPlanet, StdTimeZone, StoneGrid, StoneMaze, StoneRoom, StoneThinGrid, SubThinInstance, Swamp, SwampGrid, SwampThinGrid, ThinRoom, TreeSurface, UnderSaltWater, UnderSaltWaterColumnGrid, UnderSaltWaterGrid, UnderSaltWaterMaze, UnderSaltWaterThinGrid, UnderWater, UnderWaterColumnGrid, UnderWaterGrid, UnderWaterMaze, UnderWaterThinGrid, WaterSurface, WaterSurfaceColumn, WaterThinSurface, WetCaveGrid, WetCaveMaze, WetCaveRoom, Whirlpool, WoodenDeck, WoodRoom, WoodRoomGrid, WoodRoomMaze, WoodRoomThinGrid, Woods, WoodsGrid, WoodsMaze, WoodsThinGrid

public interface Places
extends PhysicalAgent

A place where people might be, can be either abstract (like an area), or concrete (like a Room)


Field Summary
static int ALL_CLIMATE_MASK
          Bitmap climate flag meaning that the area has all weather modifiers.
static int ATMOSPHERE_INHERIT
          a constant code for getAtmosphereCode() that denotes that the atmo is inherited from a parent
static int CLIMASK_COLD
          Bitmap climate flag meaning that the area has cold weather.
static int CLIMASK_DRY
          Bitmap climate flag meaning that the area has dry weather.
static int CLIMASK_HOT
          Bitmap climate flag meaning that the area has hot weather.
static int CLIMASK_INHERIT
          Bitmap climate flag meaning that the area has inherited weather.
static int CLIMASK_NORMAL
          Bitmap climate flag meaning that the area has normal weather.
static int CLIMASK_WET
          Bitmap climate flag meaning that the area has wet weather.
static int CLIMASK_WINDY
          Bitmap climate flag meaning that the area has windy weather.
static java.lang.String[] CLIMATE_DESCS
          Indexed description of the CLIMASK_ bitmap constants in all possible combinations.
static int NUM_CLIMATES
          Number of CLIMASK_ constants.
 
Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.Tickable
STATUS_AFFECT, STATUS_ALIVE, STATUS_BEHAVIOR, STATUS_CLASS, STATUS_DEAD, STATUS_END, STATUS_FIGHT, STATUS_MISC, STATUS_MISC2, STATUS_MISC3, STATUS_MISC4, STATUS_MISC5, STATUS_MISC6, STATUS_MISC7, STATUS_NOT, STATUS_OTHER, STATUS_RACE, STATUS_REBIRTH, STATUS_SCRIPT, STATUS_START, STATUS_WEATHER, TICKID_AREA, TICKID_BEAMWEAPON, TICKID_CLAN, TICKID_CLANITEM, TICKID_DEADBODY_DECAY, TICKID_ELECTRONICS, TICKID_EMAIL, TICKID_EXIT_BEHAVIOR, TICKID_EXIT_REOPEN, TICKID_ITEM_BEHAVIOR, TICKID_ITEM_BOUNCEBACK, TICKID_LIGHT_FLICKERS, TICKID_LIVEAUCTION, TICKID_LONGERMASK, TICKID_MISCELLANEOUS, TICKID_MOB, TICKID_PROPERTY_SPECIAL, TICKID_QUEST, TICKID_READYTOSTOP, TICKID_ROOM_BEHAVIOR, TICKID_ROOM_ITEM_REJUV, TICKID_SOLITARYMASK, TICKID_SPECIALCOMBAT, TICKID_SPECIALMANEUVER, TICKID_SPELL_AFFECT, TICKID_SUPPORT, TICKID_TIMEAUCTION, TICKID_TRAP_DESTRUCTION, TICKID_TRAP_RESET
 
Method Summary
 int getAtmosphere()
          Returns the resource that represents the atmosphere of this area.
 int getAtmosphereCode()
          Returns the resource (or -1) that represents the atmosphere of this area.
 int getClimateType()
          Returns a bitmap of the climate for this place.
 int getClimateTypeCode()
          Returns a bitmap of climate flags for this area which will be used to influence the weather for the area in addition to season and other factors.
 void setAtmosphere(int resourceCode)
          Sets the resource (or -1) that represents the atmosphere of this area.
 void setClimateType(int newClimateType)
          Returns a bitmap of climate flags for this area which will be used to influence the weather for the area in addition to season and other factors.
 
Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Physical
description, displayText, name
 
Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Environmental
description, displayText, expirationDate, image, isGeneric, L, maxRange, minRange, miscTextFormat, Name, rawImage, sameAs, setDescription, setDisplayText, setExpirationDate, setImage, setMiscText, setName, text
 
Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Tickable
getTickStatus, name, tick
 
Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.StatsAffecting
affectCharState, affectCharStats, affectPhyStats
 
Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.MsgListener
executeMsg, okMessage
 
Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Contingent
amDestroyed, destroy, isSavable, setSavable
 
Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject
copyOf, ID, initializeClass, newInstance
 
Methods inherited from interface java.lang.Comparable
compareTo
 
Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Modifiable
getSaveStatIndex, getStat, getStatCodes, isStat, setStat
 
Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Affectable
addEffect, addNonUninvokableEffect, basePhyStats, delAllEffects, delEffect, eachEffect, effects, fetchEffect, fetchEffect, numEffects, phyStats, recoverPhyStats, setBasePhyStats
 
Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Behavable
addBehavior, addScript, behaviors, delAllBehaviors, delAllScripts, delBehavior, delScript, eachBehavior, eachScript, fetchBehavior, fetchBehavior, fetchScript, numBehaviors, numScripts, scripts
 

Field Detail

ATMOSPHERE_INHERIT

static final int ATMOSPHERE_INHERIT
a constant code for getAtmosphereCode() that denotes that the atmo is inherited from a parent

See Also:
Constant Field Values

CLIMASK_INHERIT

static final int CLIMASK_INHERIT
Bitmap climate flag meaning that the area has inherited weather. @see com.planet_ink.coffee_mud.core.interfaces.Places#climateType()

See Also:
Constant Field Values

CLIMASK_NORMAL

static final int CLIMASK_NORMAL
Bitmap climate flag meaning that the area has normal weather. @see com.planet_ink.coffee_mud.core.interfaces.Places#climateType()

See Also:
Constant Field Values

CLIMASK_WET

static final int CLIMASK_WET
Bitmap climate flag meaning that the area has wet weather. @see com.planet_ink.coffee_mud.core.interfaces.Places#climateType()

See Also:
Constant Field Values

CLIMASK_COLD

static final int CLIMASK_COLD
Bitmap climate flag meaning that the area has cold weather. @see com.planet_ink.coffee_mud.core.interfaces.Places#climateType()

See Also:
Constant Field Values

CLIMASK_WINDY

static final int CLIMASK_WINDY
Bitmap climate flag meaning that the area has windy weather. @see com.planet_ink.coffee_mud.core.interfaces.Places#climateType()

See Also:
Constant Field Values

CLIMASK_HOT

static final int CLIMASK_HOT
Bitmap climate flag meaning that the area has hot weather. @see com.planet_ink.coffee_mud.core.interfaces.Places#climateType()

See Also:
Constant Field Values

CLIMASK_DRY

static final int CLIMASK_DRY
Bitmap climate flag meaning that the area has dry weather. @see com.planet_ink.coffee_mud.core.interfaces.Places#climateType()

See Also:
Constant Field Values

CLIMATE_DESCS

static final java.lang.String[] CLIMATE_DESCS
Indexed description of the CLIMASK_ bitmap constants in all possible combinations.

See Also:
CLIMASK_NORMAL

NUM_CLIMATES

static final int NUM_CLIMATES
Number of CLIMASK_ constants. @see com.planet_ink.coffee_mud.core.interfaces.Places#climateType()

See Also:
Constant Field Values

ALL_CLIMATE_MASK

static final int ALL_CLIMATE_MASK
Bitmap climate flag meaning that the area has all weather modifiers. @see com.planet_ink.coffee_mud.core.interfaces.Places#climateType()

See Also:
Constant Field Values
Method Detail

getAtmosphereCode

int getAtmosphereCode()
Returns the resource (or -1) that represents the atmosphere of this area. Since most rooms inherit their atmosphere from the area, this is important. Return -1 to have this area inherit its atmosphere from parents (which would ultimately go back to RESOURCE_AIR)

Returns:
the RawMaterial resource, or -1
See Also:
RawMaterial.MATERIAL_GAS

getAtmosphere

int getAtmosphere()
Returns the resource that represents the atmosphere of this area. Since most rooms inherit their atmosphere from the area, this is important. Could have this area inherit its atmosphere from parents (which would ultimately go back to RESOURCE_AIR)

Returns:
the RawMaterial resource
See Also:
RawMaterial.MATERIAL_GAS

setAtmosphere

void setAtmosphere(int resourceCode)
Sets the resource (or -1) that represents the atmosphere of this area. Since most rooms inherit their atmosphere from the area, this is important. Return -1 to have this area inherit its atmosphere from parents (which would ultimately go back to RESOURCE_AIR)

Parameters:
resourceCode - the RawMaterial resource to use
See Also:
RawMaterial.MATERIAL_GAS

getClimateTypeCode

int getClimateTypeCode()
Returns a bitmap of climate flags for this area which will be used to influence the weather for the area in addition to season and other factors.

Returns:
a CLIMASK bitmap
See Also:
CLIMASK_COLD

setClimateType

void setClimateType(int newClimateType)
Returns a bitmap of climate flags for this area which will be used to influence the weather for the area in addition to season and other factors.

Parameters:
newClimateType - a CLIMASK bitmap
See Also:
CLIMASK_COLD

getClimateType

int getClimateType()
Returns a bitmap of the climate for this place. If the climate is CLIMASK_INHERIT, then it will look to parent objects, such as areas, and parent areas, until it eventually finds a non-inherit, or returns CLIMASK_NORMAL;

Returns:
a derived climate
See Also:
CLIMASK_COLD