ObjectStatus (IHS AP CS Space Battle)

java.lang.Object
- ihs.apcs.spacebattle.ObjectStatus

```
public class ObjectStatus
extends java.lang.Object
```
A class to represent the status of a ship or other object. This class is used both to represent the current status of your ship in the Environment passed to Spaceship.getNextCommand(Environment) and the status of other objects found by a level 5 (fully-detailed) radar sweep.

Since:

0.1

Constructor Summary

Constructors
Constructor and Description

ObjectStatus()

Constructors
Constructor and Description
`ObjectStatus()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(ObjectStatus other)`
`int`	`getAxisMajorLength()` Gets the length of a Planet, BlackHole, or Nebula on its major axis.
`int`	`getAxisMinorLength()` Gets the length from the center of a Nebula that is perpendicular to the direction/rotation of the Nebula.
`java.lang.String[]`	`getCommandQueue()` Gets the list of `CommandNames` your Ship is currently executing.
`double`	`getEnergy()` Gets the current amount of energy this object has.
`double`	`getHealth()` Gets the current Health of this object.
`double`	`getHitRadius()` Gets the radius of the object needed for collision detection.
`int`	`getId()` Gets the object's Unique ID.
`long`	`getMass()` Gets this object's mass.
`double`	`getMaxEnergy()` Gets the maximum amount of energy this object could store.
`double`	`getMaxHealth()` Gets the maximum amount of health this object could have.
`double`	`getMaxShield()` Gets the maximum amount of Shields the Ship object could have.
`double`	`getMaxSpeed()` Gets the maximum speed this object can travel.
`double`	`getMovementDirection()` Get the actual direction of travel for this object.
`java.lang.String`	`getName()` Gets the name of a Ship object.
`int`	`getNumberStored()` Gets the number of cargo items carried by a Ship in a Game.
`int`	`getOrientation()` Gets the current Orientation of a Ship or Nebula.
`int`	`getOwnerId()` Gets the ID of the Owner of this object.
`Point`	`getPosition()` Gets the position of this object within the world (0, 0) is the upper-left and increases down and to the right.
`int`	`getPullStrength()` Gets the strength of the gravity or drag of a Planet, BlackHole or Nebula.
`int`	`getRadarRange()` Gets the radius from a Ship object that its radar can detect objects.
`double`	`getRechargeRate()` Gets the amount of energy this object restores per second.
`int`	`getRotationSpeed()` Gets the number of degrees this Ship can turn in a second (default is 120).
`double`	`getShieldLevel()` Gets the current Shield strength of a Ship.
`double`	`getSpeed()` Gets this object's current speed.
`double`	`getTimeAlive()` Gets the amount of time this object has lived in seconds.
`java.lang.String`	`getType()` String representation of the Type of Object.
`double`	`getValue()` Gets the point value worth of a Bubble, Bauble, or Ship in a Game.
`boolean`	`isInCelestialBody()` Is this object in a celestial object's body of effect?
`boolean`	`isSuccessful()` Was an object successfully scanned for a game? (Discovery Quest)
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ObjectStatus
```
public ObjectStatus()
```
- Method Detail
  - getId
```
public int getId()
```
    Gets the object's Unique ID. Note: Ship IDs will change when they are destroyed.
    
    Returns:
    a unique identifier for the object
  - getType
```
public java.lang.String getType()
```
    String representation of the Type of Object. Could be Ship, Planet, BlackHole, Star, Nebula, Asteroid, Dragon, Torpedo, Bauble, Bubble, or Outpost.
    
    Returns:
    name of the object's type.
  - getTimeAlive
```
public double getTimeAlive()
```
    Gets the amount of time this object has lived in seconds.
    
    Returns:
    seconds alive.
  - getPosition
```
public Point getPosition()
```
    Gets the position of this object within the world (0, 0) is the upper-left and increases down and to the right.
    
    Returns:
    the x, y position in pixel coordinates as a Point.
  - getSpeed
```
public double getSpeed()
```
    Gets this object's current speed. Combine with its direction to get a Velocity Vector.
    
    Returns:
    current speed in pixels per second
  - getMaxSpeed
```
public double getMaxSpeed()
```
    Gets the maximum speed this object can travel.
    
    Returns:
    upper-bound of obtainable speed
  - getMovementDirection
```
public double getMovementDirection()
```
    Get the actual direction of travel for this object. This may not equal its the direction it is facing (orientation) getOrientation()
    
    Returns:
    angle in degrees
  - getMass
```
public long getMass()
```
    Gets this object's mass.
    
    Returns:
    mass value.
  - getHealth
```
public double getHealth()
```
    Gets the current Health of this object. When an object has zero or less health, it is destroyed.
    
    Returns:
    health remaining.
  - getMaxHealth
```
public double getMaxHealth()
```
    Gets the maximum amount of health this object could have. (100 for Ships)
    
    Returns:
    upper-bound of health value.
  - getEnergy
```
public double getEnergy()
```
    Gets the current amount of energy this object has. This is only provided for your own ship. (i.e. You can't see other ship's energy levels through radar.)
    
    Returns:
    energy remaining.
  - getMaxEnergy
```
public double getMaxEnergy()
```
    Gets the maximum amount of energy this object could store. (100 for Ships)
    
    Returns:
    upper-bound of energy value.
  - getRechargeRate
```
public double getRechargeRate()
```
    Gets the amount of energy this object restores per second.
    
    Returns:
    energy per second restored.
  - getOrientation
```
public int getOrientation()
```
    Gets the current Orientation of a Ship or Nebula.
    
    Returns:
    the orientation in degrees.
  - getRotationSpeed
```
public int getRotationSpeed()
```
    Gets the number of degrees this Ship can turn in a second (default is 120).
    
    Returns:
    speed in degrees per second the ship can rotate.
  - getShieldLevel
```
public double getShieldLevel()
```
    Gets the current Shield strength of a Ship.
    
    Returns:
    shields remaining.
  - getMaxShield
```
public double getMaxShield()
```
    Gets the maximum amount of Shields the Ship object could have. (default is 100)
    
    Returns:
    upper-bound of shield value.
  - getRadarRange
```
public int getRadarRange()
```
    Gets the radius from a Ship object that its radar can detect objects.
    
    Returns:
    radar radius.
  - getCommandQueue
```
public java.lang.String[] getCommandQueue()
```
    Gets the list of CommandNames your Ship is currently executing. This is only provided for your own ship. (i.e. You can't see other ship's queues through radar.) If the last command requested was a blocking command, it will have finished before this list is populated.
    
    Returns:
    commands still being executed
  - isInCelestialBody
```
public boolean isInCelestialBody()
```
    Is this object in a celestial object's body of effect?
    
    Returns:
    true if a ship is in a celestial body's main area of effect (could be false but in gravity well still getAxisMajorLength()). A celestial body will return true if it contains an object like a ship.
    Since:
    
    1.1
  - isSuccessful
```
public boolean isSuccessful()
```
    Was an object successfully scanned for a game? (Discovery Quest)
    
    Returns:
    true if this object has a value of success for the current game. i.e. Successfully scanned in Discovery Quest.
    Since:
    
    1.1
  - getValue
```
public double getValue()
```
    Gets the point value worth of a Bubble, Bauble, or Ship in a Game.
    
    Returns:
    point value.
  - getNumberStored
```
public int getNumberStored()
```
    Gets the number of cargo items carried by a Ship in a Game.
    
    Returns:
    number of items/points
  - getHitRadius
```
public double getHitRadius()
```
    Gets the radius of the object needed for collision detection. This tells you an object's radius.
    
    Returns:
    the radius of the object from its getPosition()
  - getPullStrength
```
public int getPullStrength()
```
    Gets the strength of the gravity or drag of a Planet, BlackHole or Nebula. A higher number represents a stronger effect.
    
    Returns:
    pull value.
    Since:
    
    1.0
  - getAxisMajorLength
```
public int getAxisMajorLength()
```
    Gets the length of a Planet, BlackHole, or Nebula on its major axis. For Planets and BlackHoles, the Major and Minor lengths will be the same.
    For Planets and BlackHoles this length represents the size of the gravitational field around it. The getPullStrength() method will tell you how much it will effect your ship.
    For Nebula this length is oriented in the Nebula's direction/rotation see getOrientation() and represents its major radius. If your ship is in the Nebula, it will slow down based on the getPullStrength() amount.
    
    Returns:
    the elliptical radius along the parallel axis
    Since:
    
    1.0
  - getAxisMinorLength
```
public int getAxisMinorLength()
```
    Gets the length from the center of a Nebula that is perpendicular to the direction/rotation of the Nebula.
    
    Returns:
    the elliptical radius along the perpendicular axis
    Since:
    
    1.0
  - getOwnerId
```
public int getOwnerId()
```
    Gets the ID of the Owner of this object. This could be who fired a Torpedo or who owns an Outpost (Bauble Hunt).
    
    Returns:
    the owner id of this object (if any)
  - getName
```
public java.lang.String getName()
```
    Gets the name of a Ship object. (may be turned off on the server but see getType())
    
    Returns:
    a name of a Ship
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - equals
```
public boolean equals(ObjectStatus other)
```

Class ObjectStatus

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ObjectStatus

Method Detail

getId

getType

getTimeAlive

getPosition

getSpeed

getMaxSpeed

getMovementDirection

getMass

getHealth

getMaxHealth

getEnergy

getMaxEnergy

getRechargeRate

getOrientation

getRotationSpeed

getShieldLevel

getMaxShield

getRadarRange

getCommandQueue

isInCelestialBody

isSuccessful

getValue

getNumberStored

getHitRadius

getPullStrength

getAxisMajorLength

getAxisMinorLength

getOwnerId

getName

toString

equals