Interface IBaseBot

All Known Subinterfaces:
IBot
All Known Implementing Classes:
BaseBot, Bot
public interface IBaseBot
Interface containing the core API for a bot.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    MAX_NUMBER_OF_TEAM_MESSAGES_PER_TURN
    The maximum number of team messages that can be sent per turn, which is 10 messages.
    static final int
    TEAM_MESSAGE_MAX_SIZE
    The maximum size of a team message, which is 32 KB (32.786 bytes).

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    addCustomEvent(Condition condition)
    Adds an event handler that will be automatically triggered onCustomEvent(dev.robocode.tankroyale.botapi.events.CustomEvent) when the Condition.test() returns true.
    default double
    bearingTo(double x, double y)
    Calculates the bearing (delta angle) between the current direction of the bot´s body and the direction to the point x,y.
    void
    broadcastTeamMessage(Object message)
    Broadcasts a message to all teammates.

    When the message is send, it is serialized into a JSON representation, meaning that all public fields, and only public fields, are being serialized into a JSON representation as a DTO (data transfer object).

    The maximum team message size limit is defined by TEAM_MESSAGE_MAX_SIZE, which is set to 32768 bytes.
    default double
    calcBearing(double direction)
    Calculates the bearing (delta angle) between the input direction and the direction of this bot.
    double
    calcBulletSpeed(double firepower)
    Calculates the bullet speed given a firepower.
    default double
    calcDeltaAngle(double targetAngle, double sourceAngle)
    Calculates the difference between two angles, i.e.
    default double
    calcGunBearing(double direction)
    Calculates the bearing (delta angle) between the input direction and the direction of the gun.
    double
    calcGunHeat(double firepower)
    Calculates gun heat after having fired the gun.
    double
    calcMaxTurnRate(double speed)
    Calculates the maximum turn rate for a specific speed.
    default double
    calcRadarBearing(double direction)
    Calculates the bearing (delta angle) between the input direction and the direction of the radar.
    void
    clearEvents()
    Clears out any pending events in the bot's event queue immediately.
    default double
    directionTo(double x, double y)
    Calculates the direction (angle) from the bot´s coordinates to a point x,y.
    default double
    distanceTo(double x, double y)
    Calculates the distance from the bots coordinates to a point x,y.
    int
    getArenaHeight()
    Height of the arena measured in units.
    int
    getArenaWidth()
    Width of the arena measured in units.
    Color
    getBodyColor()
    Returns the color of the body.
    Color
    getBulletColor()
    Returns the color of the fired bullets.
    Collection<BulletState>
    getBulletStates()
    Current bullet states.
    double
    getDirection()
    Current driving direction of the bot in degrees.
    int
    getEnemyCount()
    Number of enemies left in the round.
    double
    getEnergy()
    Current energy level.
    int
    getEventPriority(Class<BotEvent> eventClass)
    Returns the event priority for a specific event class.
    List<BotEvent>
    getEvents()
    Returns an ordered list containing all events currently in the bot's event queue.
    double
    getFirepower()
    Returns the firepower.
    String
    getGameType()
    Game type, e.g.
    Graphics2D
    getGraphics()
    Gets a graphics object that the bot can paint debug information to.
    Color
    getGunColor()
    Returns the color of the gun.
    double
    getGunCoolingRate()
    Gun cooling rate.
    double
    getGunDirection()
    Current direction of the gun in degrees.
    double
    getGunHeat()
    Current gun heat.
    double
    getGunTurnRate()
    Returns the gun turn rate in degrees per turn.
    double
    getMaxGunTurnRate()
    Returns the maximum gun turn rate in degrees per turn.
    int
    getMaxInactivityTurns()
    The maximum number of inactive turns allowed the bot will become zapped by the game for being inactive.
    double
    getMaxRadarTurnRate()
    Returns the maximum radar turn rate in degrees per turn.
    double
    getMaxSpeed()
    Returns the maximum speed in units per turn.
    double
    getMaxTurnRate()
    Returns the maximum turn rate of the bot in degrees per turn.
    int
    getMyId()
    Unique id of this bot, which is available when the game has started.
    int
    getNumberOfRounds()
    The number of rounds in a battle.
    Color
    getRadarColor()
    Returns the color of the radar.
    double
    getRadarDirection()
    Current direction of the radar in degrees.
    double
    getRadarTurnRate()
    Returns the radar turn rate in degrees per turn.
    int
    getRoundNumber()
    Current round number.
    Color
    getScanColor()
    Returns the color of the scan arc.
    double
    getSpeed()
    The current speed measured in units per turn.
    double
    getTargetSpeed()
    Returns the target speed in units per turn.
    Set<Integer>
    getTeammateIds()
    Returns the ids of all teammates.
    int
    getTimeLeft()
    The number of microseconds left of this turn before the bot will skip the turn.
    Color
    getTracksColor()
    Returns the color of the tracks.
    int
    getTurnNumber()
    Current turn number.
    double
    getTurnRate()
    Returns the turn rate of the bot in degrees per turn.
    int
    getTurnTimeout()
    The turn timeout is important as the bot needs to take action by calling go() before the turn timeout occurs.
    Color
    getTurretColor()
    Returns the color of the gun turret.
    String
    getVariant()
    The game variant, which is "Tank Royale".
    String
    getVersion()
    Game version, e.g.
    double
    getX()
    Current X coordinate of the center of the bot.
    double
    getY()
    Current Y coordinate of the center of the bot.
    void
    go()
    Commits the current commands (actions), which finalizes the current turn for the bot.
    default double
    gunBearingTo(double x, double y)
    Calculates the bearing (delta angle) between the current direction of the bot´s gun and the direction to the point x,y.
    boolean
    isAdjustGunForBodyTurn()
    Checks if the gun is set to adjust for the bot turning, i.e.
    boolean
    isAdjustRadarForBodyTurn()
    Checks if the radar is set to adjust for the body turning, i.e.
    boolean
    isAdjustRadarForGunTurn()
    Checks if the radar is set to adjust for the gun turning, i.e.
    boolean
    isDebuggingEnabled()
    Flag indicating if graphical debugging is enabled and hence if getGraphics() can be used for debug painting.
    boolean
    isDisabled()
    Specifies if the bot is disabled, i.e., when the energy is zero.
    boolean
    isStopped()
    Checks if the movement has been stopped.
    boolean
    isTeammate(int botId)
    Checks if the provided bot id is a teammate or not.
    default double
    normalizeAbsoluteAngle(double angle)
    Normalizes an angle to an absolute angle into the range [0,360[
    default double
    normalizeRelativeAngle(double angle)
    Normalizes an angle to a relative angle into the range [-180,180[
    default void
    onBotDeath(BotDeathEvent botDeathEvent)
    The event handler triggered when another bot has died.
    default void
    onBulletFired(BulletFiredEvent bulletFiredEvent)
    The event handler triggered when the bot has fired a bullet.
    default void
    onBulletHit(BulletHitBotEvent bulletHitBotEvent)
    The event handler triggered when the bot has hit another bot with a bullet.
    default void
    onBulletHitBullet(BulletHitBulletEvent bulletHitBulletEvent)
    The event handler triggered when a bullet fired from the bot has collided with another bullet.
    default void
    onBulletHitWall(BulletHitWallEvent bulletHitWallEvent)
    The event handler triggered when a bullet has hit a wall.
    default void
    onConnected(ConnectedEvent connectedEvent)
    The event handler triggered when connected to the server.
    default void
    onConnectionError(ConnectionErrorEvent connectionErrorEvent)
    The event handler triggered when a connection error occurs.
    default void
    onCustomEvent(CustomEvent customEvent)
    The event handler triggered when some condition has been met.
    default void
    onDeath(DeathEvent deathEvent)
    The event handler triggered when this bot has died.
    default void
    onDisconnected(DisconnectedEvent disconnectedEvent)
    The event handler triggered when disconnected from the server.
    default void
    onGameEnded(GameEndedEvent gameEndedEvent)
    The event handler triggered when a game has ended.
    default void
    onGameStarted(GameStartedEvent gameStatedEvent)
    The event handler triggered when a game has started.
    default void
    onHitBot(HitBotEvent botHitBotEvent)
    The event handler triggered when the bot has collided with another bot.
    default void
    onHitByBullet(HitByBulletEvent hitByBulletEvent)
    The event handler triggered when the bot has been hit by a bullet.
    default void
    onHitWall(HitWallEvent botHitWallEvent)
    The event handler triggered when the bot has hit a wall.
    default void
    onRoundEnded(RoundEndedEvent roundEndedEvent)
    The event handler triggered when a round has ended.
    default void
    onRoundStarted(RoundStartedEvent roundStartedEvent)
    The event handler triggered when a new round has started.
    default void
    onScannedBot(ScannedBotEvent scannedBotEvent)
    The event handler triggered when the bot has skipped a turn.
    default void
    onSkippedTurn(SkippedTurnEvent skippedTurnEvent)
    The event handler triggered when the bot has skipped a turn.
    default void
    onTeamMessage(TeamMessageEvent teamMessageEvent)
    The event handler triggered when the bot has received a message from a teammate.
    default void
    onTick(TickEvent tickEvent)
    The event handler triggered when a game tick event occurs, i.e., when a new turn in a round has started.
    default void
    onWonRound(WonRoundEvent wonRoundEvent)
    The event handler triggered when the bot has won a round.
    default double
    radarBearingTo(double x, double y)
    Calculates the bearing (delta angle) between the current direction of the bot´s radar and the direction to the point x,y.
    boolean
    removeCustomEvent(Condition condition)
    Removes triggering a custom event handler for a specific condition that was previously added with addCustomEvent(dev.robocode.tankroyale.botapi.events.Condition).
    void
    sendTeamMessage(int teammateId, Object message)
    Sends a message to a specific teammate.

    When the message is sent, it is serialized into a JSON representation, meaning that all public fields, and only public fields, are being serialized into a JSON representation as a DTO (data transfer object).

    The maximum team message size limit is defined by TEAM_MESSAGE_MAX_SIZE, which is set to 32768 bytes.
    void
    setAdjustGunForBodyTurn(boolean adjust)
    Sets the gun to adjust for the bot´s turn when setting the gun turn rate.
    void
    setAdjustRadarForBodyTurn(boolean adjust)
    Sets the radar to adjust for the body's turn when setting the radar turn rate.
    void
    setAdjustRadarForGunTurn(boolean adjust)
    Sets the radar to adjust for the gun's turn when setting the radar turn rate.
    void
    setBodyColor(Color color)
    Sets the color of the body.
    void
    setBulletColor(Color color)
    Sets the color of the fired bullets.
    void
    setEventPriority(Class<BotEvent> eventClass, int priority)
    Changes the event priority for an event class.
    boolean
    setFire(double firepower)
    Sets the gun to fire in the direction that the gun is pointing with the specified firepower.
    void
    setFireAssist(boolean enable)
    Enables or disables fire assistance explicitly.
    void
    setGunColor(Color color)
    Sets the color of the gun.
    void
    setGunTurnRate(double gunTurnRate)
    Sets the turn rate of the gun, which can be positive and negative.
    void
    setInterruptible(boolean interruptible)
    Call this method during an event handler to control continuing or restarting the event handler, when a new event occurs again for the same event handler while processing an earlier event.
    void
    setMaxGunTurnRate(double maxGunTurnRate)
    Sets the maximum turn rate which applies to turn the gun to the left or right.
    void
    setMaxRadarTurnRate(double maxRadarTurnRate)
    Sets the maximum turn rate which applies to turn the radar to the left or right.
    void
    setMaxSpeed(double maxSpeed)
    Sets the maximum speed which applies when moving forward and backward.
    void
    setMaxTurnRate(double maxTurnRate)
    Sets the maximum turn rate which applies to turn the bot to the left or right.
    void
    setRadarColor(Color color)
    Sets the color of the radar.
    void
    setRadarTurnRate(double gunRadarTurnRate)
    Sets the turn rate of the radar, which can be positive and negative.
    void
    setRescan()
    Sets the bot to rescan with the radar.
    void
    setResume()
    Sets the bot to scan (again) with the radar.
    void
    setScanColor(Color color)
    Sets the color of the scan arc.
    void
    setStop()
    Set the bot to stop all movement including turning the gun and radar.
    void
    setStop(boolean overwrite)
    Set the bot to stop all movement including turning the gun and radar.
    void
    setTargetSpeed(double targetSpeed)
    Sets the new target speed for the bot in units per turn.
    void
    setTracksColor(Color color)
    Sets the color of the tracks.
    void
    setTurnRate(double turnRate)
    Sets the turn rate of the bot, which can be positive and negative.
    void
    setTurretColor(Color color)
    Sets the color of the gun turret.
    void
    start()
    The method used to start running the bot.

  • Field Details

    • TEAM_MESSAGE_MAX_SIZE

      static final int TEAM_MESSAGE_MAX_SIZE
      The maximum size of a team message, which is 32 KB (32.786 bytes).
      See Also:

    • MAX_NUMBER_OF_TEAM_MESSAGES_PER_TURN

      static final int MAX_NUMBER_OF_TEAM_MESSAGES_PER_TURN
      The maximum number of team messages that can be sent per turn, which is 10 messages.
      See Also:

  • Method Details

    • start

      void start()
      The method used to start running the bot. You should call this method from the main method or similar.

      Example: 

      
 public void main(String[] args) {
     // create myBot
     ...
     myBot.start();
 }

    • go

      void go()
      Commits the current commands (actions), which finalizes the current turn for the bot.

      This method must be called once per turn to send the bot actions to the server and must be called before the turn timeout occurs. A turn timer is started when the GameStartedEvent and TickEvent occurs. If the go() method is called too late, a turn timeout will occur and the SkippedTurnEvent will occur, which means that the bot has skipped all actions for the last turn. In this case, the server will continue executing the last actions received. This could be fatal for the bot due to loss of control over the bot. So make sure that go() is called before the turn ends.

      The commands executed when go() is called are set by calling the various setter methods prior to calling the go() method: setTurnRate(double), setGunTurnRate(double), setRadarTurnRate(double), setTargetSpeed(double), and setFire(double).

      See Also:

    • getMyId

      int getMyId()
      Unique id of this bot, which is available when the game has started.
      Returns:
      The unique id of this bot.

    • getVariant

      String getVariant()
      The game variant, which is "Tank Royale".
      Returns:
      The game variant of Robocode.

    • getVersion

      String getVersion()
      Game version, e.g. "1.0.0".
      Returns:
      The game version.

    • getGameType

      String getGameType()
      Game type, e.g. "melee" or "1v1".

      First available when the game has started.

      Returns:
      The game type.

    • getArenaWidth

      int getArenaWidth()
      Width of the arena measured in units.

      First available when the game has started.

      Returns:
      The arena width measured in units

    • getArenaHeight

      int getArenaHeight()
      Height of the arena measured in units.

      First available when the game has started.

      Returns:
      The arena height measured in units

    • getNumberOfRounds

      int getNumberOfRounds()
      The number of rounds in a battle.

      First available when the game has started.

      Returns:
      The number of rounds in a battle.

    • getGunCoolingRate

      double getGunCoolingRate()
      Gun cooling rate. The gun needs to cool down to a gun heat of zero before the gun can fire. The gun cooling rate determines how fast the gun cools down. That is, the gun cooling rate is subtracted from the gun heat each turn until the gun heat reaches zero.

      First available when the game has started.

      Returns:
      The gun cooling rate.
      See Also:

    • getMaxInactivityTurns

      int getMaxInactivityTurns()
      The maximum number of inactive turns allowed the bot will become zapped by the game for being inactive. Inactive means that the bot has taken no action in several turns in a row.

      First available when the game has started.

      Returns:
      The maximum number of allowed inactive turns.

    • getTurnTimeout

      int getTurnTimeout()
      The turn timeout is important as the bot needs to take action by calling go() before the turn timeout occurs. As soon as the TickEvent is triggered, i.e. when onTick(dev.robocode.tankroyale.botapi.events.TickEvent) is called, you need to call go() to take action before the turn timeout occurs. Otherwise, your bot will skip a turn and receive a onSkippedTurn(dev.robocode.tankroyale.botapi.events.SkippedTurnEvent) for each turn where go() is called too late.

      First available when the game has started.

      Returns:
      The turn timeout in microseconds (1 / 1,000,000 second).
      See Also:

    • getTimeLeft

      int getTimeLeft()
      The number of microseconds left of this turn before the bot will skip the turn. Make sure to call go() before the time runs out.
      Returns:
      The amount of time left in microseconds.
      See Also:

    • getRoundNumber

      int getRoundNumber()
      Current round number.
      Returns:
      The current round number.

    • getTurnNumber

      int getTurnNumber()
      Current turn number.
      Returns:
      The current turn number.

    • getEnemyCount

      int getEnemyCount()
      Number of enemies left in the round.
      Returns:
      The number of enemies left in the round.

    • getEnergy

      double getEnergy()
      Current energy level. When the energy level is positive, the bot is alive and active. When the energy level is 0, the bot is still alive but disabled. If the bot becomes disabled it will not be able to move or take any action. If negative, the bot has been defeated.
      Returns:
      The current energy level.

    • isDisabled

      boolean isDisabled()
      Specifies if the bot is disabled, i.e., when the energy is zero. When the bot is disabled, it is not able to take any action like movement, turning, and firing.
      Returns:
      true if the bot is disabled; false otherwise.

    • getX

      double getX()
      Current X coordinate of the center of the bot.
      Returns:
      The current X coordinate of the bot.

    • getY

      double getY()
      Current Y coordinate of the center of the bot.
      Returns:
      The current Y coordinate of the bot.

    • getDirection

      double getDirection()
      Current driving direction of the bot in degrees.
      Returns:
      The current driving direction of the bot.

    • getGunDirection

      double getGunDirection()
      Current direction of the gun in degrees.
      Returns:
      The current gun direction of the bot.

    • getRadarDirection

      double getRadarDirection()
      Current direction of the radar in degrees.
      Returns:
      The current radar direction of the bot.

    • getSpeed

      double getSpeed()
      The current speed measured in units per turn. If the speed is positive, the bot moves forward. If negative, the bot moves backward. Zero speed means that the bot is not moving from its current position.
      Returns:
      The current speed.

    • getGunHeat

      double getGunHeat()
      Current gun heat. When the is fired it gets heated and will not be able to fire before it has been cooled down. The gun is cooled down when the gun heat is zero.

      When the gun has fired the gun heat is set to 1 + (firepower / 5) and will be cooled down by the gun cooling rate.

      Returns:
      The current gun heat.
      See Also:

    • getBulletStates

      Collection<BulletState> getBulletStates()
      Current bullet states. Keeps track of all the bullets fired by the bot, which are still active on the arena.
      Returns:
      The current bullet states.

    • getEvents

      List<BotEvent> getEvents()
      Returns an ordered list containing all events currently in the bot's event queue. You might, for example, call this while processing another event.
      Returns:
      an ordered list containing all events currently in the bot's event queue.
      See Also:

    • clearEvents

      void clearEvents()
      Clears out any pending events in the bot's event queue immediately.
      See Also:

    • getTurnRate

      double getTurnRate()
      Returns the turn rate of the bot in degrees per turn.
      Returns:
      The turn rate of the bot.
      See Also:

    • setTurnRate

      void setTurnRate(double turnRate)
      Sets the turn rate of the bot, which can be positive and negative. The turn rate is measured in degrees per turn. The turn rate is added to the current direction of the bot. But it is also added to the current direction of the gun and radar. This is because the gun is mounted on the body, and hence turns with the body. The radar is mounted on the gun and hence moves with the gun. You can compensate for the turn rate of the bot by subtracting the turn rate of the bot from the turn rate of the gun and radar. But be aware that the turn limits defined for the gun and radar cannot be exceeded.

      The turn rate is truncated to Constants.MAX_TURN_RATE if the turn rate exceeds this value.

      If this property is set multiple times, the last value set before go() counts.

      Parameters:
      turnRate - is the new turn rate of the bot in degrees per turn.

    • getMaxTurnRate

      double getMaxTurnRate()
      Returns the maximum turn rate of the bot in degrees per turn.
      Returns:
      The maximum turn rate of the bot.
      See Also:

    • setMaxTurnRate

      void setMaxTurnRate(double maxTurnRate)
      Sets the maximum turn rate which applies to turn the bot to the left or right. The maximum turn rate must be an absolute value from 0 to Constants.MAX_TURN_RATE, both values are included. If the input turn rate is negative, the max turn rate will be cut to zero. If the input turn rate is above Constants.MAX_TURN_RATE, the max turn rate will be set to Constants.MAX_TURN_RATE.

      If for example the max turn rate is set to 5, then the bot will be able to turn left or right with a turn rate down to -5 degrees per turn when turning right, and up to 5 degrees per turn when turning left.

      This method will first be executed when go() is called making it possible to call other set methods after execution. This makes it possible to set the bot to move, turn the body, radar, gun, and also fire the gun in parallel in a single turn when calling go(). But notice that this is only possible to execute multiple methods in parallel by using setter methods only prior to calling go().

      If this method is called multiple times, the last call before go() is executed, counts.

      Parameters:
      maxTurnRate - is the new maximum turn rate
      See Also:

    • getGunTurnRate

      double getGunTurnRate()
      Returns the gun turn rate in degrees per turn.
      Returns:
      The turn rate of the gun.
      See Also:

    • setGunTurnRate

      void setGunTurnRate(double gunTurnRate)
      Sets the turn rate of the gun, which can be positive and negative. The gun turn rate is measured in degrees per turn. The turn rate is added to the current turn direction of the gun. But it is also added to the current direction of the radar. This is because the radar is mounted on the gun, and hence moves with the gun. You can compensate for the turn rate of the gun by subtracting the turn rate of the gun from the turn rate of the radar. But be aware that the turn limits defined for the radar cannot be exceeded.

      The gun turn rate is truncated to Constants.MAX_GUN_TURN_RATE if the gun turn rate exceeds this value.

      If this property is set multiple times, the last value set before go() counts.

      Parameters:
      gunTurnRate - is the new turn rate of the gun in degrees per turn.

    • getMaxGunTurnRate

      double getMaxGunTurnRate()
      Returns the maximum gun turn rate in degrees per turn.
      Returns:
      The maximum turn rate of the gun.
      See Also:

    • setMaxGunTurnRate

      void setMaxGunTurnRate(double maxGunTurnRate)
      Sets the maximum turn rate which applies to turn the gun to the left or right. The maximum turn rate must be an absolute value from 0 to Constants.MAX_GUN_TURN_RATE, both values are included. If the input turn rate is negative, the max turn rate will be cut to zero. If the input turn rate is above Constants.MAX_GUN_TURN_RATE, the max turn rate will be set to Constants.MAX_GUN_TURN_RATE.

      If for example the max gun turn rate is set to 5, then the gun will be able to turn left or right with a turn rate down to -5 degrees per turn when turning right and up to 5 degrees per turn when turning left.

      This method will first be executed when go() is called making it possible to call other set methods after execution. This makes it possible to set the bot to move, turn the body, radar, gun, and also fire the gun in parallel in a single turn when calling go(). But notice that this is only possible to execute multiple methods in parallel by using setter methods only prior to calling go().

      If this method is called multiple times, the last call before go() is executed, counts.

      Parameters:
      maxGunTurnRate - is the new maximum gun turn rate
      See Also:

    • getRadarTurnRate

      double getRadarTurnRate()
      Returns the radar turn rate in degrees per turn.
      Returns:
      The turn rate of the radar.
      See Also:

    • setRadarTurnRate

      void setRadarTurnRate(double gunRadarTurnRate)
      Sets the turn rate of the radar, which can be positive and negative. The radar turn rate is measured in degrees per turn. The turn rate is added to the current direction of the radar. Note that besides the turn rate of the radar, the turn rates of the bot and gun are also added to the radar direction, as the radar moves with the gun, which is mounted on the gun that moves with the body. You can compensate for the turn rate of the gun by subtracting the turn rate of the bot and gun from the turn rate of the radar. But be aware that the turn limits defined for the radar cannot be exceeded.

      The radar turn rate is truncated to Constants.MAX_RADAR_TURN_RATE if the radar turn rate exceeds this value.

      If this property is set multiple times, the last value set before go() counts.

      Parameters:
      gunRadarTurnRate - is the new turn rate of the radar in degrees per turn.

    • getMaxRadarTurnRate

      double getMaxRadarTurnRate()
      Returns the maximum radar turn rate in degrees per turn.
      Returns:
      The maximum turn rate of the radar.
      See Also:

    • setMaxRadarTurnRate

      void setMaxRadarTurnRate(double maxRadarTurnRate)
      Sets the maximum turn rate which applies to turn the radar to the left or right. The maximum turn rate must be an absolute value from 0 to Constants.MAX_RADAR_TURN_RATE, both values are included. If the input turn rate is negative, the max turn rate will be cut to zero. If the input turn rate is above Constants.MAX_RADAR_TURN_RATE, the max turn rate will be set to Constants.MAX_RADAR_TURN_RATE.

      If for example the max radar turn rate is set to 5, then the radar will be able to turn left or right with a turn rate down to -5 degrees per turn when turning right and up to 5 degrees per turn when turning left.

      This method will first be executed when go() is called making it possible to call other set methods after execution. This makes it possible to set the bot to move, turn the body, radar, gun, and also fire the gun in parallel in a single turn when calling go(). But notice that this is only possible to execute multiple methods in parallel by using setter methods only prior to calling go().

      If this method is called multiple times, the last call before go() is executed, counts.

      Parameters:
      maxRadarTurnRate - is the new maximum radar turn rate
      See Also:

    • getTargetSpeed

      double getTargetSpeed()
      Returns the target speed in units per turn.
      Returns:
      The target speed.
      See Also:

    • setTargetSpeed

      void setTargetSpeed(double targetSpeed)
      Sets the new target speed for the bot in units per turn. The target speed is the speed you want to achieve eventually, which could take one to several turns depending on the current speed. For example, if the bot is moving forward with max speed, and then must change to move backward at full speed, the bot will have to first decelerate/brake its positive speed (moving forward). When passing speed of zero, it will then have to accelerate back to achieve max negative speed.

      Note that acceleration is 1 unit per turn and deceleration/braking is faster than acceleration as it is -2 unit per turn. Deceleration is negative as it is added to the speed and hence needs to be negative when slowing down.

      The target speed is truncated to Constants.MAX_SPEED if the target speed exceeds this value.

      If this property is set multiple times, the last value set before go() counts.

      Parameters:
      targetSpeed - is the new target speed in units per turn.

    • getMaxSpeed

      double getMaxSpeed()
      Returns the maximum speed in units per turn.
      Returns:
      The maximum speed.
      See Also:

    • setMaxSpeed

      void setMaxSpeed(double maxSpeed)
      Sets the maximum speed which applies when moving forward and backward. The maximum speed must be an absolute value from 0 to Constants.MAX_SPEED, both values are included. If the input speed is negative, the max speed will be cut to zero. If the input speed is above Constants.MAX_SPEED, the max speed will be set to Constants.MAX_SPEED.

      If for example the maximum speed is set to 5, then the bot will be able to move backwards with a speed down to -5 units per turn and up to 5 units per turn when moving forward.

      This method will first be executed when go() is called making it possible to call other set methods after execution. This makes it possible to set the bot to move, turn the body, radar, gun, and also fire the gun in parallel in a single turn when calling go(). But notice that this is only possible to execute multiple methods in parallel by using setter methods only prior to calling go().

      If this method is called multiple times, the last call before go() is executed, counts.

      Parameters:
      maxSpeed - is the new maximum speed

    • setFire

      boolean setFire(double firepower)
      Sets the gun to fire in the direction that the gun is pointing with the specified firepower.

      Firepower is the amount of energy your bot will spend on firing the gun. This means that the bot will lose power on firing the gun where the energy loss is equal to the firepower. You cannot spend more energy than available from your bot.

      The bullet power must be greater than Constants.MIN_FIREPOWER and the gun heat zero before the gun can fire.

      If the bullet hits an opponent bot, you will gain energy from the bullet hit. When hitting another bot, your bot will be rewarded and retrieve an energy boost of 3x firepower.

      The gun will only fire when the firepower is at Constants.MIN_FIREPOWER or higher. If the firepower is more than Constants.MAX_FIREPOWER the power will be truncated to the max firepower.

      Whenever the gun is fired, the gun is heated and needs to cool down before it can fire again. The gun heat must be zero before the gun is able to fire (see getGunHeat()). The gun heat generated by firing the gun is 1 + (firepower / 5). Hence, the more firepower used the longer it takes to cool down the gun. The gun cooling rate can be read by calling getGunCoolingRate().

      The amount of energy used for firing the gun is subtracted from the bots' total energy. The amount of damage dealt by a bullet hitting another bot is 4x firepower, and if the firepower is greater than 1 it will do an additional 2 x (firepower - 1) damage.

      Note that the gun will automatically keep firing at any turn as soon as the gun heat reaches zero. It is possible to disable the gun firing by setting the firepower to zero.

      The firepower is truncated to 0 and Constants.MAX_FIREPOWER if the firepower exceeds this value.

      If this property is set multiple times, the last value set before go() counts.

      Parameters:
      firepower - is the new firepower
      Returns:
      true if the cannon can fire, i.e. if there is no gun heat; false otherwise.
      See Also:

    • getFirepower

      double getFirepower()
      Returns the firepower.
      Returns:
      The firepower.
      See Also:

    • setRescan

      void setRescan()
      Sets the bot to rescan with the radar. This method is useful if the radar has not turned, and hence will not automatically scan bots. The last radar direction and sweep angle will be used for scanning for bots.

    • setFireAssist

      void setFireAssist(boolean enable)
      Enables or disables fire assistance explicitly. Fire assistance is useful for bots with limited aiming capabilities as it will help the bot by firing directly at a scanned bot when the gun is fired, which is a very simple aiming strategy.

      When fire assistance is enabled the gun will fire towards the center of the scanned bot when all these conditions are met:

      The fire assistance feature is provided for backwards compatibility with the original Robocode, where robots that are not an AdvancedRobot got fire assistance per default as the gun and radar cannot be moved independently of each other. (The AdvancedRobot allows the body, gun, and radar to move independent of each other).

      Parameters:
      enable - enables fire assistance when set to true, and disable fire assistance otherwise.

    • setInterruptible

      void setInterruptible(boolean interruptible)
      Call this method during an event handler to control continuing or restarting the event handler, when a new event occurs again for the same event handler while processing an earlier event.

      Example: 

      
    public void onScannedBot(ScannedBotEvent e) {
        fire(1);
        setInterruptible(true);
        forward(100); // When a new bot is scanned while moving forward this handler will restart
                      // from the top as this event handler has been set to be interruptible
                      // right after firing. Without setInterruptible(true), new scan events
                      // would not be triggered while moving forward.
        // We'll only get here if we do not see a robot during the move.
        System.out.println("No bots were scanned");
    }
      Parameters:
      interruptible - true if the event handler should be interrupted and hence restart when a new event of the same event type occurs again; false otherwise where the event handler will continue processing.

    • setAdjustGunForBodyTurn

      void setAdjustGunForBodyTurn(boolean adjust)
      Sets the gun to adjust for the bot´s turn when setting the gun turn rate. So the gun behaves like it is turning independent of the bot´s turn.

      Ok, so this needs some explanation: The gun is mounted on the bot´s body. So, normally, if the bot turns 90 degrees to the right, then the gun will turn with it as it is mounted on top of the bot´s body. To compensate for this, you can adjust the gun for the bot´s turn. When this is set, the gun will turn independent of the bot´s turn.

      Note: This property is additive until you reach the maximum the gun can turn Constants.MAX_GUN_TURN_RATE. The "adjust" is added to the amount, you set for turning the bot by the turn rate, then capped by the physics of the game.

      Note: The gun compensating this way does count as "turning the gun".

      Parameters:
      adjust - true if the gun must adjust/compensate for the body turning; false if the gun must turn with the body turning (default).
      See Also:

    • isAdjustGunForBodyTurn

      boolean isAdjustGunForBodyTurn()
      Checks if the gun is set to adjust for the bot turning, i.e. to turn independent of the bot´s body turn.

      This call returns true if the gun is set to turn independent of the turn of the bot´s body. Otherwise, false is returned, meaning that the gun is set to turn with the bot´s body turn.

      Returns:
      true if the gun is set to turn independent of the body turning; false if the gun is set to turn with the body turning (default).
      See Also:

    • setAdjustRadarForBodyTurn

      void setAdjustRadarForBodyTurn(boolean adjust)
      Sets the radar to adjust for the body's turn when setting the radar turn rate. So the radar behaves like it is turning independent of the body's turn.

      Ok, so this needs some explanation: The radar is mounted on the gun, and the gun is mounted on the bot´s body. So, normally, if the bot turns 90 degrees to the right, the gun turns, as does the radar. Hence, if the bot turns 90 degrees to the right, then the gun and radar will turn with it as the radar is mounted on top of the gun. To compensate for this, you can adjust the radar for the body turn. When this is set, the radar will turn independent of the body's turn.

      Note: This property is additive until you reach the maximum the radar can turn (Constants.MAX_RADAR_TURN_RATE). The "adjust" is added to the amount, you set for turning the body by the body turn rate, then capped by the physics of the game.

      Note: The radar compensating this way does count as "turning the radar".

      Parameters:
      adjust - true if the radar must adjust/compensate for the body's turn; false if the radar must turn with the body turning (default).
      See Also:

    • isAdjustRadarForBodyTurn

      boolean isAdjustRadarForBodyTurn()
      Checks if the radar is set to adjust for the body turning, i.e. to turn independent of the body's turn.

      This call returns true if the radar is set to turn independent of the turn of the body. Otherwise, false is returned, meaning that the radar is set to turn with the body turning.

      Returns:
      true if the radar is set to turn independent of the body turning; false if the radar is set to turn with the body turning (default).
      See Also:

    • setAdjustRadarForGunTurn

      void setAdjustRadarForGunTurn(boolean adjust)
      Sets the radar to adjust for the gun's turn when setting the radar turn rate. So the radar behaves like it is turning independent of the gun's turn.

      Ok, so this needs some explanation: The radar is mounted on the gun. So, normally, if the gun turns 90 degrees to the right, then the radar will turn with it as it is mounted on top of the gun. To compensate for this, you can adjust the radar for the gun turn. When this is set, the radar will turn independent of the gun's turn.

      Note: This property is additive until you reach the maximum the radar can turn (Constants.MAX_RADAR_TURN_RATE). The "adjust" is added to the amount, you set for turning the gun by the gun turn rate, then capped by the physics of the game.

      When the radar compensates this way it counts as "turning the radar", even when it is not explicitly turned by calling a method for turning the radar.

      Note: This method automatically disables fire assistance when set to true, and automatically enables fire assistance when set to false. This is not the case for setAdjustGunForBodyTurn(boolean) and setAdjustRadarForBodyTurn(boolean). Read more about fire assistance with the setFireAssist(boolean) method.

      Parameters:
      adjust - true if the radar must adjust/compensate for the gun turning; false if the radar must turn with the gun turning (default).
      See Also:

    • isAdjustRadarForGunTurn

      boolean isAdjustRadarForGunTurn()
      Checks if the radar is set to adjust for the gun turning, i.e. to turn independent of the gun's turn.

      This call returns true if the radar is set to turn independent of the turn of the gun. Otherwise, false is returned, meaning that the radar is set to turn with the gun's turn.

      Returns:
      true if the radar is set to turn independent of the gun turning; false if the radar is set to turn with the gun turning (default).
      See Also:

    • addCustomEvent

      boolean addCustomEvent(Condition condition)
      Adds an event handler that will be automatically triggered onCustomEvent(dev.robocode.tankroyale.botapi.events.CustomEvent) when the Condition.test() returns true.
      Parameters:
      condition - is the condition that must be met to trigger the custom event.
      Returns:
      true if the condition was not added already; false if the condition was already added.
      See Also:

    • removeCustomEvent

      boolean removeCustomEvent(Condition condition)
      Removes triggering a custom event handler for a specific condition that was previously added with addCustomEvent(dev.robocode.tankroyale.botapi.events.Condition).
      Parameters:
      condition - is the condition that was previously added with addCustomEvent(dev.robocode.tankroyale.botapi.events.Condition)
      Returns:
      true if the condition was found; false if the condition was not found.
      See Also:

    • setStop

      void setStop()
      Set the bot to stop all movement including turning the gun and radar. The remaining movement is saved for a call to setResume(). This method has no effect, if it has already been called.

      This method will first be executed when go() is called making it possible to call other set methods before execution. This makes it possible to set the bot to move, turn the body, radar, gun, and also fire the gun in parallel in a single turn when calling go(). But notice that this is only possible to execute multiple methods in parallel by using setter methods only prior to calling go().

      See Also:

    • setStop

      void setStop(boolean overwrite)
      Set the bot to stop all movement including turning the gun and radar. The remaining movement is saved for a call to setResume().

      This method will first be executed when go() is called making it possible to call other set methods before execution. This makes it possible to set the bot to move, turn the body, radar, gun, and also fire the gun in parallel in a single turn when calling go(). But notice that this is only possible to execute multiple methods in parallel by using setter methods only prior to calling go().

      Parameters:
      overwrite - is set to true if the movement saved by a previous call to this method or setStop() must be overridden with the current movement. When set to false this method is identical to setStop().
      See Also:

    • setResume

      void setResume()
      Sets the bot to scan (again) with the radar. This method is useful if the radar has not been turning and thereby will not be able to automatically scan bots. This method is useful when the bot movement has stopped, e.g. when setStop() has been called. The last radar direction and sweep angle will be used for rescanning for bots.

      This method will first be executed when go() is called making it possible to call other set methods before execution. This makes it possible to set the bot to move, turn the body, radar, gun, and also fire the gun in parallel in a single turn when calling go(). But notice that this is only possible to execute multiple methods in parallel by using setter methods only prior to calling go().

      See Also:

    • getTeammateIds

      Set<Integer> getTeammateIds()
      Returns the ids of all teammates.
      Returns:
      the ids of all teammates if the bot is participating in a team or the empty set if the bot is not in a team.
      See Also:

    • isTeammate

      boolean isTeammate(int botId)
      Checks if the provided bot id is a teammate or not.

      Example: 

      
     public void onScannedBot(ScannedBotEvent event) {
         if (isTeammate(event.getScannedBotId()) {
             return; // don't do anything by leaving
         }
         fire(1);
     }
      Parameters:
      botId - is the id of the bot to check for.
      Returns:
      true if the provided is id an id of a teammate; false otherwise.
      See Also:

    • broadcastTeamMessage

      void broadcastTeamMessage(Object message)
      Broadcasts a message to all teammates.

      When the message is send, it is serialized into a JSON representation, meaning that all public fields, and only public fields, are being serialized into a JSON representation as a DTO (data transfer object).

      The maximum team message size limit is defined by TEAM_MESSAGE_MAX_SIZE, which is set to 32768 bytes. This size is the size of the message when it is serialized into a JSON representation.

      The maximum number of messages that can be send/broadcast per turn is limited to 10.
      Parameters:
      message - is the message to broadcast.
      Throws:
      IllegalArgumentException - if the size of the message exceeds the size limit.
      See Also:

    • sendTeamMessage

      void sendTeamMessage(int teammateId, Object message)
      Sends a message to a specific teammate.

      When the message is sent, it is serialized into a JSON representation, meaning that all public fields, and only public fields, are being serialized into a JSON representation as a DTO (data transfer object).

      The maximum team message size limit is defined by TEAM_MESSAGE_MAX_SIZE, which is set to 32768 bytes. This size is the size of the message when it is serialized into a JSON representation.

      The maximum number of messages that can be sent/broadcast per turn is limited to 10.
      Parameters:
      teammateId - is the id of the teammate to send the message to.
      message - is the message to send.
      Throws:
      IllegalArgumentException - if the size of the message exceeds the size limit.
      See Also:

    • isStopped

      boolean isStopped()
      Checks if the movement has been stopped.
      Returns:
      true if the movement has been stopped by setStop(); false otherwise.
      See Also:

    • getBodyColor

      Color getBodyColor()
      Returns the color of the body.
      Returns:
      The color of the body or null if no color has been set yet, meaning that the default color will be used.

    • setBodyColor

      void setBodyColor(Color color)
      Sets the color of the body. Colors can (only) be changed each turn.

      Example: 

      
     setBodyColor(Color.RED); // the red color
     setBodyColor(new Color(255, 0, 0)); // also the red color
      Parameters:
      color - is the color of the body or null if the bot must use the default color instead.

    • getTurretColor

      Color getTurretColor()
      Returns the color of the gun turret.
      Returns:
      The color of the turret or null if no color has been set yet, meaning that the default color will be used.

    • setTurretColor

      void setTurretColor(Color color)
      Sets the color of the gun turret. Colors can (only) be changed each turn.

      Example: 

      
     setTurretColor(Color.RED); // the red color
     setTurretColor(new Color(255, 0, 0)); // also the red color
      Parameters:
      color - is the color of the gun turret or null if the bot must use the default color instead.

    • getRadarColor

      Color getRadarColor()
      Returns the color of the radar.
      Returns:
      The color of the radar or null if no color has been set yet, meaning that the default color will be used.

    • setRadarColor

      void setRadarColor(Color color)
      Sets the color of the radar. Colors can (only) be changed each turn.

      Example: 

      
     setRadarColor(Color.RED); // the red color
     setRadarColor(new Color(255, 0, 0)); // also the red color
      Parameters:
      color - is the color of the radar or null if the bot must use the default color instead.

    • getBulletColor

      Color getBulletColor()
      Returns the color of the fired bullets.
      Returns:
      The color of the bullets or null if no color has been set yet, meaning that the default color will be used.

    • setBulletColor

      void setBulletColor(Color color)
      Sets the color of the fired bullets. Colors can (only) be changed each turn.

      Note that a fired bullet will not change is color when it has been fired. But new bullets fired after setting the bullet color will get the new color.

      Example: 

      
     setBulletColor(Color.RED); // the red color
     setBulletColor(new Color(255, 0, 0)); // also the red color
      Parameters:
      color - is the color of the fired bullets or null if the bot must use the default color instead.

    • getScanColor

      Color getScanColor()
      Returns the color of the scan arc.
      Returns:
      The color of the scan arc or null if no color has been set yet, meaning that the default color will be used.

    • setScanColor

      void setScanColor(Color color)
      Sets the color of the scan arc. Colors can (only) be changed each turn.

      Example: 

      
     setScanColor(Color.RED); // the red color
     setScanColor(new Color(255, 0, 0)); // also the red color
      Parameters:
      color - is the color of the scan arc or null if the bot must use the default color instead.

    • getTracksColor

      Color getTracksColor()
      Returns the color of the tracks.
      Returns:
      The color of the tracks or null if no color has been set yet, meaning that the default color will be used.

    • setTracksColor

      void setTracksColor(Color color)
      Sets the color of the tracks. Colors can (only) be changed each turn.

      Example: 

      
     setTracksColor(Color.RED); // the red color
     setTracksColor(new Color(255, 0, 0)); // also the red color
      Parameters:
      color - is the color of the tracks or null if the bot must use the default color instead.

    • getGunColor

      Color getGunColor()
      Returns the color of the gun.
      Returns:
      The color of the gun or null if no color has been set yet, meaning that the default color will be used.

    • setGunColor

      void setGunColor(Color color)
      Sets the color of the gun. Colors can (only) be changed each turn.

      Example: 

      
     setGunColor(Color.RED); // the red color
     setGunColor(new Color(255, 0, 0)); // also the red color
      Parameters:
      color - is the color of the gun or null if the bot must use the default color instead.

    • isDebuggingEnabled

      boolean isDebuggingEnabled()
      Flag indicating if graphical debugging is enabled and hence if getGraphics() can be used for debug painting.
      Returns:
      true if the graphics debugging is enabled; false otherwise.

    • getGraphics

      Graphics2D getGraphics()
      Gets a graphics object that the bot can paint debug information to.

      Example: 

      
     var g = getGraphics();
     g.setColor(Color.blue);
     g.fillRect(50, 50, 100, 100);
      Returns:
      A graphics canvas to use for painting graphical objects making debugging easier.

    • onConnected

      default void onConnected(ConnectedEvent connectedEvent)
      The event handler triggered when connected to the server.
      Parameters:
      connectedEvent - is the event details from the game.

    • onDisconnected

      default void onDisconnected(DisconnectedEvent disconnectedEvent)
      The event handler triggered when disconnected from the server.
      Parameters:
      disconnectedEvent - is the event details from the game.

    • onConnectionError

      default void onConnectionError(ConnectionErrorEvent connectionErrorEvent)
      The event handler triggered when a connection error occurs.
      Parameters:
      connectionErrorEvent - is the event details from the game.

    • onGameStarted

      default void onGameStarted(GameStartedEvent gameStatedEvent)
      The event handler triggered when a game has started.
      Parameters:
      gameStatedEvent - is the event details from the game.

    • onGameEnded

      default void onGameEnded(GameEndedEvent gameEndedEvent)
      The event handler triggered when a game has ended.
      Parameters:
      gameEndedEvent - is the event details from the game.

    • onRoundStarted

      default void onRoundStarted(RoundStartedEvent roundStartedEvent)
      The event handler triggered when a new round has started.
      Parameters:
      roundStartedEvent - is the event details from the game.

    • onRoundEnded

      default void onRoundEnded(RoundEndedEvent roundEndedEvent)
      The event handler triggered when a round has ended.
      Parameters:
      roundEndedEvent - is the event details from the game.

    • onTick

      default void onTick(TickEvent tickEvent)
      The event handler triggered when a game tick event occurs, i.e., when a new turn in a round has started.
      Parameters:
      tickEvent - is the event details from the game.

    • onBotDeath

      default void onBotDeath(BotDeathEvent botDeathEvent)
      The event handler triggered when another bot has died.
      Parameters:
      botDeathEvent - is the event details from the game.

    • onDeath

      default void onDeath(DeathEvent deathEvent)
      The event handler triggered when this bot has died.
      Parameters:
      deathEvent - is the event details from the game.

    • onHitBot

      default void onHitBot(HitBotEvent botHitBotEvent)
      The event handler triggered when the bot has collided with another bot.
      Parameters:
      botHitBotEvent - is the event details from the game.

    • onHitWall

      default void onHitWall(HitWallEvent botHitWallEvent)
      The event handler triggered when the bot has hit a wall.
      Parameters:
      botHitWallEvent - is the event details from the game.

    • onBulletFired

      default void onBulletFired(BulletFiredEvent bulletFiredEvent)
      The event handler triggered when the bot has fired a bullet.
      Parameters:
      bulletFiredEvent - is the event details from the game.

    • onHitByBullet

      default void onHitByBullet(HitByBulletEvent hitByBulletEvent)
      The event handler triggered when the bot has been hit by a bullet.
      Parameters:
      hitByBulletEvent - is the event details from the game.

    • onBulletHit

      default void onBulletHit(BulletHitBotEvent bulletHitBotEvent)
      The event handler triggered when the bot has hit another bot with a bullet.
      Parameters:
      bulletHitBotEvent - is the event details from the game.

    • onBulletHitBullet

      default void onBulletHitBullet(BulletHitBulletEvent bulletHitBulletEvent)
      The event handler triggered when a bullet fired from the bot has collided with another bullet.
      Parameters:
      bulletHitBulletEvent - is the event details from the game.

    • onBulletHitWall

      default void onBulletHitWall(BulletHitWallEvent bulletHitWallEvent)
      The event handler triggered when a bullet has hit a wall.
      Parameters:
      bulletHitWallEvent - is the event details from the game.

    • onScannedBot

      default void onScannedBot(ScannedBotEvent scannedBotEvent)
      The event handler triggered when the bot has skipped a turn. This event occurs if the bot did not take any action in a specific turn. That is, go() was not called before the turn timeout occurred for the turn. If the bot does not take action for multiple turns in a row, it will receive a SkippedTurnEvent for each turn where it did not take action. When the bot is skipping a turn, the server did not receive the message from the bot, and the server will use the newest received instructions for target speed, turn rates, firing, etc.
      Parameters:
      scannedBotEvent - is the event details from the game.

    • onSkippedTurn

      default void onSkippedTurn(SkippedTurnEvent skippedTurnEvent)
      The event handler triggered when the bot has skipped a turn. This event occurs if the bot did not take any action in a specific turn. That is, Go() was not called before the turn timeout occurred for the turn. If the bot does not take action for multiple turns in a row, it will receive a SkippedTurnEvent for each turn where it did not take action. When the bot is skipping a turn, the server did not receive the message from the bot, and the server will use the newest received instructions for target speed, turn rates, firing, etc.
      Parameters:
      skippedTurnEvent - is the event details from the game.

    • onWonRound

      default void onWonRound(WonRoundEvent wonRoundEvent)
      The event handler triggered when the bot has won a round.
      Parameters:
      wonRoundEvent - is the event details from the game.

    • onCustomEvent

      default void onCustomEvent(CustomEvent customEvent)
      The event handler triggered when some condition has been met. Use the Condition.getName() of the condition when you need to differentiate between different types of conditions received with this event handler.
      Parameters:
      customEvent - is the event details from the game.

    • onTeamMessage

      default void onTeamMessage(TeamMessageEvent teamMessageEvent)
      The event handler triggered when the bot has received a message from a teammate.
      Parameters:
      teamMessageEvent - is the event details from the game.

    • calcMaxTurnRate

      double calcMaxTurnRate(double speed)
      Calculates the maximum turn rate for a specific speed.
      Parameters:
      speed - is the speed.
      Returns:
      The maximum turn rate determined by the given speed.

    • calcBulletSpeed

      double calcBulletSpeed(double firepower)
      Calculates the bullet speed given a firepower.
      Parameters:
      firepower - is the firepower.
      Returns:
      The bullet speed determined by the given firepower.

    • calcGunHeat

      double calcGunHeat(double firepower)
      Calculates gun heat after having fired the gun.
      Parameters:
      firepower - is the firepower used when firing the gun.
      Returns:
      The gun heat produced when firing the gun with the given firepower.

    • getEventPriority

      int getEventPriority(Class<BotEvent> eventClass)
      Returns the event priority for a specific event class.

      Example: 

      
     int scannedBotEventPriority = getPriority(ScannedBotEvent.class);
      Parameters:
      eventClass - is the event class to get the event priority for.
      Returns:
      the event priority for a specific event class.
      See Also:

    • setEventPriority

      void setEventPriority(Class<BotEvent> eventClass, int priority)
      Changes the event priority for an event class. The event priority is used for determining which event types (classes) that must be fired and handled before others. Events with higher priorities will be handled before events with lower priorities.

      Note that you should normally not need to change the event priority.

      Parameters:
      eventClass - is the event class to change the event priority for.
      priority - is the new priority. Typically, a positive number from 1 to 150. The greater value, the higher priority.
      See Also:

    • calcBearing

      default double calcBearing(double direction)
      Calculates the bearing (delta angle) between the input direction and the direction of this bot. 
      
 bearing = calcBearing(direction) = normalizeRelativeDegrees(direction - getDirection())
      Parameters:
      direction - is the input direction to calculate the bearing from.
      Returns:
      A bearing (delta angle) between the input direction and the direction of this bot. The bearing is a normalized angle in the range [-180,180[
      See Also:

    • calcGunBearing

      default double calcGunBearing(double direction)
      Calculates the bearing (delta angle) between the input direction and the direction of the gun. 
      
 bearing = calcGunBearing(direction) = normalizeRelativeDegrees(direction - getGunDirection())
      Parameters:
      direction - is the input direction to calculate the bearing from.
      Returns:
      A bearing (delta angle) between the input direction and the direction of the gun. The bearing is a normalized angle in the range [-180,180[
      See Also:

    • calcRadarBearing

      default double calcRadarBearing(double direction)
      Calculates the bearing (delta angle) between the input direction and the direction of the radar. 
      
 bearing = calcRadarBearing(direction) = normalizeRelativeDegrees(direction - getRadarDirection())
      Parameters:
      direction - is the input direction to calculate the bearing from.
      Returns:
      A bearing (delta angle) between the input direction and the direction of the radar. The bearing is a normalized angle in the range [-180,180[
      See Also:

    • directionTo

      default double directionTo(double x, double y)
      Calculates the direction (angle) from the bot´s coordinates to a point x,y.
      Parameters:
      x - is the x coordinate of the point.
      y - is the y coordinate of the point.
      Returns:
      The direction to the point x,y in the range [0,360[

    • bearingTo

      default double bearingTo(double x, double y)
      Calculates the bearing (delta angle) between the current direction of the bot´s body and the direction to the point x,y.
      Parameters:
      x - is the x coordinate of the point.
      y - is the y coordinate of the point.
      Returns:
      The bearing to the point x,y in the range [-180,180[

    • gunBearingTo

      default double gunBearingTo(double x, double y)
      Calculates the bearing (delta angle) between the current direction of the bot´s gun and the direction to the point x,y.
      Parameters:
      x - is the x coordinate of the point.
      y - is the y coordinate of the point.
      Returns:
      The bearing to the point x,y in the range [-180,180[

    • radarBearingTo

      default double radarBearingTo(double x, double y)
      Calculates the bearing (delta angle) between the current direction of the bot´s radar and the direction to the point x,y.
      Parameters:
      x - is the x coordinate of the point.
      y - is the y coordinate of the point.
      Returns:
      The bearing to the point x,y in the range [-180,180[

    • distanceTo

      default double distanceTo(double x, double y)
      Calculates the distance from the bots coordinates to a point x,y.
      Parameters:
      x - is the x coordinate of the point.
      y - is the y coordinate of the point.
      Returns:
      The distance to the point x,y.

    • normalizeAbsoluteAngle

      default double normalizeAbsoluteAngle(double angle)
      Normalizes an angle to an absolute angle into the range [0,360[
      Parameters:
      angle - is the angle to normalize.
      Returns:
      The normalized absolute angle.

    • normalizeRelativeAngle

      default double normalizeRelativeAngle(double angle)
      Normalizes an angle to a relative angle into the range [-180,180[
      Parameters:
      angle - is the angle to normalize.
      Returns:
      The normalized relative angle.

    • calcDeltaAngle

      default double calcDeltaAngle(double targetAngle, double sourceAngle)
      Calculates the difference between two angles, i.e. the number of degrees from a source angle to a target angle. The delta angle will be in the range [-180,180]
      Parameters:
      targetAngle - is the target angle.
      sourceAngle - is the source angle.
      Returns:
      The delta angle between a source angle and target angle.