Difference between revisions of "Robocode/Game Physics"

From Robowiki
Jump to navigation Jump to search
(Improve formatting and move documentation footer to a template)
m (fix coordinates gif)
 
(5 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
This page describes the game physics of [[Robocode]].
 
This page describes the game physics of [[Robocode]].
  
== Coordinates and direction conventions ==
+
== Coordinates and directions ==
https://i.imgur.com/7Pkqy65.gif
+
[[File:RobocodeCoordinates.gif]]
 
<br />
 
<br />
  
Line 9: Line 9:
  
 
;Rotational direction system
 
;Rotational direction system
: Robocode uses a clockwise direction convention where 0°/360° is north, 90° is east, 180° is south, and 270° is west.
+
: Robocode uses a clockwise direction convention where 0° & 360° is north, 90° is east, 180° is south, and 270° is west.
 +
: In radians it's 0 & 2𝜋 ~= 6.28 is north, 𝜋/2 ~= 1.57 is east, 𝜋 ~= 3.14 is south, and 3𝜋/2 ~= 4.71 is west.
  
== Time and distance measurements ==
+
== Time and distance ==
 
;Time measurement
 
;Time measurement
 
:Robocode time is measured in "ticks". Each robot gets one turn per tick. 1 tick = 1 turn.
 
:Robocode time is measured in "ticks". Each robot gets one turn per tick. 1 tick = 1 turn.
  
 
;Distance measurement
 
;Distance measurement
:Robocode's units are basically measured in pixels, with two exceptions. First, all distances are measured with ''double'' precision, so you can actually move a fraction of a pixel. Second, Robocode automatically scales down battles to fit on the screen. In this case, the unit of distance is actually smaller than a pixel.
+
:Robocode's distance units are measured with double precision, so you can move a fraction of a unit. Generally, 1 Robocode distance unit = 1 pixel, except when Robocode automatically scales down battles to fit on the screen.
  
== Robot movement physics ==
+
== Movement physics ==
 
;Acceleration (a)
 
;Acceleration (a)
:Robots accelerate at the rate of 1 pixel/turn/turn. Robots decelerate at the rate of 2 pixels/turn/turn. Robocode determines acceleration for you, based on the distance you are trying to move.
+
:Robots accelerate at the rate of 1 pixel/turn every turn. Robots decelerate at the rate of 2 pixels/turn every turn. Robocode determines acceleration for you, based on the distance you are trying to move.
  
;Velocity equation (v)
+
;Velocity (v)
:v = at. Velocity can never exceed 8 pixels/turn. Note that technically, velocity is a vector, but in Robocode we simply assume the direction of the vector to be the robot's heading.
+
:The velocity equation is: v = at. Velocity can never exceed 8 pixels/turn. Note that technically, velocity is a vector, but in Robocode we simply assume the direction of the vector to be the robot's heading.
  
;Distance equation (d)
+
;Distance (d)
:d = vt. That is, distance = velocity * time
+
:The distance formula is: d = vt. That is, distance = velocity * time
  
== Robot, gun, and radar rotation ==
+
== Rotation ==
;Maximum rotational rate of robot base
+
;Robot base rotation
:(10 - 0.75 * abs(velocity)) deg/turn. The faster you're moving, the slower you turn.
+
:The maximum rate of rotation is: (10 - 0.75 * abs(velocity)) deg/turn. The faster you're moving, the slower you turn.
  
;Maximum rotational rate of gun
+
;Gun rotation
:20 deg/turn. This is added to the current rate of rotation of the robot.
+
:The maximum rate of rotation is: 20 deg/turn. This is added to the current rate of rotation of the robot.
  
;Maximum rotational rate of radar
+
;Radar rotation
:45 deg/turn. This is added to the current rate of rotation of the gun.
+
:The maximum rate of rotation is: 45 deg/turn. This is added to the current rate of rotation of the gun.
  
 
== Bullets ==
 
== Bullets ==
Line 43: Line 44:
  
 
;Bullet velocity
 
;Bullet velocity
:20 - 3 * firepower
+
:20 - 3 * firepower.
  
 
;Gun heat generated on firing
 
;Gun heat generated on firing
Line 49: Line 50:
  
 
;Energy returned on hit
 
;Energy returned on hit
:3 * firepower
+
:3 * firepower.
  
 
== Collisions ==
 
== Collisions ==
Line 56: Line 57:
  
 
;Collision with a wall
 
;Collision with a wall
:AdvancedRobots take <code>abs(velocity) * 0.5 - 1</code> (never < 0).
+
:AdvancedRobots take damage = abs(velocity) * 0.5 - 1 (never < 0).
  
 
== Robocode processing loop ==
 
== Robocode processing loop ==
Line 62: Line 63:
  
 
# Battle view is (re)painted.
 
# Battle view is (re)painted.
# All robots execute their code until they take action (and then paused).
+
# All robots execute their code until they take action (and are then paused).
# Time is updated (time = time + 1).
+
# Time is updated (time++).
# All bullets move and check for collisions. This includes firing bullets.
+
# All bullets move (including the bullet fired in the last tick) and are checked for collisions.
# All robots move (gun, radar, heading, acceleration, velocity, distance, in that order).
+
# All robots move (gun, radar, heading, acceleration, velocity, distance, in that order. gun heat is also decreased in this step).
 
# All robots perform scans (and collect team messages).
 
# All robots perform scans (and collect team messages).
 
# All robots are resumed to take new action.
 
# All robots are resumed to take new action.
 
# Each robot processes its event queue.
 
# Each robot processes its event queue.
  
Most of this can be gleamed by following the method calls from BaseBattle.runRound() and Battle.runTurn() in the robocode.battle module.
+
Most of this can be gleaned by following the method calls from [https://github.com/robo-code/robocode/blob/0eb93ba532bc6731b7ff8dd02da1308d92ccb2fd/robocode.battle/src/main/java/net/sf/robocode/battle/BaseBattle.java#L251 <code>BaseBattle.runRound()</code>] and [https://github.com/robo-code/robocode/blob/0eb93ba532bc6731b7ff8dd02da1308d92ccb2fd/robocode.battle/src/main/java/net/sf/robocode/battle/Battle.java#L411 <code>Battle.runTurn()</code>] in the <code>robocode.battle</code> module.
 +
 
 +
=== Firing pitfall ===
 +
Because bullets are fired before the gun is moved, calling setFire() will cause the bullet to leave at the current gun heading. This may seem counter-intuitive if you are used to thinking in terms of pointing a gun, then shooting. It is also inconvenient because you can't call <code>setTurnGun(...)</code> and <code>setFire(...)</code> right after each other (not if you need perfect accuracy, anyway). Most of the time, the error will be so small you won't notice it, but if you're testing a pattern matcher against sample.Walls, you will occasionally spot the bug.
 +
 
 +
To get the bullet to leave after turning the gun, you will need to use code like this:
 +
 
 +
<syntaxhighlight>
 +
long fireTime = 0;
 +
void doGun() {
 +
    if (fireTime == getTime() && getGunTurnRemaining() == 0) {
 +
        setFire(2);
 +
    }
 +
 
 +
    // ... aiming code ...
 +
 
 +
    setTurnGunRight(...);
 +
    // Don't need to check whether gun turn will complete in single turn because
 +
    // we check that gun is finished turning before calling setFire(...).
 +
    // This is simpler since the precise angle your gun can move in one tick
 +
    // depends on where your robot is turning.
 +
    fireTime = getTime() + 1;
 +
}
 +
</syntaxhighlight>
 +
 
 +
== Event handling ==
  
 
Event dispatch happens from within commands that take a turn.  So the call stack when an event is delivered usually looks like this:
 
Event dispatch happens from within commands that take a turn.  So the call stack when an event is delivered usually looks like this:
Line 93: Line 119:
  
 
It is possible, though not usually useful, to catch and respond to EventInterruptedExceptions in the first handler instead.
 
It is possible, though not usually useful, to catch and respond to EventInterruptedExceptions in the first handler instead.
 
=== Firing pitfall ===
 
Because bullets are fired before the gun is moved, calling setFire() will cause the bullet to leave at the current gun heading. This may seem counter-intuitive if you are used to thinking in terms of pointing a gun, then shooting. It is also inconvenient because you can't call <code>setTurnGun(...)</code> and <code>setFire(...)</code> right after each other (not if you need perfect accuracy, anyway). Most of the time, the error will be so small you won't notice it, but if you're testing a pattern matcher against <code>sample.Walls</code>, you will occasionally spot the bug.
 
 
To get the bullet to leave after turning the gun, you will need to use code like this:
 
 
<syntaxhighlight>
 
long fireTime = 0;
 
void doGun() {
 
    if (fireTime == getTime() && getGunTurnRemaining() == 0) {
 
        setFire(2);
 
    }
 
 
    // ... aiming code ...
 
 
    setTurnGunRight(...);
 
    // Don't need to check whether gun turn will complete in single turn because
 
    // we check that gun is finished turning before calling setFire(...).
 
    // This is simpler since the precise angle your gun can move in one tick
 
    // depends on where your robot is turning.
 
    fireTime = getTime() + 1;
 
}
 
</syntaxhighlight>
 
  
 
== See also ==
 
== See also ==

Latest revision as of 05:06, 16 September 2021

This page describes the game physics of Robocode.

Coordinates and directions

RobocodeCoordinates.gif

Coordinates system
Robocode uses the Cartesian coordinate system, which means that that the (0, 0) coordinate is located at the bottom-left corner of the battlefield.
Rotational direction system
Robocode uses a clockwise direction convention where 0° & 360° is north, 90° is east, 180° is south, and 270° is west.
In radians it's 0 & 2𝜋 ~= 6.28 is north, 𝜋/2 ~= 1.57 is east, 𝜋 ~= 3.14 is south, and 3𝜋/2 ~= 4.71 is west.

Time and distance

Time measurement
Robocode time is measured in "ticks". Each robot gets one turn per tick. 1 tick = 1 turn.
Distance measurement
Robocode's distance units are measured with double precision, so you can move a fraction of a unit. Generally, 1 Robocode distance unit = 1 pixel, except when Robocode automatically scales down battles to fit on the screen.

Movement physics

Acceleration (a)
Robots accelerate at the rate of 1 pixel/turn every turn. Robots decelerate at the rate of 2 pixels/turn every turn. Robocode determines acceleration for you, based on the distance you are trying to move.
Velocity (v)
The velocity equation is: v = at. Velocity can never exceed 8 pixels/turn. Note that technically, velocity is a vector, but in Robocode we simply assume the direction of the vector to be the robot's heading.
Distance (d)
The distance formula is: d = vt. That is, distance = velocity * time

Rotation

Robot base rotation
The maximum rate of rotation is: (10 - 0.75 * abs(velocity)) deg/turn. The faster you're moving, the slower you turn.
Gun rotation
The maximum rate of rotation is: 20 deg/turn. This is added to the current rate of rotation of the robot.
Radar rotation
The maximum rate of rotation is: 45 deg/turn. This is added to the current rate of rotation of the gun.

Bullets

Bullet damage
4 * firepower. If firepower > 1, it does an additional damage = 2 * (power - 1).
Bullet velocity
20 - 3 * firepower.
Gun heat generated on firing
1 + firepower / 5. You cannot fire if gunHeat > 0. All guns are hot at the start of each round.
Energy returned on hit
3 * firepower.

Collisions

Collision with another robot
Each robot takes 0.6 damage. If a robot is moving away from the collision, it will not be stopped.
Collision with a wall
AdvancedRobots take damage = abs(velocity) * 0.5 - 1 (never < 0).

Robocode processing loop

The order that Robocode runs is as follows:

  1. Battle view is (re)painted.
  2. All robots execute their code until they take action (and are then paused).
  3. Time is updated (time++).
  4. All bullets move (including the bullet fired in the last tick) and are checked for collisions.
  5. All robots move (gun, radar, heading, acceleration, velocity, distance, in that order. gun heat is also decreased in this step).
  6. All robots perform scans (and collect team messages).
  7. All robots are resumed to take new action.
  8. Each robot processes its event queue.

Most of this can be gleaned by following the method calls from BaseBattle.runRound() and Battle.runTurn() in the robocode.battle module.

Firing pitfall

Because bullets are fired before the gun is moved, calling setFire() will cause the bullet to leave at the current gun heading. This may seem counter-intuitive if you are used to thinking in terms of pointing a gun, then shooting. It is also inconvenient because you can't call setTurnGun(...) and setFire(...) right after each other (not if you need perfect accuracy, anyway). Most of the time, the error will be so small you won't notice it, but if you're testing a pattern matcher against sample.Walls, you will occasionally spot the bug.

To get the bullet to leave after turning the gun, you will need to use code like this:

long fireTime = 0;
void doGun() {
    if (fireTime == getTime() && getGunTurnRemaining() == 0) {
        setFire(2);
    }

    // ... aiming code ...

    setTurnGunRight(...);
    // Don't need to check whether gun turn will complete in single turn because
    // we check that gun is finished turning before calling setFire(...).
    // This is simpler since the precise angle your gun can move in one tick
    // depends on where your robot is turning.
    fireTime = getTime() + 1;
}

Event handling

Event dispatch happens from within commands that take a turn. So the call stack when an event is delivered usually looks like this:

Robocode internals → Robot's run method → Robocode internals → Event handler

However, event handlers can themselves make calls that take turns. If one of these happens to generate an event, we might see a call stack like

Robocode internals → Robot's run method → Robocode internals → First event handler → Robocode internals → Second event handler

But this kind of nesting could lead to a stack overflow. Or—more commonly—cases where the first handler finishes up its actions long after the response-provoking situation has passed. Thus, Robocode takes special steps for events generated within event handlers; these measures are implemented in EventManager.processEvents(). In particular, the call stack will get as far as

Robocode internals → Robot's run method → Robocode internals (including processEvents) → First event handler → Robocode internals (including processEvents)

but then the inner processEvents will detect the impending nesting and throw an EventInterruptedException, which unwinds the stack to the catch block in the outer processEvents:

Robocode internals → Robot's run method → Robocode internals (including processEvents)

effectively canceling whatever the running event handler was up to. Next, the event-delivering loop in the outer processEvents resumes delivering events, letting the second event handler execute unnested:

Robocode internals → Robot's run method → Robocode internals → Second event handler

It is possible, though not usually useful, to catch and respond to EventInterruptedExceptions in the first handler instead.

See also

Robocode API

Beginner Guides

External Editors

.NET Robots

Links