CoffeeDark

java.lang.Object
- com.planet_ink.coffee_mud.Libraries.StdLibrary
- - com.planet_ink.coffee_mud.Libraries.CoffeeDark

All Implemented Interfaces:

CMObject, Tickable, CMLibrary, GalacticMap, java.lang.Cloneable, java.lang.Comparable<CMObject>
```
public class CoffeeDark
extends StdLibrary
implements GalacticMap
```

Field Summary

Fields
Modifier and Type	Field	Description
`protected static java.math.BigDecimal`	`ALMOST_ZERO`
`protected static java.math.BigDecimal`	`FOUR`
`protected static java.math.BigDecimal`	`MIN_ONE`
`protected static java.math.BigDecimal`	`ONE`
`protected static java.math.BigDecimal`	`ONE_THOUSAND`
`protected static double`	`PI_ALMOST`
`protected static double`	`PI_BY_12`
`protected static double`	`PI_BY_2`
`protected static double`	`PI_TIMES_1ANDAHALF`
`protected static double`	`PI_TIMES_2`
`protected static double`	`PI_TIMES_2_ALMOST`
`protected int`	`QUADRANT_WIDTH`
`protected java.util.Map<java.lang.String,BoundedObject.BoundedCube>`	`sectorMap`
`protected RTree<SpaceObject>`	`space`
`protected static java.math.BigDecimal`	`TEN`
`protected static java.math.BigDecimal`	`TWO`
`protected static java.math.BigDecimal`	`ZERO`
`protected static double`	`ZERO_ALMOST`

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

Fields inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary
isDebugging, name, serviceClient, tickStatus

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

CoffeeDark()

Constructors
Constructor	Description
`CoffeeDark()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`double`	`accelSpaceObject(double[] curDirection, double curSpeed, double[] accelDirection, double newAcceleration)`	This method does not actually move anything, but returns a change in direction, and a change in speed caused by an acceleration in a new direction.
`void`	`accelSpaceObject(SpaceObject O, double[] accelDirection, double newAcceleration)`	This method does not actually move anything, but given a space object, and an acceleration direction and an acceleration speed, this will alter the space objects direction and speed based on the new acceleration.
`boolean`	`activate()`	Activates the library.
`void`	`addObjectToSpace(SpaceObject O)`	Adds the given SpaceObject to the galactic map cache.
`void`	`addObjectToSpace(SpaceObject O, long[] coords)`	Adds the given SpaceObject to the galactic map cache at the given coordinates.
`void`	`applyAngleDiff(double[] angle, double[] delta)`	Given an angle and a simple delta, with positive and negative values, this will add the delta to the angle and normalize the angle.
`static java.math.BigDecimal`	`bigSqrt(java.math.BigDecimal A)`
`Pair<double[],java.lang.Long>`	`calculateIntercept(SpaceObject chaserO, SpaceObject runnerO, long maxChaserSpeed, int maxTicks)`	Returns the proper direction and speed to allow the given chaser to intercept the given runner.
`Pair<double[],java.lang.Long>`	`calculateIntercept2(SpaceObject chaserO, SpaceObject runnerO, long maxChaserSpeed, int maxTicks)`
`boolean`	`canMaybeIntercept(SpaceObject chaserO, SpaceObject runnerO, int maxTicks, double maxSpeed)`	Returns whether the vectors described by the chaser and runners, their speeds, and the amount of time in movement can even POSSIBLY intercept, because the two vectors overlap
`void`	`changeDirection(double[] dir, double[] delta)`	Changes the given direction by the given delta variable.
`void`	`changeDirection(double[] dir, double delta0, double delta1)`	Changes the given direction by the given delta variables.
`void`	`delObjectInSpace(SpaceObject O)`	Removes a SpaceObject from the galactic map cache.
`SpaceObject`	`findSpaceObject(java.lang.String s, boolean exactOnly)`	Given the name of an object in space, preferably a unique name, this will attempt to find and return it using standard search methods.
`protected void`	`fixDirectionBounds(double[] dir)`
`ShipDirectional.ShipDir`	`getAbsoluteDirectionalFromDir(double[] direction)`	Given a direction this will return a relative direction object describing the directions absolute facing.
`double`	`getAngleDelta(double[] fromAngle, double[] toAngle)`	Given two angles, this returns the difference between them as a single angle.
`double[]`	`getAngleDiff(double[] fromAngle, double[] toAngle)`	Given two angles, this returns the difference between them in pitch and yaw.
`protected double[]`	`getBigDirection(long[] fromCoords, long[] toCoords)`
`protected java.math.BigDecimal`	`getBigDistanceFrom(long[] coord1, long[] coord2)`
`ShipDirectional.ShipDir[]`	`getCurrentBattleCoveredDirections(ShipDirectional comp)`	Given a ship war component, returns the directions in which it is currently covering.
`protected double`	`getDirDiffSum(double[] d1, double[] d2)`
`double[]`	`getDirection(long[] fromCoords, long[] toCoords)`	Given two galactic coordinates, this will return the direction in radians from the first to the second.
`double[]`	`getDirection(SpaceObject fromObj, SpaceObject toObj)`	Given two space objects, this will return the direction in radians from the first to the second.
`ShipDirectional.ShipDir`	`getDirectionFromDir(double[] facing, double roll, double[] direction)`	Given a facing direction (NOT direction of travel), and a roll angle (belly/axis), and a direction to some other object, this will return a relative direction object describing the ships relationship to the other object.
`long`	`getDistanceFrom(long[] coord1, long[] coord2)`	Given two galactic coordinates, this returns the actual distance between the two.
`long`	`getDistanceFrom(SpaceObject O1, SpaceObject O2)`	Given two space objects, this returns the actual distance between the two.
`double`	`getGravityForce(SpaceObject S, SpaceObject cO)`	If the two given objects are within an appropriate distance from each other, this will return the correct amount of acceleration g-force applied by the second object to the first.
`long[]`	`getInSectorCoords(long[] coords)`	Given absolute space coordinates, from -Long.MAX to Long.MAX, this will return the relative coordinates INSIDE the sector, whose bounds are determined by lots of math.
`java.util.List<LocationRoom>`	`getLandingPoints(SpaceObject ship, Environmental O)`	Given a space ship, and an object that can be reduced to an Area, this will return a list of all valid LocationRoom objects, sorted by their present distance from the ship, from each other, and whether its a space port.
`long[]`	`getLocation(long[] oldLocation, double[] direction, long distance)`	Given some galactic coordinates, a direction of travel, and a distance, this will return the new coordinates.
`double[]`	`getMiddleAngle(double[] angle1, double[] angle2)`	Given two angles, this returns the angle between them.
`double`	`getMinDistanceFrom(long[] prevPos, long[] curPos, long[] objPos)`	Given a previous position and a current position, this will return the minimum distance approached to the given object position.
`double[]`	`getOffsetAngle(double[] correctAngle, double[] wrongAngle)`	Given a base 'correct' angle and another 'wrong' angle, this will return the angle that it opposite to, but equal in distance.
`protected double`	`getOldMinDistFrom(long[] prevPos, double speed, double[] dir, long[] curPosition, double[] directionTo, long[] objPos)`
`double[]`	`getOppositeDir(double[] dir)`	Given a direction, this will return its opposite
`double[][]`	`getPerpendicularAngles(double[] angle)`	Given an angle from origin, this will return the other trivial angles that are 90 degrees from the given one.
`long[][]`	`getPerpendicularPoints(long[] origin, double[] angle, long distance)`	Given the origin point and an angle from the origin, this will return the other points that are 90 degrees from the given one, at the given distance.
`long`	`getRelativeSpeed(SpaceObject O1, SpaceObject O2)`	Calculates the relative speed of two SpaceObjects to each other.
`java.util.Map<java.lang.String,BoundedObject.BoundedCube>`	`getSectorMap()`	Returns the name of all the sectors, and the cube that covers its domain.
`java.lang.String`	`getSectorName(long[] coords)`	Given some absolute space coordinates, this will return the name of the sector the coordinates are in.
`SpaceObject`	`getSpaceObject(CMObject o, boolean ignoreMobs)`	Given a random object, this will return null, or the "nearest" space object, by crawling up an item container tree, or however it needs to.
`java.util.Enumeration<java.util.Map.Entry<SpaceObject,java.util.List<java.lang.ref.WeakReference<TrackingVector<SpaceObject>>>>>`	`getSpaceObjectEntries()`	Returns an enumeration of all objects, along with a list of their tracking vectors? I have no idea why anyone would want this, so I won't explain any more until someone does try to use this.
`java.util.Enumeration<SpaceObject>`	`getSpaceObjects()`	Returns an enumeration of all object in the galactic space map.
`java.util.List<SpaceObject>`	`getSpaceObjectsByCenterpointWithin(long[] centerCoordinates, long minDistance, long maxDistance)`	Given a center galactic coordinates, and a minimum and maximum distance from that coordinate, this will return all objects in the caches space map that is within the "donut" defined by those things.
`java.util.List<SpaceObject>`	`getSpaceObjectsInBound(BoundedObject.BoundedCube cube)`	Given a bounded cube, this will return all space objects within that cube, and by within, i mean even just intersecting it.
`java.util.List<SpaceObject>`	`getSpaceObjectsWithin(SpaceObject ofObj, long minDistance, long maxDistance)`	Given a space object to use as a center point on the galactic map, this will return all objects in the caches space map that is within the "donut" defined by those things.
`java.lang.String`	`ID()`	The CoffeeMud Java Class ID shared by all instances of this object.
`boolean`	`isObjectInSpace(SpaceObject O)`	Returns whether the given object is actually in the galactic map cache at the moment -- it could be landed somewhere.
`protected BoundedObject.BoundedCube`	`makeCourseCubeRay(long[] src, long sradius, long[] target, long tradius, double[] dir)`
`long[]`	`moveSpaceObject(long[] coordinates, double[] direction, long speed)`	Given a set of galactic coordinates, and a direction angle, and a speed, this will return the new coordinates after applying all the inputs.
`void`	`moveSpaceObject(SpaceObject O)`	Given a SpaceObject that is moving, this will alter the given objects coordinates based on its speed and direction.
`void`	`moveSpaceObject(SpaceObject O, long[] coords)`	Given a SpaceObject and its coordinates, this will alter the given coordinates based on the speed and direction of the given space object.
`protected void`	`moveSpaceObject(SpaceObject O, long x, long y, long z)`
`int`	`numSpaceObjects()`	Returns the number of objects in the galactic map cache.
`java.util.List<long[]>`	`plotCourse(long[] osrc, long sradius, long[] otarget, long tradius, int maxTicks)`	Plots a course from the source to the target, with a maximum number of steps/ticks.
`void`	`runSpace()`
`boolean`	`sendSpaceEmissionEvent(SpaceObject srcP, Environmental tool, int emissionType, java.lang.String msgStr)`	Generates an sends a message representing an emission in space, which might be picked up by various sensors.
`boolean`	`sendSpaceEmissionEvent(SpaceObject srcP, Environmental tool, long range, int emissionType, java.lang.String msgStr)`	Generates an sends a message representing an emission in space, which might be picked up by various sensors.
`boolean`	`shutdown()`	Shuts down the library.
`java.util.Enumeration<Area>`	`spaceAreas()`	Returns an enumeration of all Areas that are also SpaceObjects, typically planets.
`protected void`	`swapTargetTool(CMMsg msg)`
`boolean`	`tick(Tickable ticking, int tickID)`	this is the method which is called periodically by the threading engine.

Methods inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.CMLibrary
getServiceClient, L, propertiesLoaded

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject
copyOf, initializeClass, name, newInstance

Methods inherited from interface java.lang.Comparable
compareTo

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.Libraries.StdLibrary
checkDatabase, compareTo, copyOf, getServiceClient, getTickStatus, initializeClass, L, name, newInstance, propertiesLoaded, setThreadStatus

- Field Detail
  - ZERO_ALMOST
```
protected static final double ZERO_ALMOST
```
    See Also:
    
    Constant Field Values
  - ZERO
```
protected static final java.math.BigDecimal ZERO
```
  - ALMOST_ZERO
```
protected static final java.math.BigDecimal ALMOST_ZERO
```
  - ONE
```
protected static final java.math.BigDecimal ONE
```
  - MIN_ONE
```
protected static final java.math.BigDecimal MIN_ONE
```
  - TWO
```
protected static final java.math.BigDecimal TWO
```
  - FOUR
```
protected static final java.math.BigDecimal FOUR
```
  - TEN
```
protected static final java.math.BigDecimal TEN
```
  - ONE_THOUSAND
```
protected static final java.math.BigDecimal ONE_THOUSAND
```
  - PI_ALMOST
```
protected static final double PI_ALMOST
```
    See Also:
    
    Constant Field Values
  - PI_TIMES_2_ALMOST
```
protected static final double PI_TIMES_2_ALMOST
```
    See Also:
    
    Constant Field Values
  - PI_TIMES_2
```
protected static final double PI_TIMES_2
```
    See Also:
    
    Constant Field Values
  - PI_BY_2
```
protected static final double PI_BY_2
```
    See Also:
    
    Constant Field Values
  - PI_BY_12
```
protected static final double PI_BY_12
```
    See Also:
    
    Constant Field Values
  - PI_TIMES_1ANDAHALF
```
protected static final double PI_TIMES_1ANDAHALF
```
    See Also:
    
    Constant Field Values
  - QUADRANT_WIDTH
```
protected final int QUADRANT_WIDTH
```
    See Also:
    
    Constant Field Values
  - space
```
protected final RTree<SpaceObject> space
```
  - sectorMap
```
protected final java.util.Map<java.lang.String,BoundedObject.BoundedCube> sectorMap
```
- Constructor Detail
  - CoffeeDark
```
public CoffeeDark()
```
- 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 StdLibrary
    
    Returns:
    
    the name of this class
  - isObjectInSpace
```
public boolean isObjectInSpace(SpaceObject O)
```
    Description copied from interface: GalacticMap
    
    Returns whether the given object is actually in the galactic map cache at the moment -- it could be landed somewhere.
    
    Specified by:
    
    isObjectInSpace in interface GalacticMap
    
    Parameters:
    
    O - the space object to look for
    
    Returns:
    
    true if it's in space
    
    See Also:
    
    GalacticMap.numSpaceObjects(), GalacticMap.isObjectInSpace(SpaceObject), GalacticMap.delObjectInSpace(SpaceObject), GalacticMap.addObjectToSpace(SpaceObject, long[]), GalacticMap.addObjectToSpace(SpaceObject), GalacticMap.findSpaceObject(String, boolean)
  - delObjectInSpace
```
public void delObjectInSpace(SpaceObject O)
```
    Description copied from interface: GalacticMap
    
    Removes a SpaceObject from the galactic map cache. This is normally required if it is moving.
    
    Specified by:
    
    delObjectInSpace in interface GalacticMap
    
    Parameters:
    
    O - the object to remove
    
    See Also:
    
    GalacticMap.numSpaceObjects(), GalacticMap.isObjectInSpace(SpaceObject), GalacticMap.delObjectInSpace(SpaceObject), GalacticMap.addObjectToSpace(SpaceObject, long[]), GalacticMap.addObjectToSpace(SpaceObject), GalacticMap.findSpaceObject(String, boolean)
  - addObjectToSpace
```
public void addObjectToSpace(SpaceObject O,
                             long[] coords)
```
    Description copied from interface: GalacticMap
    
    Adds the given SpaceObject to the galactic map cache at the given coordinates.
    
    Specified by:
    
    addObjectToSpace in interface GalacticMap
    
    Parameters:
    
    O - the SpaceObject to add
    
    coords - the coordinates to add it at
    
    See Also:
    
    GalacticMap.numSpaceObjects(), GalacticMap.isObjectInSpace(SpaceObject), GalacticMap.delObjectInSpace(SpaceObject), GalacticMap.addObjectToSpace(SpaceObject, long[]), GalacticMap.addObjectToSpace(SpaceObject), GalacticMap.findSpaceObject(String, boolean)
  - addObjectToSpace
```
public void addObjectToSpace(SpaceObject O)
```
    Description copied from interface: GalacticMap
    
    Adds the given SpaceObject to the galactic map cache.
    
    Specified by:
    
    addObjectToSpace in interface GalacticMap
    
    Parameters:
    
    O - the object to put in space
    
    See Also:
    
    GalacticMap.numSpaceObjects(), GalacticMap.isObjectInSpace(SpaceObject), GalacticMap.delObjectInSpace(SpaceObject), GalacticMap.addObjectToSpace(SpaceObject, long[]), GalacticMap.addObjectToSpace(SpaceObject), GalacticMap.findSpaceObject(String, boolean)
  - spaceAreas
```
public java.util.Enumeration<Area> spaceAreas()
```
    Description copied from interface: GalacticMap
    
    Returns an enumeration of all Areas that are also SpaceObjects, typically planets.
    
    Specified by:
    
    spaceAreas in interface GalacticMap
    
    Returns:
    
    an enumeration of all space Areas
  - getDistanceFrom
```
public long getDistanceFrom(long[] coord1,
                            long[] coord2)
```
    Description copied from interface: GalacticMap
    
    Given two galactic coordinates, this returns the actual distance between the two.
    
    Specified by:
    
    getDistanceFrom in interface GalacticMap
    
    Parameters:
    
    coord1 - first galactic coords
    
    coord2 - second galactic coords
    
    Returns:
    
    distance between the two
    
    See Also:
    
    GalacticMap.getDistanceFrom(long[], long[]), GalacticMap.getDistanceFrom(SpaceObject, SpaceObject), GalacticMap.getMinDistanceFrom(long[], long[], long[])
  - getDistanceFrom
```
public long getDistanceFrom(SpaceObject O1,
                            SpaceObject O2)
```
    Description copied from interface: GalacticMap
    
    Given two space objects, this returns the actual distance between the two.
    
    Specified by:
    
    getDistanceFrom in interface GalacticMap
    
    Parameters:
    
    O1 - the first space object
    
    O2 - the second space object
    
    Returns:
    
    the distance between the two
    
    See Also:
    
    GalacticMap.getDistanceFrom(long[], long[]), GalacticMap.getDistanceFrom(SpaceObject, SpaceObject), GalacticMap.getMinDistanceFrom(long[], long[], long[])
  - getPerpendicularAngles
```
public double[][] getPerpendicularAngles(double[] angle)
```
    Description copied from interface: GalacticMap
    
    Given an angle from origin, this will return the other trivial angles that are 90 degrees from the given one. Will NOT include the given one.
    
    Specified by:
    
    getPerpendicularAngles in interface GalacticMap
    
    Parameters:
    
    angle - the angle from origin
    
    Returns:
    
    the set of angles (usually 4 of them).
  - getPerpendicularPoints
```
public long[][] getPerpendicularPoints(long[] origin,
                                       double[] angle,
                                       long distance)
```
    Description copied from interface: GalacticMap
    
    Given the origin point and an angle from the origin, this will return the other points that are 90 degrees from the given one, at the given distance.
    
    Specified by:
    
    getPerpendicularPoints in interface GalacticMap
    
    Parameters:
    
    origin - the origin points
    
    angle - the angle from origin
    
    distance - the distance from origin of the points to return
    
    Returns:
    
    the set of points (usually 4 of them)
    
    See Also:
    
    GalacticMap.getPerpendicularAngles(double[])
  - getBigDistanceFrom
```
protected java.math.BigDecimal getBigDistanceFrom(long[] coord1,
                                                  long[] coord2)
```
  - getSectorName
```
public java.lang.String getSectorName(long[] coords)
```
    Description copied from interface: GalacticMap
    
    Given some absolute space coordinates, this will return the name of the sector the coordinates are in.
    
    Specified by:
    
    getSectorName in interface GalacticMap
    
    Parameters:
    
    coords - the space coordinates
    
    Returns:
    
    the name of the sector the coordinates are in
    
    See Also:
    
    GalacticMap.getInSectorCoords(long[])
  - getInSectorCoords
```
public long[] getInSectorCoords(long[] coords)
```
    Description copied from interface: GalacticMap
    
    Given absolute space coordinates, from -Long.MAX to Long.MAX, this will return the relative coordinates INSIDE the sector, whose bounds are determined by lots of math.
    
    Specified by:
    
    getInSectorCoords in interface GalacticMap
    
    Parameters:
    
    coords - the space coordinates
    
    Returns:
    
    the inner bounds
    
    See Also:
    
    GalacticMap.getSectorName(long[])
  - getSectorMap
```
public java.util.Map<java.lang.String,BoundedObject.BoundedCube> getSectorMap()
```
    Description copied from interface: GalacticMap
    
    Returns the name of all the sectors, and the cube that covers its domain.
    
    Specified by:
    
    getSectorMap in interface GalacticMap
    
    Returns:
    
    the sector map
  - accelSpaceObject
```
public void accelSpaceObject(SpaceObject O,
                             double[] accelDirection,
                             double newAcceleration)
```
    Description copied from interface: GalacticMap
    
    This method does not actually move anything, but given a space object, and an acceleration direction and an acceleration speed, this will alter the space objects direction and speed based on the new acceleration.
    
    Specified by:
    
    accelSpaceObject in interface GalacticMap
    
    Parameters:
    
    O - the space object to modify
    
    accelDirection - the acceleration direction
    
    newAcceleration - the acceleration amount
    
    See Also:
    
    GalacticMap.accelSpaceObject(double[], double, double[], double)
  - getAngleDelta
```
public double getAngleDelta(double[] fromAngle,
                            double[] toAngle)
```
    Description copied from interface: GalacticMap
    
    Given two angles, this returns the difference between them as a single angle.
    
    Specified by:
    
    getAngleDelta in interface GalacticMap
    
    Parameters:
    
    fromAngle - the first angle
    
    toAngle - the second angle
    
    Returns:
    
    the angle delta
    
    See Also:
    
    GalacticMap.getAngleDiff(double[], double[])
  - getMiddleAngle
```
public double[] getMiddleAngle(double[] angle1,
                               double[] angle2)
```
    Description copied from interface: GalacticMap
    
    Given two angles, this returns the angle between them.
    
    Specified by:
    
    getMiddleAngle in interface GalacticMap
    
    Parameters:
    
    angle1 - the first angle
    
    angle2 - the second angle
    
    Returns:
    
    the middle angle
  - getOffsetAngle
```
public double[] getOffsetAngle(double[] correctAngle,
                               double[] wrongAngle)
```
    Description copied from interface: GalacticMap
    
    Given a base 'correct' angle and another 'wrong' angle, this will return the angle that it opposite to, but equal in distance.
    
    Specified by:
    
    getOffsetAngle in interface GalacticMap
    
    Parameters:
    
    correctAngle - the base angle
    
    wrongAngle - the wrong angle
    
    Returns:
    
    another wrong angle, on the other 'side' of the base
  - applyAngleDiff
```
public void applyAngleDiff(double[] angle,
                           double[] delta)
```
    Description copied from interface: GalacticMap
    
    Given an angle and a simple delta, with positive and negative values, this will add the delta to the angle and normalize the angle.
    
    Specified by:
    
    applyAngleDiff in interface GalacticMap
    
    Parameters:
    
    angle - the angle to modify
    
    delta - the delta
  - getAngleDiff
```
public double[] getAngleDiff(double[] fromAngle,
                             double[] toAngle)
```
    Description copied from interface: GalacticMap
    
    Given two angles, this returns the difference between them in pitch and yaw.
    
    Specified by:
    
    getAngleDiff in interface GalacticMap
    
    Parameters:
    
    fromAngle - the first angle
    
    toAngle - the second angle
    
    Returns:
    
    the angle delta
    
    See Also:
    
    GalacticMap.getAngleDelta(double[], double[])
  - accelSpaceObject
```
public double accelSpaceObject(double[] curDirection,
                               double curSpeed,
                               double[] accelDirection,
                               double newAcceleration)
```
    Description copied from interface: GalacticMap
    
    This method does not actually move anything, but returns a change in direction, and a change in speed caused by an acceleration in a new direction.
    
    Specified by:
    
    accelSpaceObject in interface GalacticMap
    
    Parameters:
    
    curDirection - the current direction, *AND* the new direction
    
    curSpeed - the current speed
    
    accelDirection - the direction of acceleration
    
    newAcceleration - the amount of acceleration
    
    Returns:
    
    the new speed
    
    See Also:
    
    GalacticMap.accelSpaceObject(double[], double, double[], double)
  - fixDirectionBounds
```
protected void fixDirectionBounds(double[] dir)
```
  - changeDirection
```
public void changeDirection(double[] dir,
                            double delta0,
                            double delta1)
```
    Description copied from interface: GalacticMap
    
    Changes the given direction by the given delta variables. Corrects any crossover bounds, and checks the delta bounds.
    
    Specified by:
    
    changeDirection in interface GalacticMap
    
    Parameters:
    
    dir - the current direction to change
    
    delta0 - the port/starboard delta
    
    delta1 - the ventral/dorsel delta
  - changeDirection
```
public void changeDirection(double[] dir,
                            double[] delta)
```
    Description copied from interface: GalacticMap
    
    Changes the given direction by the given delta variable. Corrects any crossover bounds, and checks the delta bounds.
    
    Specified by:
    
    changeDirection in interface GalacticMap
    
    Parameters:
    
    dir - the current direction to change
    
    delta - the delta to change it by, + or -
  - getOppositeDir
```
public double[] getOppositeDir(double[] dir)
```
    Description copied from interface: GalacticMap
    
    Given a direction, this will return its opposite
    
    Specified by:
    
    getOppositeDir in interface GalacticMap
    
    Parameters:
    
    dir - the direction
    
    Returns:
    
    the opposite direction
    
    See Also:
    
    GalacticMap.getDirection(long[], long[]), GalacticMap.getDirection(SpaceObject, SpaceObject), GalacticMap.getDirectionFromDir(double[], double, double[]), GalacticMap.getOppositeDir(double[])
  - getDirectionFromDir
```
public ShipDirectional.ShipDir getDirectionFromDir(double[] facing,
                                                   double roll,
                                                   double[] direction)
```
    Description copied from interface: GalacticMap
    
    Given a facing direction (NOT direction of travel), and a roll angle (belly/axis), and a direction to some other object, this will return a relative direction object describing the ships relationship to the other object. This is mostly for combat, where you need to know when a missile his the belly or ass, or whether you can fire a forward missile at it.
    
    Specified by:
    
    getDirectionFromDir in interface GalacticMap
    
    Parameters:
    
    facing - the direction of facing
    
    roll - the roll angle
    
    direction - the direction to the other object
    
    Returns:
    
    the relative direction code
    
    See Also:
    
    ShipDirectional.ShipDir, GalacticMap.getDirection(long[], long[]), GalacticMap.getDirection(SpaceObject, SpaceObject), GalacticMap.getDirectionFromDir(double[], double, double[]), GalacticMap.getOppositeDir(double[]), GalacticMap.getAbsoluteDirectionalFromDir(double[])
  - getAbsoluteDirectionalFromDir
```
public ShipDirectional.ShipDir getAbsoluteDirectionalFromDir(double[] direction)
```
    Description copied from interface: GalacticMap
    
    Given a direction this will return a relative direction object describing the directions absolute facing. This is arbitrary, and just allows zones of direction to be described more easily.
    
    Specified by:
    
    getAbsoluteDirectionalFromDir in interface GalacticMap
    
    Parameters:
    
    direction - the direction to the other object
    
    Returns:
    
    the absolute direction code
    
    See Also:
    
    ShipDirectional.ShipDir, GalacticMap.getDirection(long[], long[]), GalacticMap.getDirection(SpaceObject, SpaceObject), GalacticMap.getDirectionFromDir(double[], double, double[]), GalacticMap.getOppositeDir(double[]), GalacticMap.getDirectionFromDir(double[], double, double[])
  - getDirection
```
public double[] getDirection(SpaceObject fromObj,
                             SpaceObject toObj)
```
    Description copied from interface: GalacticMap
    
    Given two space objects, this will return the direction in radians from the first to the second.
    
    Specified by:
    
    getDirection in interface GalacticMap
    
    Parameters:
    
    fromObj - the first SpaceObject
    
    toObj - the second SpaceObject
    
    Returns:
    
    the direction in radians from the first to the second
    
    See Also:
    
    GalacticMap.getDirection(long[], long[]), GalacticMap.getDirection(SpaceObject, SpaceObject), GalacticMap.getDirectionFromDir(double[], double, double[]), GalacticMap.getOppositeDir(double[])
  - moveSpaceObject
```
protected void moveSpaceObject(SpaceObject O,
                               long x,
                               long y,
                               long z)
```
  - moveSpaceObject
```
public void moveSpaceObject(SpaceObject O,
                            long[] coords)
```
    Description copied from interface: GalacticMap
    
    Given a SpaceObject and its coordinates, this will alter the given coordinates based on the speed and direction of the given space object.
    
    Specified by:
    
    moveSpaceObject in interface GalacticMap
    
    Parameters:
    
    O - the space object that is moving
    
    coords - the coordinates to modify based on speed/dir of the object
    
    See Also:
    
    GalacticMap.moveSpaceObject(SpaceObject), GalacticMap.moveSpaceObject(long[], double[], long), GalacticMap.getLocation(long[], double[], long)
  - moveSpaceObject
```
public void moveSpaceObject(SpaceObject O)
```
    Description copied from interface: GalacticMap
    
    Given a SpaceObject that is moving, this will alter the given objects coordinates based on its speed and direction.
    
    Specified by:
    
    moveSpaceObject in interface GalacticMap
    
    Parameters:
    
    O - the SpaceObject to move
    
    See Also:
    
    GalacticMap.moveSpaceObject(SpaceObject, long[]), GalacticMap.moveSpaceObject(long[], double[], long), GalacticMap.getLocation(long[], double[], long)
  - getDirection
```
public double[] getDirection(long[] fromCoords,
                             long[] toCoords)
```
    Description copied from interface: GalacticMap
    
    Given two galactic coordinates, this will return the direction in radians from the first to the second.
    
    Specified by:
    
    getDirection in interface GalacticMap
    
    Parameters:
    
    fromCoords - the first coordinates
    
    toCoords - the second coordinates
    
    Returns:
    
    the angle of direction from the first to the second
    
    See Also:
    
    GalacticMap.getDirection(long[], long[]), GalacticMap.getDirection(SpaceObject, SpaceObject), GalacticMap.getDirectionFromDir(double[], double, double[]), GalacticMap.getOppositeDir(double[])
  - getBigDirection
```
protected double[] getBigDirection(long[] fromCoords,
                                   long[] toCoords)
```
  - moveSpaceObject
```
public long[] moveSpaceObject(long[] coordinates,
                              double[] direction,
                              long speed)
```
    Description copied from interface: GalacticMap
    
    Given a set of galactic coordinates, and a direction angle, and a speed, this will return the new coordinates after applying all the inputs.
    
    Specified by:
    
    moveSpaceObject in interface GalacticMap
    
    Parameters:
    
    coordinates - the galactic coordinates
    
    direction - the direction angle
    
    speed - the speed
    
    Returns:
    
    the new coordinates
    
    See Also:
    
    GalacticMap.moveSpaceObject(SpaceObject), GalacticMap.moveSpaceObject(SpaceObject, long[]), GalacticMap.getLocation(long[], double[], long)
  - getLocation
```
public long[] getLocation(long[] oldLocation,
                          double[] direction,
                          long distance)
```
    Description copied from interface: GalacticMap
    
    Given some galactic coordinates, a direction of travel, and a distance, this will return the new coordinates.
    
    Specified by:
    
    getLocation in interface GalacticMap
    
    Parameters:
    
    oldLocation - the previous location
    
    direction - the direction of travel
    
    distance - the distance of travel
    
    Returns:
    
    the new location
    
    See Also:
    
    GalacticMap.moveSpaceObject(SpaceObject), GalacticMap.moveSpaceObject(SpaceObject, long[]), GalacticMap.moveSpaceObject(long[], double[], long)
  - getRelativeSpeed
```
public long getRelativeSpeed(SpaceObject O1,
                             SpaceObject O2)
```
    Description copied from interface: GalacticMap
    
    Calculates the relative speed of two SpaceObjects to each other. The math is based entirely on coordinates and speed, not direction, so take it for what you will. Do they both need to be going the same direction for this to work?
    
    Specified by:
    
    getRelativeSpeed in interface GalacticMap
    
    Parameters:
    
    O1 - the first Space Object
    
    O2 - the second Space Object
    
    Returns:
    
    the relative speed of the two objects
  - findSpaceObject
```
public SpaceObject findSpaceObject(java.lang.String s,
                                   boolean exactOnly)
```
    Description copied from interface: GalacticMap
    
    Given the name of an object in space, preferably a unique name, this will attempt to find and return it using standard search methods. That means class IDs, Names, and display texts are all game. Preference to the first hit, but supporting the .1, .2, etc syntax.
    
    Specified by:
    
    findSpaceObject in interface GalacticMap
    
    Parameters:
    
    s - the search string
    
    exactOnly - true to only match full terms, false for partial matches
    
    Returns:
    
    the SpaceObject found, or null
    
    See Also:
    
    GalacticMap.getSpaceObjects(), GalacticMap.getSpaceObjectEntries(), GalacticMap.getSpaceObjectsWithin(SpaceObject, long, long), GalacticMap.getSpaceObjectsByCenterpointWithin(long[], long, long), GalacticMap.getSpaceObject(CMObject, boolean), GalacticMap.getSpaceObjectsInBound(BoundedCube)
  - getSpaceObject
```
public SpaceObject getSpaceObject(CMObject o,
                                  boolean ignoreMobs)
```
    Description copied from interface: GalacticMap
    
    Given a random object, this will return null, or the "nearest" space object, by crawling up an item container tree, or however it needs to.
    
    Specified by:
    
    getSpaceObject in interface GalacticMap
    
    Parameters:
    
    o - the game object, of almost any sort (item, area, room, mob)
    
    ignoreMobs - true to return null on mobs, false otherwise
    
    Returns:
    
    the nearest SpaceObject the object IS, or is inside
    
    See Also:
    
    GalacticMap.getSpaceObjects(), GalacticMap.getSpaceObjectEntries(), GalacticMap.getSpaceObjectsWithin(SpaceObject, long, long), GalacticMap.getSpaceObjectsByCenterpointWithin(long[], long, long), GalacticMap.findSpaceObject(String, boolean), GalacticMap.getSpaceObjectsInBound(BoundedCube)
  - getSpaceObjects
```
public java.util.Enumeration<SpaceObject> getSpaceObjects()
```
    Description copied from interface: GalacticMap
    
    Returns an enumeration of all object in the galactic space map.
    
    Specified by:
    
    getSpaceObjects in interface GalacticMap
    
    Returns:
    
    an enumeration of all object in the galactic space map
    
    See Also:
    
    GalacticMap.getSpaceObjectEntries(), GalacticMap.getSpaceObjectsWithin(SpaceObject, long, long), GalacticMap.getSpaceObjectsByCenterpointWithin(long[], long, long), GalacticMap.findSpaceObject(String, boolean), GalacticMap.getSpaceObject(CMObject, boolean)
  - getSpaceObjectEntries
```
public java.util.Enumeration<java.util.Map.Entry<SpaceObject,java.util.List<java.lang.ref.WeakReference<TrackingVector<SpaceObject>>>>> getSpaceObjectEntries()
```
    Description copied from interface: GalacticMap
    
    Returns an enumeration of all objects, along with a list of their tracking vectors? I have no idea why anyone would want this, so I won't explain any more until someone does try to use this.
    
    Specified by:
    
    getSpaceObjectEntries in interface GalacticMap
    
    Returns:
    
    returns all of the objects in space
    
    See Also:
    
    GalacticMap.getSpaceObjects(), GalacticMap.getSpaceObjectsWithin(SpaceObject, long, long), GalacticMap.getSpaceObjectsByCenterpointWithin(long[], long, long), GalacticMap.findSpaceObject(String, boolean), GalacticMap.getSpaceObject(CMObject, boolean), GalacticMap.getSpaceObjectsInBound(BoundedCube)
  - getSpaceObjectsByCenterpointWithin
```
public java.util.List<SpaceObject> getSpaceObjectsByCenterpointWithin(long[] centerCoordinates,
                                                                      long minDistance,
                                                                      long maxDistance)
```
    Description copied from interface: GalacticMap
    
    Given a center galactic coordinates, and a minimum and maximum distance from that coordinate, this will return all objects in the caches space map that is within the "donut" defined by those things.
    
    Specified by:
    
    getSpaceObjectsByCenterpointWithin in interface GalacticMap
    
    Parameters:
    
    centerCoordinates - the full galactic coordinates of the center point
    
    minDistance - the minimum distance to return
    
    maxDistance - the maximum distance to return
    
    Returns:
    
    all objects matching the distance scan
    
    See Also:
    
    GalacticMap.getSpaceObjects(), GalacticMap.getSpaceObjectEntries(), GalacticMap.getSpaceObjectsWithin(SpaceObject, long, long), GalacticMap.findSpaceObject(String, boolean), GalacticMap.getSpaceObject(CMObject, boolean), GalacticMap.getSpaceObjectsInBound(BoundedCube)
  - getSpaceObjectsInBound
```
public java.util.List<SpaceObject> getSpaceObjectsInBound(BoundedObject.BoundedCube cube)
```
    Description copied from interface: GalacticMap
    
    Given a bounded cube, this will return all space objects within that cube, and by within, i mean even just intersecting it.
    
    Specified by:
    
    getSpaceObjectsInBound in interface GalacticMap
    
    Parameters:
    
    cube - the cube to look within
    
    Returns:
    
    the objects in space in that cube
    
    See Also:
    
    GalacticMap.getSpaceObjects(), GalacticMap.getSpaceObjectEntries(), GalacticMap.getSpaceObjectsByCenterpointWithin(long[], long, long), GalacticMap.findSpaceObject(String, boolean), GalacticMap.getSpaceObject(CMObject, boolean)
  - getSpaceObjectsWithin
```
public java.util.List<SpaceObject> getSpaceObjectsWithin(SpaceObject ofObj,
                                                         long minDistance,
                                                         long maxDistance)
```
    Description copied from interface: GalacticMap
    
    Given a space object to use as a center point on the galactic map, this will return all objects in the caches space map that is within the "donut" defined by those things.
    
    Specified by:
    
    getSpaceObjectsWithin in interface GalacticMap
    
    Parameters:
    
    ofObj - the space object to use as a center point
    
    minDistance - the minimum distance to return
    
    maxDistance - the maximum distance to return
    
    Returns:
    
    all objects matching the distance scan
    
    See Also:
    
    GalacticMap.getSpaceObjects(), GalacticMap.getSpaceObjectEntries(), GalacticMap.getSpaceObjectsByCenterpointWithin(long[], long, long), GalacticMap.findSpaceObject(String, boolean), GalacticMap.getSpaceObject(CMObject, boolean), GalacticMap.getSpaceObjectsInBound(BoundedCube)
  - getLandingPoints
```
public java.util.List<LocationRoom> getLandingPoints(SpaceObject ship,
                                                     Environmental O)
```
    Description copied from interface: GalacticMap
    
    Given a space ship, and an object that can be reduced to an Area, this will return a list of all valid LocationRoom objects, sorted by their present distance from the ship, from each other, and whether its a space port. Best closest match at the top of the list.
    
    Specified by:
    
    getLandingPoints in interface GalacticMap
    
    Parameters:
    
    ship - the ship looking for a landing spot
    
    O - an area, room, boardable, whatever
    
    Returns:
    
    a list of LocationRoom objects, best on top
  - numSpaceObjects
```
public int numSpaceObjects()
```
    Description copied from interface: GalacticMap
    
    Returns the number of objects in the galactic map cache.
    
    Specified by:
    
    numSpaceObjects in interface GalacticMap
    
    Returns:
    
    the number of objects in the galactic map
  - bigSqrt
```
public static java.math.BigDecimal bigSqrt(java.math.BigDecimal A)
```
  - canMaybeIntercept
```
public boolean canMaybeIntercept(SpaceObject chaserO,
                                 SpaceObject runnerO,
                                 int maxTicks,
                                 double maxSpeed)
```
    Description copied from interface: GalacticMap
    
    Returns whether the vectors described by the chaser and runners, their speeds, and the amount of time in movement can even POSSIBLY intercept, because the two vectors overlap
    
    Specified by:
    
    canMaybeIntercept in interface GalacticMap
    
    Parameters:
    
    chaserO - the chasing object
    
    runnerO - the running object
    
    maxTicks - the maximum number of movements
    
    maxSpeed - the max speed of the chaser
    
    Returns:
    
    true if there is a possible intercept, false otherwise
    
    See Also:
    
    GalacticMap.calculateIntercept(SpaceObject, SpaceObject, long, int)
  - calculateIntercept
```
public Pair<double[],java.lang.Long> calculateIntercept(SpaceObject chaserO,
                                                        SpaceObject runnerO,
                                                        long maxChaserSpeed,
                                                        int maxTicks)
```
    Description copied from interface: GalacticMap
    
    Returns the proper direction and speed to allow the given chaser to intercept the given runner.
    
    Specified by:
    
    calculateIntercept in interface GalacticMap
    
    Parameters:
    
    chaserO - the chasing object
    
    runnerO - the running object
    
    maxChaserSpeed - the max chasing speed
    
    maxTicks - the maximum number of movements
    
    Returns:
    
    null if no intercept possible, or the new dir and speed
    
    See Also:
    
    GalacticMap.canMaybeIntercept(SpaceObject, SpaceObject, int, double)
  - calculateIntercept2
```
public Pair<double[],java.lang.Long> calculateIntercept2(SpaceObject chaserO,
                                                         SpaceObject runnerO,
                                                         long maxChaserSpeed,
                                                         int maxTicks)
```
  - getDirDiffSum
```
protected final double getDirDiffSum(double[] d1,
                                     double[] d2)
```
  - getMinDistanceFrom
```
public double getMinDistanceFrom(long[] prevPos,
                                 long[] curPos,
                                 long[] objPos)
```
    Description copied from interface: GalacticMap
    
    Given a previous position and a current position, this will return the minimum distance approached to the given object position.
    
    Specified by:
    
    getMinDistanceFrom in interface GalacticMap
    
    Parameters:
    
    prevPos - previous position on galactic chart
    
    curPos - current position on galactic chart
    
    objPos - the object position curious about minimum distance to
    
    Returns:
    
    the minimum distance in high precision
    
    See Also:
    
    GalacticMap.getDistanceFrom(long[], long[]), GalacticMap.getDistanceFrom(SpaceObject, SpaceObject), GalacticMap.getMinDistanceFrom(long[], long[], long[])
  - getOldMinDistFrom
```
protected double getOldMinDistFrom(long[] prevPos,
                                   double speed,
                                   double[] dir,
                                   long[] curPosition,
                                   double[] directionTo,
                                   long[] objPos)
```
  - getCurrentBattleCoveredDirections
```
public ShipDirectional.ShipDir[] getCurrentBattleCoveredDirections(ShipDirectional comp)
```
    Description copied from interface: GalacticMap
    
    Given a ship war component, returns the directions in which it is currently covering.
    
    Specified by:
    
    getCurrentBattleCoveredDirections in interface GalacticMap
    
    Parameters:
    
    comp - the war component
    
    Returns:
    
    the directions being covered
  - makeCourseCubeRay
```
protected BoundedObject.BoundedCube makeCourseCubeRay(long[] src,
                                                      long sradius,
                                                      long[] target,
                                                      long tradius,
                                                      double[] dir)
```
  - plotCourse
```
public java.util.List<long[]> plotCourse(long[] osrc,
                                         long sradius,
                                         long[] otarget,
                                         long tradius,
                                         int maxTicks)
```
    Description copied from interface: GalacticMap
    
    Plots a course from the source to the target, with a maximum number of steps/ticks. Will return a list of coordinates for the steps of the course. If the list contains the given otarget, then the plotting is complete. The list will never contain the source, as it is implied. If the course list comes back empty, then either something terrible went wrong, or the source is already close enough to the target for a course to be impossible.
    
    Specified by:
    
    plotCourse in interface GalacticMap
    
    Parameters:
    
    osrc - the source coordinates
    
    sradius - the source object radius
    
    otarget - the target coordinates
    
    tradius - the target object radius
    
    maxTicks - maximum number of direction changes .. always send something gt 0
    
    Returns:
    
    the step coordinates in the course, with the source implied
  - getGravityForce
```
public double getGravityForce(SpaceObject S,
                              SpaceObject cO)
```
    Description copied from interface: GalacticMap
    
    If the two given objects are within an appropriate distance from each other, this will return the correct amount of acceleration g-force applied by the second object to the first. typically <= 1G
    
    Specified by:
    
    getGravityForce in interface GalacticMap
    
    Parameters:
    
    S - the object being pulled
    
    cO - the object pulling
    
    Returns:
    
    the amount of gravity force, or 0
  - sendSpaceEmissionEvent
```
public boolean sendSpaceEmissionEvent(SpaceObject srcP,
                                      Environmental tool,
                                      int emissionType,
                                      java.lang.String msgStr)
```
    Description copied from interface: GalacticMap
    
    Generates an sends a message representing an emission in space, which might be picked up by various sensors. Includes broadcast messages.
    
    Specified by:
    
    sendSpaceEmissionEvent in interface GalacticMap
    
    Parameters:
    
    srcP - the generator of the event/the center
    
    tool - the means by which the event was generated
    
    emissionType - the CMMsg type of the event
    
    msgStr - a description of the sensory message
    
    Returns:
    
    true if the event was propogated
  - sendSpaceEmissionEvent
```
public boolean sendSpaceEmissionEvent(SpaceObject srcP,
                                      Environmental tool,
                                      long range,
                                      int emissionType,
                                      java.lang.String msgStr)
```
    Description copied from interface: GalacticMap
    
    Generates an sends a message representing an emission in space, which might be picked up by various sensors. Includes broadcast messages.
    
    Specified by:
    
    sendSpaceEmissionEvent in interface GalacticMap
    
    Parameters:
    
    srcP - the generator of the event/the center
    
    tool - the means by which the event was generated
    
    range - the range at which the emission can be detected
    
    emissionType - the CMMsg type of the event
    
    msgStr - a description of the sensory message
    
    Returns:
    
    true if the event was propogated
  - swapTargetTool
```
protected void swapTargetTool(CMMsg msg)
```
  - runSpace
```
public void runSpace()
```
  - activate
```
public boolean activate()
```
    Description copied from interface: CMLibrary
    
    Activates the library. This is called after the mud is booted, but before connections are accepted.
    
    Specified by:
    
    activate in interface CMLibrary
    
    Overrides:
    
    activate in class StdLibrary
    
    Returns:
    
    true if activation was successful, false if you're screwed
    
    See Also:
    
    CMLibrary.shutdown()
  - tick
```
public boolean tick(Tickable ticking,
                    int tickID)
```
    Description copied from interface: Tickable
    
    this is the method which is called periodically by the threading engine. How often it is called depends on the parameters passed to the threadding engine when it is submitted for thread access. Typically the period is once per TIME_TICK period, but that is determined when the object is submitted to the thread engine.
    
    Specified by:
    
    tick in interface Tickable
    
    Overrides:
    
    tick in class StdLibrary
    
    Parameters:
    
    ticking - a reference to this Tickable object
    
    tickID - the TICKID_ constant describing this periodic call, as defined in Tickable
    
    Returns:
    
    true always, unless this object no longer wishes to ever tick again, in which case false
    
    See Also:
    
    Tickable, ServiceEngine, TickableGroup
  - shutdown
```
public boolean shutdown()
```
    Description copied from interface: CMLibrary
    
    Shuts down the library. Called at system shutdown time obviously, but is sometimes called just to reset the library.
    
    Specified by:
    
    shutdown in interface CMLibrary
    
    Overrides:
    
    shutdown in class StdLibrary
    
    Returns:
    
    true if shutdown was successful, false if there's nothing you can do about it
    
    See Also:
    
    CMLibrary.activate()

Class CoffeeDark

Field Summary

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

Fields inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary

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

Constructor Summary

Method Summary

Methods inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.CMLibrary

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

Methods inherited from interface java.lang.Comparable

Methods inherited from class java.lang.Object

Methods inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary

Field Detail

ZERO_ALMOST

ZERO

ALMOST_ZERO

ONE

MIN_ONE

TWO

FOUR

TEN

ONE_THOUSAND

PI_ALMOST

PI_TIMES_2_ALMOST

PI_TIMES_2

PI_BY_2

PI_BY_12

PI_TIMES_1ANDAHALF

QUADRANT_WIDTH

space

sectorMap

Constructor Detail

CoffeeDark

Method Detail

ID

isObjectInSpace

delObjectInSpace

addObjectToSpace

addObjectToSpace

spaceAreas

getDistanceFrom

getDistanceFrom

getPerpendicularAngles

getPerpendicularPoints

getBigDistanceFrom

getSectorName

getInSectorCoords

getSectorMap

accelSpaceObject

getAngleDelta

getMiddleAngle

getOffsetAngle

applyAngleDiff

getAngleDiff

accelSpaceObject

fixDirectionBounds

changeDirection

changeDirection

getOppositeDir

getDirectionFromDir

getAbsoluteDirectionalFromDir

getDirection

moveSpaceObject

moveSpaceObject

moveSpaceObject

getDirection

getBigDirection

moveSpaceObject

getLocation

getRelativeSpeed

findSpaceObject

getSpaceObject

getSpaceObjects

getSpaceObjectEntries

getSpaceObjectsByCenterpointWithin

getSpaceObjectsInBound

getSpaceObjectsWithin

getLandingPoints

numSpaceObjects

bigSqrt