com.planet_ink.coffee_mud.Areas
Class StdPlanet

java.lang.Object
  com.planet_ink.coffee_mud.Areas.StdArea
      com.planet_ink.coffee_mud.Areas.StdTimeZone
          com.planet_ink.coffee_mud.Areas.StdPlanet

All Implemented Interfaces:

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

public class StdPlanet
extends StdTimeZone
implements SpaceObject

Nested Class Summary

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.core.interfaces.SpaceObject

SpaceObject.Distance

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.core.interfaces.BoundedObject

BoundedObject.BoundedCube

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

protected long[]	coordinates
protected static double[]	emptyDirection
protected long	radius

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

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

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

ACCELERATION_DAMAGED, ACCELERATION_G, ACCELERATION_INSTANTDEATH, ACCELERATION_PASSOUT, ACCELERATION_TYPICALROCKET, ACCELERATION_TYPICALSPACEROCKET, ACCELERATION_UNCONSCIOUSNESS, ASTEROID_MASS, ATMOSPHERIC_DRAG_BRICK, ATMOSPHERIC_DRAG_STREAMLINE, DISTANCES, MOONLET_MASS, MULTIPLIER_GRAVITY_EFFECT_RADIUS, MULTIPLIER_ORBITING_RADIUS_MAX, MULTIPLIER_ORBITING_RADIUS_MIN, MULTIPLIER_PLANET_MASS, MULTIPLIER_STAR_MASS, VELOCITY_ESCAPE, VELOCITY_LIGHT, VELOCITY_ORBITING, VELOCITY_SOUND, VELOCITY_SUBLIGHT, VELOCITY_TRANSWARP1, VELOCITY_TRANSWARP10, VELOCITY_TRANSWARP2, VELOCITY_TRANSWARP3, VELOCITY_TRANSWARP4, VELOCITY_TRANSWARP5, VELOCITY_TRANSWARP6, VELOCITY_TRANSWARP7, VELOCITY_TRANSWARP8, VELOCITY_TRANSWARP9, VELOCITY_WARP1, VELOCITY_WARP10, VELOCITY_WARP2, VELOCITY_WARP3, VELOCITY_WARP4, VELOCITY_WARP5, VELOCITY_WARP6, VELOCITY_WARP7, VELOCITY_WARP8, VELOCITY_WARP9

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

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

Constructor Summary

StdPlanet()

Method Summary

long[]	coordinates() The current absolute coordinates of the object
double[]	direction() The direction of travel of this object in radians.
BoundedObject.BoundedCube	getBounds()
protected int	getLocCodeNum(java.lang.String code)
long	getMass() Returns the mass of this object, derived from its radius and type, or perhaps from other things.
java.lang.String	getStat(java.lang.String code) An alternative means of retreiving the values of those fields on this object which are modifiable at run-time by builders.
java.lang.String[]	getStatCodes() Returns an array of the string names of those fields which are modifiable on this object at run-time by builders.
java.lang.String	ID() The CoffeeMud Java Class ID shared by all instances of this object.
SpaceObject	knownSource() The source object from which this space object is travelling from
SpaceObject	knownTarget() If this object is targeting another space object as a destination, this will return it
long	radius() The current radius of the object
void	setCoords(long[] coords) Sets the current absolute coordinates of the object
void	setDirection(double[] dir) Sets the direction of travel of this object in radians.
void	setKnownSource(SpaceObject O) Sets the source object from which this space object is travelling from
void	setKnownTarget(SpaceObject O) If this object is targeting another space object as a destination, this will set it
void	setName(java.lang.String newName) Sets the raw unmodified name of this object as stored in the database.
void	setRadius(long radius) Set the current radius of the object
void	setSpeed(double v) Sets the speed of the object through space
void	setStat(java.lang.String code, java.lang.String val) An alternative means of setting the values of those fields on this object which are modifiable at run-time by builders.
double	speed() The speed of the object through space

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

addChild, copyOf, getTimeObj

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

addBehavior, addBlurbFlag, addEffect, addMetroRoom, addMetroRoomnumber, addNonUninvokableEffect, addParent, addProperRoom, addProperRoomnumber, addScript, addSubOp, affectCharState, affectCharStats, affectPhyStats, amDestroyed, amISubOp, areaBlurbFlags, basePhyStats, behaviors, budget, buildAreaIMobStats, buildAreaIStats, buildAreaStats, canChild, canParent, cloneFix, compareTo, delAllBehaviors, delAllEffects, delAllScripts, delBehavior, delBlurbFlag, delEffect, delMetroRoom, delMetroRoomnumber, delProperRoom, delProperRoomnumber, delScript, delSubOp, description, description, destroy, devalueRate, displayText, displayText, eachBehavior, eachEffect, eachScript, effects, executeMsg, expirationDate, fetchBehavior, fetchBehavior, fetchEffect, fetchEffect, fetchScript, fillInAreaRoom, fillInAreaRooms, finalAreaBudget, finalAreaDevalueRate, finalBudget, finalDevalueRate, finalIgnoreMask, finalIgnoreMask, finalInvResetRate, finalInvResetRate, finalItemPricingAdjustments, finalItemPricingAdjustments, finalPrejudiceFactors, finalPrejudiceFactors, flags, getArchivePath, getAreaIStats, getAreaState, getAreaStats, getAtmosphere, getAtmosphereCode, getAuthorID, getBlurbFlag, getCachedRoomnumbers, getChild, getChildren, getChildrenIterator, getChildrenReverseIterator, getClimateObj, getClimateType, getClimateTypeCode, getCodeNum, getCompleteMap, getCurrency, getFilledCompleteMap, getFilledProperMap, getMetroMap, getNewRoomID, getParent, getParents, getParentsIterator, getParentsRecurse, getParentsReverseIterator, getPercentRoomsCached, getPlayerLevel, getProperMap, getProperRoomnumbers, getRandomMetroRoom, getRandomProperRoom, getRoom, getSaveStatIndex, getSubOpList, getTheme, getThemeCode, getTickStatus, ignoreMask, image, initializeClass, inMyMetroArea, invResetRate, isChild, isChild, isGeneric, isParent, isParent, isProperlyEmpty, isRoom, isSavable, isStat, itemPricingAdjustments, L, loadAreas, maxRange, metroSize, minRange, miscTextFormat, name, Name, name, newInstance, numAllBlurbFlags, numBehaviors, numberOfProperIDedRooms, numBlurbFlags, numEffects, numScripts, okMessage, phyStats, prejudiceFactors, 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, setPlayerLevel, setPrejudiceFactors, setProperRoomnumbers, setSavable, setSubOpList, setTheme, setTimeObj, subOps, text, tick

Methods inherited from class java.lang.Object

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

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, 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, initializeClass, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

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

getSaveStatIndex, isStat

Field Detail

emptyDirection

protected static double[] emptyDirection

coordinates

protected long[] coordinates

radius

protected long radius

Constructor Detail

StdPlanet

public StdPlanet()

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 StdTimeZone

Returns:

the name of this class

coordinates

public long[] coordinates()

Description copied from interface: SpaceObject

The current absolute coordinates of the object

Specified by:

coordinates in interface SpaceObject

Returns:

3 dimensional array of the coordinates

setCoords

public void setCoords(long[] coords)

Description copied from interface: SpaceObject

Sets the current absolute coordinates of the object

Specified by:

setCoords in interface SpaceObject

Parameters:

coords - 3 dimensional array of the coordinates in space

direction

public double[] direction()

Description copied from interface: SpaceObject

The direction of travel of this object in radians.

Specified by:

direction in interface SpaceObject

Returns:

2 dimensional array for the direction of movement

setDirection

public void setDirection(double[] dir)

Description copied from interface: SpaceObject

Sets the direction of travel of this object in radians. direction[0] less than or equal to PI direction[1] less than or equal to 2PI

Specified by:

setDirection in interface SpaceObject

Parameters:

dir - 2 dimensional array for the direction of movement

speed

public double speed()

Description copied from interface: SpaceObject

The speed of the object through space

Specified by:

speed in interface SpaceObject

Returns:

the speed

setSpeed

public void setSpeed(double v)

Description copied from interface: SpaceObject

Sets the speed of the object through space

Specified by:

setSpeed in interface SpaceObject

Parameters:

v - the speed

radius

public long radius()

Description copied from interface: SpaceObject

The current radius of the object

Specified by:

radius in interface SpaceObject

Returns:

the radius, in decameters

setRadius

public void setRadius(long radius)

Description copied from interface: SpaceObject

Set the current radius of the object

Specified by:

setRadius in interface SpaceObject

Parameters:

radius - the current radius of the object

setName

public void setName(java.lang.String newName)

Description copied from interface: Environmental

Sets the raw unmodified name of this object as stored in the database. This is the name set by builders and used as a basis for the name() method.

Specified by:

setName in interface Environmental

Overrides:

setName in class StdTimeZone

Parameters:

newName - the raw base name of this object on the map.

See Also:

Environmental.Name()

knownTarget

public SpaceObject knownTarget()

Description copied from interface: SpaceObject

If this object is targeting another space object as a destination, this will return it

Specified by:

knownTarget in interface SpaceObject

Returns:

the target destination

setKnownTarget

public void setKnownTarget(SpaceObject O)

Description copied from interface: SpaceObject

If this object is targeting another space object as a destination, this will set it

Specified by:

setKnownTarget in interface SpaceObject

Parameters:

O - the target destination

knownSource

public SpaceObject knownSource()

Description copied from interface: SpaceObject

The source object from which this space object is travelling from

Specified by:

knownSource in interface SpaceObject

Returns:

the source of this object

setKnownSource

public void setKnownSource(SpaceObject O)

Description copied from interface: SpaceObject

Sets the source object from which this space object is travelling from

Specified by:

setKnownSource in interface SpaceObject

Parameters:

O - the source of this object

getMass

public long getMass()

Description copied from interface: SpaceObject

Returns the mass of this object, derived from its radius and type, or perhaps from other things. Either way, its derived. The mass of space ships is what it is, but the mass of planets will be off by about 15 zeroes, as there just aren't enough bits.

Specified by:

getMass in interface SpaceObject

Returns:

the mass of this object

getBounds

public BoundedObject.BoundedCube getBounds()

Specified by:

getBounds in interface BoundedObject

getStat

public java.lang.String getStat(java.lang.String code)

Description copied from interface: Modifiable

An alternative means of retreiving the values of those fields on this object which are modifiable at run-time by builders. See getStatCodes() for possible values for the code passed to this method. Values returned are always strings, even if the field itself is numeric or a list.

Specified by:

getStat in interface Modifiable

Overrides:

getStat in class StdArea

Parameters:

code - the name of the field to read.

Returns:

the value of the field read

See Also:

Modifiable.getStatCodes()

setStat

public void setStat(java.lang.String code,
                    java.lang.String val)

Description copied from interface: Modifiable

An alternative means of setting the values of those fields on this object which are modifiable at run-time by builders. See getStatCodes() for possible values for the code passed to this method. The value passed in is always a string, even if the field itself is numeric or a list.

Specified by:

setStat in interface Modifiable

Overrides:

setStat in class StdArea

Parameters:

code - the name of the field to set

val - the value to set the field to

See Also:

Modifiable.getStatCodes()

getLocCodeNum

protected int getLocCodeNum(java.lang.String code)

getStatCodes

public java.lang.String[] getStatCodes()

Description copied from interface: Modifiable

Returns an array of the string names of those fields which are modifiable on this object at run-time by builders.

Specified by:

getStatCodes in interface Modifiable

Overrides:

getStatCodes in class StdArea

Returns:

list of the fields which may be set.

See Also:

Modifiable.getStat(String), Modifiable.setStat(String, String)