com.planet_ink.coffee_mud.Areas.interfaces
Interface AutoGenArea

All Superinterfaces:

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

All Known Implementing Classes:

StdAutoGenInstance

public interface AutoGenArea
extends Area

AutoGenAreas are areas that utilize the random area generation system (percolator) to generate their rooms. As such, the common parameters for the auto gen system are herein exposed

Nested Class Summary

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

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

Field Summary

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

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, TIME_PASSIVE_LAPSE

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_WET, CLIMASK_WINDY, CLIMATE_DESCS, NUM_CLIMATES

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

java.util.Map<java.lang.String,java.lang.String>	getAutoGenVariables() Get a miscellaneous, xml-specific set of other vars to set when generating a new area
java.lang.String	getGeneratorXmlPath() Get the path to the xml file to use to generate this areas rooms
void	setAutoGenVariables(java.util.Map<java.lang.String,java.lang.String> vars) Set a miscellaneous, xml-specific set of other vars to set when generating a new area
void	setAutoGenVariables(java.lang.String vars) Set a miscellaneous, xml-specific set of other vars to set when generating a new area.
void	setGeneratorXmlPath(java.lang.String path) Set the path to the xml file to use to generate this areas rooms

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

addBlurbFlag, addChild, addMetroRoom, addMetroRoomnumber, addParent, addProperRoom, addProperRoomnumber, addSubOp, amISubOp, areaBlurbFlags, canChild, canParent, delBlurbFlag, delMetroRoom, delMetroRoomnumber, delProperRoom, delProperRoomnumber, delSubOp, fillInAreaRoom, fillInAreaRooms, flags, getArchivePath, getAreaIStats, getAreaState, getAreaStats, getAuthorID, getBlurbFlag, getCachedRoomnumbers, getChild, getChildren, getClimateObj, getCompleteMap, getCurrency, getFilledCompleteMap, getFilledProperMap, getMetroMap, getNewRoomID, getParent, getParents, getParentsRecurse, getPlayerLevel, getProperMap, getProperRoomnumbers, getRandomMetroRoom, getRandomProperRoom, getRoom, getSubOpList, getTheme, getThemeCode, getTimeObj, inMyMetroArea, isChild, isChild, isParent, isParent, isProperlyEmpty, isRoom, metroSize, numAllBlurbFlags, numberOfProperIDedRooms, numBlurbFlags, properSize, removeChild, removeParent, setArchivePath, setAreaState, setAuthorID, setClimateObj, setCurrency, setPlayerLevel, setProperRoomnumbers, setSubOpList, setTheme, setTimeObj, subOps

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Economics

budget, devalueRate, finalBudget, finalDevalueRate, finalIgnoreMask, finalInvResetRate, finalItemPricingAdjustments, finalPrejudiceFactors, ignoreMask, invResetRate, itemPricingAdjustments, prejudiceFactors, setBudget, setDevalueRate, setIgnoreMask, setInvResetRate, setItemPricingAdjustments, setPrejudiceFactors

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

getAtmosphere, getAtmosphereCode, getClimateType, getClimateTypeCode, setAtmosphere, setClimateType

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

Method Detail

getGeneratorXmlPath

java.lang.String getGeneratorXmlPath()

Get the path to the xml file to use to generate this areas rooms

Returns:

the path

setGeneratorXmlPath

void setGeneratorXmlPath(java.lang.String path)

Set the path to the xml file to use to generate this areas rooms

Parameters:

path - the resource path

getAutoGenVariables

java.util.Map<java.lang.String,java.lang.String> getAutoGenVariables()

Get a miscellaneous, xml-specific set of other vars to set when generating a new area

Returns:

the variable mappings

setAutoGenVariables

void setAutoGenVariables(java.util.Map<java.lang.String,java.lang.String> vars)

Set a miscellaneous, xml-specific set of other vars to set when generating a new area

Parameters:

vars - the variable mappings

setAutoGenVariables

void setAutoGenVariables(java.lang.String vars)

Set a miscellaneous, xml-specific set of other vars to set when generating a new area. Format is VAR=VALUE VAR2="VALUE"

Parameters:

vars - the variable mappings