com.planet_ink.coffee_mud.core.interfaces
Interface SpaceObject

All Superinterfaces:

java.lang.Cloneable, CMObject, java.lang.Comparable<CMObject>, Contingent, Environmental, Modifiable, MsgListener, StatsAffecting, Tickable

All Known Subinterfaces:

SpaceShip

All Known Implementing Classes:

StdPlanet, StdSpaceShip

public interface SpaceObject
extends Environmental

This interface is still in development. It will some day represent an object in space

Field Summary

static long	DISTANCE_AROUNDGALAXY distance constant useful for coordinates, is 1 galaxy
static long	DISTANCE_LIGHTYEAR distance constant useful for coordinates, is 1 lightyear
static long	DISTANCE_MILE distance constant useful for coordinates, is 1 mile
static long	DISTANCE_ORBITING distance constant useful for coordinates, is 1 orbit
static long	DISTANCE_PLANETRADIUS distance constant useful for coordinates, is 1 planet
static long	VELOCITY_ESCAPE velocity constant for the speed required to escape 1g
static long	VELOCITY_LIGHT velocity constant for the speed of light
static long	VELOCITY_ORBITING velocity constant for the speed of orbiting
static long	VELOCITY_SOUND velocity constant for the speed of sound
static long	VELOCITY_SUBLIGHT velocity constant for the speed of sublight
static long	VELOCITY_TRANSWARP1 velocity constant for the speed transwarp 1
static long	VELOCITY_TRANSWARP10 velocity constant for the speed transwarp 10
static long	VELOCITY_TRANSWARP2 velocity constant for the speed transwarp 2
static long	VELOCITY_TRANSWARP3 velocity constant for the speed transwarp 3
static long	VELOCITY_TRANSWARP4 velocity constant for the speed transwarp 4
static long	VELOCITY_TRANSWARP5 velocity constant for the speed transwarp 5
static long	VELOCITY_TRANSWARP6 velocity constant for the speed transwarp 6
static long	VELOCITY_TRANSWARP7 velocity constant for the speed transwarp 7
static long	VELOCITY_TRANSWARP8 velocity constant for the speed transwarp 8
static long	VELOCITY_TRANSWARP9 velocity constant for the speed transwarp 9
static long	VELOCITY_WARP1 velocity constant for the speed warp 1
static long	VELOCITY_WARP10 velocity constant for the speed warp 10
static long	VELOCITY_WARP2 velocity constant for the speed warp 2
static long	VELOCITY_WARP3 velocity constant for the speed warp 3
static long	VELOCITY_WARP4 velocity constant for the speed warp 4
static long	VELOCITY_WARP5 velocity constant for the speed warp 5
static long	VELOCITY_WARP6 velocity constant for the speed warp 6
static long	VELOCITY_WARP7 velocity constant for the speed warp 7
static long	VELOCITY_WARP8 velocity constant for the speed warp 8
static long	VELOCITY_WARP9 velocity constant for the speed warp 9

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_CLAN, TICKID_CLANITEM, TICKID_DEADBODY_DECAY, TICKID_EMAIL, TICKID_EXIT_BEHAVIOR, TICKID_EXIT_REOPEN, TICKID_ITEM_BEHAVIOR, TICKID_ITEM_BOUNCEBACK, TICKID_LIGHT_FLICKERS, TICKID_LIVEAUCTION, TICKID_LONGERMASK, TICKID_MOB, TICKID_QUEST, TICKID_READYTOSTOP, TICKID_ROOM_BEHAVIOR, TICKID_ROOM_ITEM_REJUV, TICKID_SPELL_AFFECT, TICKID_TIMEAUCTION, TICKID_TRAP_DESTRUCTION, TICKID_TRAP_RESET, TICKMASK_SOLITARY

Method Summary

long	accelleration() Gets the current accelleration rate of the object, per tick
long[]	coordinates() The current absolute coordinates of the object
double[]	direction() The direction of travel of this object in radians.
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
SpaceObject	orbiting() If this object is in orbit about another, what is that other
void	setAccelleration(long v) Sets the current accelleration rate of the object, per tick
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	setOrbiting(SpaceObject O) Sets this object in orbit about another
void	setVelocity(long v) Sets the velocify of the object through space
long	velocity() The velocity of the object through space

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

description, displayText, expirationDate, image, isGeneric, maxRange, minRange, miscTextFormat, name, Name, rawImage, sameAs, setDescription, setDisplayText, setExpirationDate, setImage, setMiscText, setName, text

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

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

Field Detail

DISTANCE_MILE

static final long DISTANCE_MILE

distance constant useful for coordinates, is 1 mile

See Also:

Constant Field Values

DISTANCE_LIGHTYEAR

static final long DISTANCE_LIGHTYEAR

distance constant useful for coordinates, is 1 lightyear

See Also:

Constant Field Values

DISTANCE_AROUNDGALAXY

static final long DISTANCE_AROUNDGALAXY

distance constant useful for coordinates, is 1 galaxy

See Also:

Constant Field Values

DISTANCE_PLANETRADIUS

static final long DISTANCE_PLANETRADIUS

distance constant useful for coordinates, is 1 planet

See Also:

Constant Field Values

DISTANCE_ORBITING

static final long DISTANCE_ORBITING

distance constant useful for coordinates, is 1 orbit

See Also:

Constant Field Values

VELOCITY_LIGHT

static final long VELOCITY_LIGHT

velocity constant for the speed of light

See Also:

Constant Field Values

VELOCITY_SUBLIGHT

static final long VELOCITY_SUBLIGHT

velocity constant for the speed of sublight

See Also:

Constant Field Values

VELOCITY_SOUND

static final long VELOCITY_SOUND

velocity constant for the speed of sound

See Also:

Constant Field Values

VELOCITY_ORBITING

static final long VELOCITY_ORBITING

velocity constant for the speed of orbiting

See Also:

Constant Field Values

VELOCITY_ESCAPE

static final long VELOCITY_ESCAPE

velocity constant for the speed required to escape 1g

See Also:

Constant Field Values

VELOCITY_WARP1

static final long VELOCITY_WARP1

velocity constant for the speed warp 1

See Also:

Constant Field Values

VELOCITY_WARP2

static final long VELOCITY_WARP2

velocity constant for the speed warp 2

See Also:

Constant Field Values

VELOCITY_WARP3

static final long VELOCITY_WARP3

velocity constant for the speed warp 3

See Also:

Constant Field Values

VELOCITY_WARP4

static final long VELOCITY_WARP4

velocity constant for the speed warp 4

See Also:

Constant Field Values

VELOCITY_WARP5

static final long VELOCITY_WARP5

velocity constant for the speed warp 5

See Also:

Constant Field Values

VELOCITY_WARP6

static final long VELOCITY_WARP6

velocity constant for the speed warp 6

See Also:

Constant Field Values

VELOCITY_WARP7

static final long VELOCITY_WARP7

velocity constant for the speed warp 7

See Also:

Constant Field Values

VELOCITY_WARP8

static final long VELOCITY_WARP8

velocity constant for the speed warp 8

See Also:

Constant Field Values

VELOCITY_WARP9

static final long VELOCITY_WARP9

velocity constant for the speed warp 9

See Also:

Constant Field Values

VELOCITY_WARP10

static final long VELOCITY_WARP10

velocity constant for the speed warp 10

See Also:

Constant Field Values

VELOCITY_TRANSWARP1

static final long VELOCITY_TRANSWARP1

velocity constant for the speed transwarp 1

See Also:

Constant Field Values

VELOCITY_TRANSWARP2

static final long VELOCITY_TRANSWARP2

velocity constant for the speed transwarp 2

See Also:

Constant Field Values

VELOCITY_TRANSWARP3

static final long VELOCITY_TRANSWARP3

velocity constant for the speed transwarp 3

See Also:

Constant Field Values

VELOCITY_TRANSWARP4

static final long VELOCITY_TRANSWARP4

velocity constant for the speed transwarp 4

See Also:

Constant Field Values

VELOCITY_TRANSWARP5

static final long VELOCITY_TRANSWARP5

velocity constant for the speed transwarp 5

See Also:

Constant Field Values

VELOCITY_TRANSWARP6

static final long VELOCITY_TRANSWARP6

velocity constant for the speed transwarp 6

See Also:

Constant Field Values

VELOCITY_TRANSWARP7

static final long VELOCITY_TRANSWARP7

velocity constant for the speed transwarp 7

See Also:

Constant Field Values

VELOCITY_TRANSWARP8

static final long VELOCITY_TRANSWARP8

velocity constant for the speed transwarp 8

See Also:

Constant Field Values

VELOCITY_TRANSWARP9

static final long VELOCITY_TRANSWARP9

velocity constant for the speed transwarp 9

See Also:

Constant Field Values

VELOCITY_TRANSWARP10

static final long VELOCITY_TRANSWARP10

velocity constant for the speed transwarp 10

See Also:

Constant Field Values

Method Detail

coordinates

long[] coordinates()

The current absolute coordinates of the object

Returns:

2 dimensional array of the coordinates

setCoords

void setCoords(long[] coords)

Sets the current absolute coordinates of the object

Parameters:

coords - 2 dimensional array of the coordinates in space

direction

double[] direction()

The direction of travel of this object in radians.

Returns:

2 dimensional array for the direction of movement

setDirection

void setDirection(double[] dir)

Sets the direction of travel of this object in radians.

Parameters:

dir - 2 dimensional array for the direction of movement

velocity

long velocity()

The velocity of the object through space

Returns:

the velocity

setVelocity

void setVelocity(long v)

Sets the velocify of the object through space

Parameters:

v - the velocity

accelleration

long accelleration()

Gets the current accelleration rate of the object, per tick

Returns:

the current accelleration rate

setAccelleration

void setAccelleration(long v)

Sets the current accelleration rate of the object, per tick

Parameters:

v - current accelleration rate

knownTarget

SpaceObject knownTarget()

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

Returns:

the target destination

setKnownTarget

void setKnownTarget(SpaceObject O)

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

Parameters:

O - the target destination

knownSource

SpaceObject knownSource()

The source object from which this space object is travelling from

Returns:

the source of this object

setKnownSource

void setKnownSource(SpaceObject O)

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

Parameters:

O - the source of this object

orbiting

SpaceObject orbiting()

If this object is in orbit about another, what is that other

Returns:

the object about which this one is orbiting

setOrbiting

void setOrbiting(SpaceObject O)

Sets this object in orbit about another

Parameters:

O - the object about which this one is orbiting