Package com.planet_ink.coffee_mud.Areas

Class StdThinArea

java.lang.Object

com.planet_ink.coffee_mud.Areas.StdArea

com.planet_ink.coffee_mud.Areas.StdThinArea

All Implemented Interfaces:

Area, Affectable, Behavable, CMObject, Contingent, Economics, Environmental, Expireable, Modifiable, MsgListener, Physical, PhysicalAgent, Places, StatsAffecting, Tickable, java.lang.Cloneable, java.lang.Comparable<CMObject>

Direct Known Subclasses:

StdThinInstance, StdThinPlanet

public class StdThinArea
extends StdArea

Nested Class Summary

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.Areas.interfaces.Area

Area.CompleteRoomEnumerator, Area.RoomComparator, Area.RoomIDComparator, Area.RoomIDEnumerator, Area.State, Area.Stats

Nested classes/interfaces inherited from class com.planet_ink.coffee_mud.Areas.StdArea

StdArea.AreaInstanceChild, StdArea.IStatContext

Field Summary

Fields inherited from interface com.planet_ink.coffee_mud.Areas.interfaces.Area

DEFAULT_TIME_PASSIVE_LAPSE, FLAG_INSTANCE_CHILD, FLAG_INSTANCE_PARENT, FLAG_THIN, THEME_ALLTHEMES, THEME_BIT_NAMES, THEME_FANTASY, THEME_HEROIC, THEME_INHERIT, THEME_NAMES, THEME_PHRASE, THEME_PHRASE_EXT, THEME_SKILLONLYMASK, THEME_TECHNOLOGY

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

idConverter

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.Places

ALL_CLIMATE_MASK, ATMOSPHERE_INHERIT, CLIMASK_COLD, CLIMASK_DRY, CLIMASK_HOT, CLIMASK_INHERIT, CLIMASK_NORMAL, CLIMASK_VOID, CLIMASK_WET, CLIMASK_WINDY, CLIMATE_DESCS, NUM_CLIMATES, placeComparator

Fields inherited from class com.planet_ink.coffee_mud.Areas.StdArea

_name, affects, amDestroyed, archPath, atmosphere, author, basePhyStats, behaviors, blurbFlags, budget, children, climask, climateObj, currency, derivedAtmo, derivedClimate, derivedTheme, description, devalueRate, empty, emptyPiety, emptyStats, expirationDate, flag, ignoreMask, imageName, invResetRate, itemPricingAdjs, lastComplainer, lastPlayerTime, me, metroRoomIDSet, miscText, myClock, parents, passiveLapseMs, phyStats, playerLevel, prejudiceFactors, properRoomIDSet, properRooms, roomComparator, scripts, STDAREACODES, subOps, theme, threadId, tickStatus, xtraValues

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_BALLISTICK, TICKID_CLAN, TICKID_CLANITEM, TICKID_DEADBODY_DECAY, TICKID_ELECTRONICS, TICKID_EMAIL, TICKID_EVENT, 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_SHORTERMASK, TICKID_SOLITARYMASK, TICKID_SPECIALCOMBAT, TICKID_SPECIALMANEUVER, TICKID_SPELL_AFFECT, TICKID_SUPPORT, TICKID_TIMEAUCTION, TICKID_TRAP_DESTRUCTION, TICKID_TRAP_RESET

Constructor Summary

Constructors

Constructor	Description
StdThinArea()

Method Summary

Modifier and Type	Method	Description
void	addProperRoom(Room R)	This method adds a new Room to this area.
long	flags()	Return basic attributed flag about the area.
int[]	getAreaIStats()	Returns an integer array of statistics about this area based on a snapshot generated the first time it is called.
java.util.Enumeration<Room>	getCompleteMap()	This method is the same as getProperMap, except that it will load any Rooms that belong to the area but have not yet been loaded.
java.util.Enumeration<Room>	getMetroMap()	Returns an enumerator for all previously loaded rooms that properly belongs to this area AND to any child areas.
int	getPercentRoomsCached()
java.util.Enumeration<Room>	getProperMap()	Returns an enumerator for all previously loaded rooms that properly belongs to this area.
Room	getProperRoom(java.lang.String roomID)
Room	getRandomProperRoom()	Returns a random room from this area, loading it if necessary.
Room	getRoom(java.lang.String roomID)	Returns a room of the given roomID, if it has already been added by calling addProperRoom.
java.lang.String	ID()	The CoffeeMud Java Class ID shared by all instances of this object.
boolean	isRoom(Room R)	Returns whether the given Room object belongs to this Area, even if the Room object properly has not been loaded yet (due to the area being thin).
boolean	isRoom(java.lang.String roomID)
boolean	isRoomCached(java.lang.String roomID)	Returns whether the given room id object belongs to this Area, and has been loaded into the memory cache.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from class com.planet_ink.coffee_mud.Areas.StdArea

addBehavior, addBlurbFlag, addChild, addEffect, addMetroRoom, addMetroRoomnumber, addNonUninvokableEffect, addParent, addProperRoomnumber, addScript, addSubOp, affectCharState, affectCharStats, affectPhyStats, amDestroyed, amISubOp, areaBlurbFlags, basePhyStats, behaviors, buildAreaIMobStats, buildAreaIStats, buildAreaPiety, buildAreaStats, canChild, canParent, cloneFix, compareTo, copyOf, delAllBehaviors, delAllEffects, delAllScripts, delBehavior, delBlurbFlag, delEffect, delMetroRoom, delMetroRoomnumber, delProperRoom, delProperRoomnumber, delScript, delSubOp, description, description, destroy, displayText, displayText, eachBehavior, eachEffect, eachScript, effects, executeMsg, expirationDate, fetchBehavior, fetchBehavior, fetchEffect, fetchEffect, fetchScript, fillInAreaRoom, fillInAreaRooms, finalAreaBudget, finalAreaDevalueRate, finalCurrency, finalIgnoreMask, finalInvResetRate, finalItemPricingAdjustments, finalPrejudiceFactors, genericName, getArchivePath, getAreaState, getAreaStats, getAtmosphere, getAtmosphereCode, getAuthorID, getBlurbFlag, getCachedRoomnumbers, getChild, getChildren, getChildrenIterator, getChildrenReverseIterator, getClimateObj, getClimateType, getClimateTypeCode, getCodeNum, getFilledCompleteMap, getFilledProperMap, getFinalBudget, getFinalCurrency, getFinalDevalueRate, getFinalIgnoreMask, getFinalInvResetRate, getFinalItemPricingAdjustments, getFinalPrejudiceFactors, getNewRoomID, getParent, getParents, getParentsIterator, getParentsRecurse, getParentsReverseIterator, getPiety, getPiety, getPlayerLevel, getProperRoomnumbers, getRandomMetroRoom, getRawBbudget, getRawCurrency, getRawDevalueRate, getRawIgnoreMask, getRawInvResetRate, getRawItemPricingAdjustments, getRawPrejudiceFactors, getRoomBase, getSaveStatIndex, getStat, getStatCodes, getSubOpList, getTheme, getThemeCode, getTickStatus, getTimeObj, image, initializeClass, inMyMetroArea, isAreaLocation, isChild, isChild, isChildRecurse, isGeneric, isParent, isParent, isParentRecurse, isProperlyEmpty, isRoomID, isSavable, isStat, L, loadAreas, maxRange, metroSize, minRange, miscTextFormat, name, name, Name, newInstance, numAllBlurbFlags, numBehaviors, numberOfProperIDedRooms, numBlurbFlags, numEffects, numScripts, okMessage, phyStats, properSize, rawImage, recoverPhyStats, removeChild, removeParent, sameAs, scripts, setArchivePath, setAreaState, setAtmosphere, setAuthorID, setBasePhyStats, setBudget, setClimateObj, setClimateType, setCurrency, setDescription, setDevalueRate, setDisplayText, setExpirationDate, setIgnoreMask, setImage, setInvResetRate, setItemPricingAdjustments, setMiscText, setName, setPlayerLevel, setPrejudiceFactors, setProperRoomnumbers, setSavable, setStat, setSubOpList, setTheme, setTimeObj, subOps, text, tick

Constructor Detail

StdThinArea

public StdThinArea()

Method Detail

ID

public java.lang.String ID()

Description copied from interface: CMObject

The CoffeeMud Java Class ID shared by all instances of this object. Unlike the Java Class name, this method does not include package information. However, it must return a String value unique to its class category in the ClassLoader. Class categories include Libraries, Common, Areas, Abilities, Behaviors, CharClasses, Commands, Exits Locales, MOBS, Races, WebMacros, Basic Items, Armor, Weapons, ClanItems, Tech. The name is typically identical to the class name.

Specified by:

ID in interface CMObject

Overrides:

ID in class StdArea

Returns:

the name of this class

flags

public long flags()

Description copied from interface: Area

Return basic attributed flag about the area.

Specified by:

flags in interface Area

Overrides:

flags in class StdArea

Returns:

either 0, or a bitmap of FLAG_ constants

See Also:

Area.FLAG_THIN

addProperRoom

public void addProperRoom(Room R)

Description copied from interface: Area

This method adds a new Room to this area. It is called by the Room.setArea( method, and should rarely if ever be called directly. It calls addMetroRoom on all parent areas to make them aware of it as well.

Specified by:

addProperRoom in interface Area

Overrides:

addProperRoom in class StdArea

Parameters:

R - the Room to add.

See Also:

Area.addMetroRoom(Room), Room

getProperRoom

public Room getProperRoom(java.lang.String roomID)

getPercentRoomsCached

public int getPercentRoomsCached()

Overrides:

getPercentRoomsCached in class StdArea

getAreaIStats

public int[] getAreaIStats()

Description copied from interface: Area

Returns an integer array of statistics about this area based on a snapshot generated the first time it is called. This array is the cached for future calls, but can be unloaded from resources using the UNLOAD command, to force a re-generation. The array is dereferenced using AREASTAT_ constants.

Specified by:

getAreaIStats in interface Area

Overrides:

getAreaIStats in class StdArea

Returns:

an array of integer statistics

See Also:

Area.Stats

getRoom

public Room getRoom(java.lang.String roomID)

Description copied from interface: Area

Returns a room of the given roomID, if it has already been added by calling addProperRoom. If this area is Thin, this will load the room from the database and cache it.

Specified by:

getRoom in interface Area

Overrides:

getRoom in class StdArea

Parameters:

roomID - the roomID of the room to return.

Returns:

a reference to the room that the id refers to, IF the room belongs here.

See Also:

Room

isRoomCached

public boolean isRoomCached(java.lang.String roomID)

Description copied from interface: Area

Returns whether the given room id object belongs to this Area, and has been loaded into the memory cache.

Specified by:

isRoomCached in interface Area

Overrides:

isRoomCached in class StdArea

Parameters:

roomID - the Room id to check for

Returns:

whether it belongs to this Area or no, and is cached

See Also:

Room

getRandomProperRoom

public Room getRandomProperRoom()

Description copied from interface: Area

Returns a random room from this area, loading it if necessary.

Specified by:

getRandomProperRoom in interface Area

Overrides:

getRandomProperRoom in class StdArea

Returns:

a reference to a random room from this area.

See Also:

Room

getProperMap

public java.util.Enumeration<Room> getProperMap()

Description copied from interface: Area

Returns an enumerator for all previously loaded rooms that properly belongs to this area.

Specified by:

getProperMap in interface Area

Overrides:

getProperMap in class StdArea

Returns:

an enumerator of Room objects

See Also:

Area.getCompleteMap(), Room

isRoom

public boolean isRoom(java.lang.String roomID)

isRoom

public boolean isRoom(Room R)

Description copied from interface: Area

Returns whether the given Room object belongs to this Area, even if the Room object properly has not been loaded yet (due to the area being thin).

Specified by:

isRoom in interface Area

Overrides:

isRoom in class StdArea

Parameters:

R - the Room object to check for

Returns:

whether it belongs to this Area or no.

See Also:

Room

getCompleteMap

public java.util.Enumeration<Room> getCompleteMap()

Description copied from interface: Area

This method is the same as getProperMap, except that it will load any Rooms that belong to the area but have not yet been loaded. The Enumerator returned is thus a more complete set than returned by getProperMap

Specified by:

getCompleteMap in interface Area

Overrides:

getCompleteMap in class StdArea

Returns:

an enumerator of Room objects

See Also:

Area.getProperMap(), Room

getMetroMap

public java.util.Enumeration<Room> getMetroMap()

Description copied from interface: Area

Returns an enumerator for all previously loaded rooms that properly belongs to this area AND to any child areas.

Specified by:

getMetroMap in interface Area

Overrides:

getMetroMap in class StdArea

Returns:

an enumerator of Room objects

See Also:

Room