Package robocode

Class RobotStatus

java.lang.Object
robocode.RobotStatus
All Implemented Interfaces:
Serializable

public final class RobotStatus extends Object implements Serializable
Contains the status of a robot for a specific time/turn returned by StatusEvent.getStatus().
Since:
1.5
Author:
Flemming N. Larsen (original)
See Also:
  • Method Summary

    Modifier and Type
    Method
    Description
    double
    Returns the distance remaining in the robot's current move measured in pixels.
    double
    Returns the robot's current energy.
    double
    Returns the direction that the robot's gun is facing, in degrees.
    double
    Returns the direction that the robot's gun is facing, in radians.
    double
    Returns the current heat of the gun.
    double
    Returns the angle remaining in the gun's turn, in degrees.
    double
    Returns the angle remaining in the gun's turn, in radians.
    double
    Returns the direction that the robot's body is facing, in degrees.
    double
    Returns the direction that the robot's body is facing, in radians.
    int
    Returns the number of rounds in the current battle.
    int
    Returns how many sentry robots that are left in the current round.
    int
    Returns how many opponents that are left in the current round.
    double
    Returns the direction that the robot's radar is facing, in degrees.
    double
    Returns the direction that the robot's radar is facing, in radians.
    double
    Returns the angle remaining in the radar's turn, in degrees.
    double
    Returns the angle remaining in the radar's turn, in radians.
    int
    Returns the current round number (0 to getNumRounds() - 1) of the battle.
    long
    Returns the game time of the round, where the time is equal to the current turn in the round.
    double
    Returns the angle remaining in the robots's turn, in degrees.
    double
    Returns the angle remaining in the robots's turn, in radians.
    double
    Returns the velocity of the robot measured in pixels/turn.
    double
    Returns the X position of the robot.
    double
    Returns the Y position of the robot.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Method Details

    • getEnergy

      public double getEnergy()
      Returns the robot's current energy.
      Returns:
      the robot's current energy
    • getX

      public double getX()
      Returns the X position of the robot. (0,0) is at the bottom left of the battlefield.
      Returns:
      the X position of the robot
      See Also:
    • getY

      public double getY()
      Returns the Y position of the robot. (0,0) is at the bottom left of the battlefield.
      Returns:
      the Y position of the robot
      See Also:
    • getHeadingRadians

      public double getHeadingRadians()
      Returns the direction that the robot's body is facing, in radians. The value returned will be between 0 and 2 * PI (is excluded).

      Note that the heading in Robocode is like a compass, where 0 means North, PI / 2 means East, PI means South, and 3 * PI / 2 means West.

      Returns:
      the direction that the robot's body is facing, in radians.
    • getHeading

      public double getHeading()
      Returns the direction that the robot's body is facing, in degrees. The value returned will be between 0 and 360 (is excluded).

      Note that the heading in Robocode is like a compass, where 0 means North, 90 means East, 180 means South, and 270 means West.

      Returns:
      the direction that the robot's body is facing, in degrees.
    • getGunHeadingRadians

      public double getGunHeadingRadians()
      Returns the direction that the robot's gun is facing, in radians. The value returned will be between 0 and 2 * PI (is excluded).

      Note that the heading in Robocode is like a compass, where 0 means North, PI / 2 means East, PI means South, and 3 * PI / 2 means West.

      Returns:
      the direction that the robot's gun is facing, in radians.
    • getGunHeading

      public double getGunHeading()
      Returns the direction that the robot's gun is facing, in degrees. The value returned will be between 0 and 360 (is excluded).

      Note that the heading in Robocode is like a compass, where 0 means North, 90 means East, 180 means South, and 270 means West.

      Returns:
      the direction that the robot's gun is facing, in degrees.
    • getRadarHeadingRadians

      public double getRadarHeadingRadians()
      Returns the direction that the robot's radar is facing, in radians. The value returned will be between 0 and 2 * PI (is excluded).

      Note that the heading in Robocode is like a compass, where 0 means North, PI / 2 means East, PI means South, and 3 * PI / 2 means West.

      Returns:
      the direction that the robot's radar is facing, in radians.
    • getRadarHeading

      public double getRadarHeading()
      Returns the direction that the robot's radar is facing, in degrees. The value returned will be between 0 and 360 (is excluded).

      Note that the heading in Robocode is like a compass, where 0 means North, 90 means East, 180 means South, and 270 means West.

      Returns:
      the direction that the robot's radar is facing, in degrees.
    • getVelocity

      public double getVelocity()
      Returns the velocity of the robot measured in pixels/turn.

      The maximum velocity of a robot is defined by Rules.MAX_VELOCITY (8 pixels / turn).

      Returns:
      the velocity of the robot measured in pixels/turn
      See Also:
    • getTurnRemainingRadians

      public double getTurnRemainingRadians()
      Returns the angle remaining in the robots's turn, in radians.

      This call returns both positive and negative values. Positive values means that the robot is currently turning to the right. Negative values means that the robot is currently turning to the left.

      Returns:
      the angle remaining in the robots's turn, in radians
    • getTurnRemaining

      public double getTurnRemaining()
      Returns the angle remaining in the robots's turn, in degrees.

      This call returns both positive and negative values. Positive values means that the robot is currently turning to the right. Negative values means that the robot is currently turning to the left.

      Returns:
      the angle remaining in the robots's turn, in degrees
    • getRadarTurnRemainingRadians

      public double getRadarTurnRemainingRadians()
      Returns the angle remaining in the radar's turn, in radians.

      This call returns both positive and negative values. Positive values means that the radar is currently turning to the right. Negative values means that the radar is currently turning to the left.

      Returns:
      the angle remaining in the radar's turn, in radians
    • getRadarTurnRemaining

      public double getRadarTurnRemaining()
      Returns the angle remaining in the radar's turn, in degrees.

      This call returns both positive and negative values. Positive values means that the radar is currently turning to the right. Negative values means that the radar is currently turning to the left.

      Returns:
      the angle remaining in the radar's turn, in degrees
    • getGunTurnRemainingRadians

      public double getGunTurnRemainingRadians()
      Returns the angle remaining in the gun's turn, in radians.

      This call returns both positive and negative values. Positive values means that the gun is currently turning to the right. Negative values means that the gun is currently turning to the left.

      Returns:
      the angle remaining in the gun's turn, in radians
    • getGunTurnRemaining

      public double getGunTurnRemaining()
      Returns the angle remaining in the gun's turn, in degrees.

      This call returns both positive and negative values. Positive values means that the gun is currently turning to the right. Negative values means that the gun is currently turning to the left.

      Returns:
      the angle remaining in the gun's turn, in degrees
    • getDistanceRemaining

      public double getDistanceRemaining()
      Returns the distance remaining in the robot's current move measured in pixels.

      This call returns both positive and negative values. Positive values means that the robot is currently moving forwards. Negative values means that the robot is currently moving backwards.

      Returns:
      the distance remaining in the robot's current move measured in pixels.
    • getGunHeat

      public double getGunHeat()
      Returns the current heat of the gun. The gun cannot fire unless this is 0. (Calls to fire will succeed, but will not actually fire unless getGunHeat() == 0).

      The amount of gun heat generated when the gun is fired is 1 + (firePower / 5). Each turn the gun heat drops by the amount returned by Robot.getGunCoolingRate(), which is a battle setup.

      Note that all guns are "hot" at the start of each round, where the gun heat is 3.

      Returns:
      the current gun heat
      See Also:
    • getOthers

      public int getOthers()
      Returns how many opponents that are left in the current round.
      Returns:
      how many opponents that are left in the current round.
      Since:
      1.6.2
      See Also:
    • getNumSentries

      public int getNumSentries()
      Returns how many sentry robots that are left in the current round.
      Returns:
      how many sentry robots that are left in the current round.
      Since:
      1.9.1.0
      See Also:
    • getNumRounds

      public int getNumRounds()
      Returns the number of rounds in the current battle.
      Returns:
      the number of rounds in the current battle
      Since:
      1.6.2
      See Also:
    • getRoundNum

      public int getRoundNum()
      Returns the current round number (0 to getNumRounds() - 1) of the battle.
      Returns:
      the current round number of the battle (zero indexed).
      Since:
      1.6.2
      See Also:
    • getTime

      public long getTime()
      Returns the game time of the round, where the time is equal to the current turn in the round.
      Returns:
      the game time/turn of the current round.
      Since:
      1.6.2