This wiki was in read-only mode for many years, but can now be edited again. A lot of information will need to be updated.

BZRobots: Difference between revisions

From BZFlagWiki
Jump to navigation Jump to search
← Older edit
Zehra (talk | contribs)
968 edits
merged content from BZRobots/API
Zehra (talk | contribs)
968 edits
→API Methods: completed conversion to templates
 
Line 97: Line 97:


Unless otherwise specified, all units are in map units (distance), degrees (angles), and seconds (time)
Unless otherwise specified, all units are in map units (distance), degrees (angles), and seconds (time)


=API Methods=
=API Methods=
Line 158: Line 159:
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! bgcolor="#BBBB00" | Y  
! {{Yellow}} | Y  
! {{Green}} | 100%  
! {{Green}} | 100%  
|-
|-
Line 166: Line 167:
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! bgcolor="#BBBB00" | Y  
! {{Yellow}} | Y  
! bgcolor="#BBBB00" | 50%  
! {{Yellow}} | 50%  
|-
|-
| list<Event> getAllEvents()
| list<Event> getAllEvents()
Line 182: Line 183:
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! bgcolor="#555555" | N/A  
! {{Grey}} | N/A  
! {{Green}} | 100%  
! {{Green}} | 100%  
|-
|-
Line 231: Line 232:
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y
! {{Green}} | Y
! bgcolor="#555555" | N/A  
! {{Grey}} | N/A  
|-
|-
| double getGunCoolingRate()
| double getGunCoolingRate()
Line 238: Line 239:
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! bgcolor="#BBBB00" | Y
! {{Yellow}} | Y
! {{Green}} | 100%  
! {{Green}} | 100%  
|-
|-
Line 262: Line 263:
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! bgcolor="#BBBB00" | Y
! {{Yellow}} | Y
! {{Green}} | 100%  
! {{Green}} | 100%  
|-
|-
Line 271: Line 272:
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y
! {{Green}} | Y
! bgcolor="#555555" | N/A  
! {{Grey}} | N/A  
|-
|-
| double getGunTurnRemainingRadians()
| double getGunTurnRemainingRadians()
Line 279: Line 280:
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y
! {{Green}} | Y
! bgcolor="#555555" | N/A  
! {{Grey}} | N/A  
|-
|-
| double getHeading()
| double getHeading()
Line 310: Line 311:
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! bgcolor="#555555" | N/A  
! {{Grey}} | N/A  
! {{Green}} | 100%  
! {{Green}} | 100%  
|-
|-
Line 359: Line 360:
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y
! {{Green}} | Y
! bgcolor="#555555" | N/A  
! {{Grey}} | N/A  
|-
|-
| double getRadarTurnRemainingRadians()
| double getRadarTurnRemainingRadians()
Line 367: Line 368:
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y
! {{Green}} | Y
! bgcolor="#555555" | N/A  
! {{Grey}} | N/A  
|-
|-
| list<Event> getRobotDeathEvents()
| list<Event> getRobotDeathEvents()
Line 406: Line 407:
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! bgcolor="#BBBB00" | Y
! {{Yellow}} | Y
! {{Green}} | 100%  
! {{Green}} | 100%  
|-
|-
Line 471: Line 472:
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! bgcolor="#555555" | N/A  
! {{Grey}} | N/A  
|-
|-
| bool isAdjustRadarForGunTurn
| bool isAdjustRadarForGunTurn
Line 479: Line 480:
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! bgcolor="#555555" | N/A  
! {{Grey}} | N/A  
|-
|-
| bool isAdjustRadarForRobotTurn
| bool isAdjustRadarForRobotTurn
Line 487: Line 488:
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! bgcolor="#555555" | N/A  
! {{Grey}} | N/A  
|-
|-
| void resume()
| void resume()
Line 510: Line 511:
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! bgcolor="#BBBB00" | Y
! {{Yellow}} | Y
! bgcolor="#555555" | N/A  
! {{Grey}} | N/A  
|-
|-
| void setAdjustRadarForGunTurn(bool independent)
| void setAdjustRadarForGunTurn(bool independent)
Line 518: Line 519:
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! bgcolor="#BBBB00" | Y
! {{Yellow}} | Y
! bgcolor="#555555" | N/A  
! {{Grey}} | N/A  
|-
|-
| void setAdjustRadarForRobotTurn(bool independent)
| void setAdjustRadarForRobotTurn(bool independent)
Line 526: Line 527:
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! bgcolor="#BBBB00" | Y
! {{Yellow}} | Y
! bgcolor="#555555" | N/A  
! {{Grey}} | N/A  
|-
|-
| void setAhead(double distance)
| void setAhead(double distance)
Line 550: Line 551:
! {{Red}} | N  
! {{Red}} | N  
! {{Green}} | Y  
! {{Green}} | Y  
! bgcolor="#BBBB00" | Y  
! {{Yellow}} | Y  
! {{Green}} | 100%  
! {{Green}} | 100%  
|-
|-
Line 558: Line 559:
! {{Red}} | N  
! {{Red}} | N  
! {{Green}} | Y  
! {{Green}} | Y  
! bgcolor="#BBBB00" | Y
! {{Yellow}} | Y
! bgcolor="#BBBB00" | 50%  
! {{Yellow}} | 50%  
|-
|-
| void setMaxTurnRate(double maxTurnRate)
| void setMaxTurnRate(double maxTurnRate)
Line 598: Line 599:
! {{Red}} | N  
! {{Red}} | N  
! {{Green}} | Y  
! {{Green}} | Y  
! bgcolor="#BBBB00" | Y
! {{Yellow}} | Y
! bgcolor="#555555" | N/A  
! {{Grey}} | N/A  
|-
|-
| void void setTurnGunLeftRadians(double radians)
| void void setTurnGunLeftRadians(double radians)
Line 606: Line 607:
! {{Red}} | N  
! {{Red}} | N  
! {{Green}} | Y  
! {{Green}} | Y  
! bgcolor="#BBBB00" | Y
! {{Yellow}} | Y
! bgcolor="#555555" | N/A  
! {{Grey}} | N/A  
|-
|-
| void void setTurnGunRight(double degrees)
| void void setTurnGunRight(double degrees)
Line 614: Line 615:
! {{Red}} | N  
! {{Red}} | N  
! {{Green}} | Y  
! {{Green}} | Y  
! bgcolor="#BBBB00" | Y
! {{Yellow}} | Y
! bgcolor="#555555" | N/A  
! {{Grey}} | N/A  
|-
|-
| void void setTurnGunRightRadians(double radians)
| void void setTurnGunRightRadians(double radians)
Line 622: Line 623:
! {{Red}} | N  
! {{Red}} | N  
! {{Green}} | Y  
! {{Green}} | Y  
! bgcolor="#BBBB00" | Y
! {{Yellow}} | Y
! bgcolor="#555555" | N/A  
! {{Grey}} | N/A  
|-
|-
| void void setTurnLeft(double degrees)
| void void setTurnLeft(double degrees)
Line 646: Line 647:
! {{Red}} | N  
! {{Red}} | N  
! {{Green}} | Y  
! {{Green}} | Y  
! bgcolor="#BBBB00" | Y
! {{Yellow}} | Y
! bgcolor="#555555" | N/A  
! {{Grey}} | N/A  
|-
|-
| void void setTurnRadarLeftRadians(double radians)
| void void setTurnRadarLeftRadians(double radians)
Line 654: Line 655:
! {{Red}} | N  
! {{Red}} | N  
! {{Green}} | Y  
! {{Green}} | Y  
! bgcolor="#BBBB00" | Y
! {{Yellow}} | Y
! bgcolor="#555555" | N/A  
! {{Grey}} | N/A  
|-
|-
| void void setTurnRadarRight(double degrees)
| void void setTurnRadarRight(double degrees)
Line 662: Line 663:
! {{Red}} | N  
! {{Red}} | N  
! {{Green}} | Y  
! {{Green}} | Y  
! bgcolor="#BBBB00" | Y
! {{Yellow}} | Y
! bgcolor="#555555" | N/A  
! {{Grey}} | N/A  
|-
|-
| void void setTurnRadarRightRadians(double radians)
| void void setTurnRadarRightRadians(double radians)
Line 670: Line 671:
! {{Red}} | N  
! {{Red}} | N  
! {{Green}} | Y  
! {{Green}} | Y  
! bgcolor="#BBBB00" | Y
! {{Yellow}} | Y
! bgcolor="#555555" | N/A  
! {{Grey}} | N/A  
|-
|-
| void void setTurnRight(double degrees)
| void void setTurnRight(double degrees)
Line 702: Line 703:
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! bgcolor="#BBBB00" | Y
! {{Yellow}} | Y
! bgcolor="#555555" | N/A  
! {{Grey}} | N/A  
|-
|-
| void turnGunLeft(double degrees)
| void turnGunLeft(double degrees)
Line 710: Line 711:
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! bgcolor="#BBBB00" | Y
! {{Yellow}} | Y
! bgcolor="#555555" | N/A  
! {{Grey}} | N/A  
|-
|-
| void turnLeft(double degrees)
| void turnLeft(double degrees)
Line 734: Line 735:
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! bgcolor="#BBBB00" | Y  
! {{Yellow}} | Y  
! bgcolor="#555555" | N/A  
! {{Grey}} | N/A  
|-
|-
| void turnRadarLeft(double degrees)
| void turnRadarLeft(double degrees)
Line 742: Line 743:
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! bgcolor="#BBBB00" | Y  
! {{Yellow}} | Y  
! bgcolor="#555555" | N/A  
! {{Grey}} | N/A  
|-
|-
| void turnRadarLeftRadians(double radians)
| void turnRadarLeftRadians(double radians)
Line 750: Line 751:
! {{Red}} | N  
! {{Red}} | N  
! {{Green}} | Y  
! {{Green}} | Y  
! bgcolor="#BBBB00" | Y  
! {{Yellow}} | Y  
! bgcolor="#555555" | N/A  
! {{Grey}} | N/A  
|-
|-
| void turnRadarRight(double degrees)
| void turnRadarRight(double degrees)
Line 758: Line 759:
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! bgcolor="#BBBB00" | Y  
! {{Yellow}} | Y  
! bgcolor="#555555" | N/A  
! {{Grey}} | N/A  
|-
|-
| void turnRadarRightRadians(double radians)
| void turnRadarRightRadians(double radians)
Line 766: Line 767:
! {{Red}} | N  
! {{Red}} | N  
! {{Green}} | Y  
! {{Green}} | Y  
! bgcolor="#BBBB00" | Y  
! {{Yellow}} | Y  
! bgcolor="#555555" | N/A  
! {{Grey}} | N/A  
|-
|-
| void turnRight(double degrees)
| void turnRight(double degrees)
Line 797: Line 798:
| void onBattleEnded(BattleEndedEvent e)
| void onBattleEnded(BattleEndedEvent e)
| Called at the end of a league match, or the server shutting down
| Called at the end of a league match, or the server shutting down
! bgcolor="#555555" | N/A  
! {{Grey}} | N/A  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
Line 805: Line 806:
| void onBulletFired(BulletFiredEvent e)
| void onBulletFired(BulletFiredEvent e)
| Called when another robot/tank fires a bullet
| Called when another robot/tank fires a bullet
! bgcolor="#555555" | N/A  
! {{Grey}} | N/A  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! bgcolor="#555555" | N/A  
! {{Grey}} | N/A  
! {{Red}} | 10%  
! {{Red}} | 10%  
|-
|-
| void onBulletHit(BulletHitEvent e)
| void onBulletHit(BulletHitEvent e)
| Called when a bullet fired by the robot hits another robot
| Called when a bullet fired by the robot hits another robot
! bgcolor="#555555" | N/A  
! {{Grey}} | N/A  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! bgcolor="#BBBB00" | 80%  
! {{Yellow}} | 80%  
|-
|-
| void onBulletHitBullet(BulletHitBulletEvente)
| void onBulletHitBullet(BulletHitBulletEvente)
| For robocode compatibility - will never take place
| For robocode compatibility - will never take place
! bgcolor="#555555" | N/A  
! {{Grey}} | N/A  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! bgcolor="#555555" | N/A  
! {{Grey}} | N/A  
|-
|-
| void onBulletMissed(BulletMissedEvent e)
| void onBulletMissed(BulletMissedEvent e)
| Called when a bullet fired by the robot expires or hits a wall
| Called when a bullet fired by the robot expires or hits a wall
! bgcolor="#555555" | N/A  
! {{Grey}} | N/A  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
Line 837: Line 838:
| void onDeath(DeathEvent e)
| void onDeath(DeathEvent e)
| Called when the robot dies
| Called when the robot dies
! bgcolor="#555555" | N/A  
! {{Grey}} | N/A  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
Line 845: Line 846:
| void onHitByBullet(HitByBulletEvent e)
| void onHitByBullet(HitByBulletEvent e)
| Called when the robot is hit by a bullet
| Called when the robot is hit by a bullet
! bgcolor="#555555" | N/A  
! {{Grey}} | N/A  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
Line 853: Line 854:
| void onHitRobot(HitRobotEvente)
| void onHitRobot(HitRobotEvente)
| For robocode compatibility - will never be called
| For robocode compatibility - will never be called
! bgcolor="#555555" | N/A  
! {{Grey}} | N/A  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! bgcolor="#555555" | N/A  
! {{Grey}} | N/A  
|-
|-
| void onHitWall(HitWallEvent e)
| void onHitWall(HitWallEvent e)
| Called when the robot runs into a wall or object
| Called when the robot runs into a wall or object
! bgcolor="#555555" | N/A  
! {{Grey}} | N/A  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
Line 869: Line 870:
| void onRobotDeath(RobotDeathEvent e)
| void onRobotDeath(RobotDeathEvent e)
| Called when the robot is killed
| Called when the robot is killed
! bgcolor="#555555" | N/A  
! {{Grey}} | N/A  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
Line 877: Line 878:
| void onScannedRobot(ScannedRobotEvent e)
| void onScannedRobot(ScannedRobotEvent e)
| Called each turn as the robot's radar "sees" another robot
| Called each turn as the robot's radar "sees" another robot
! bgcolor="#555555" | N/A  
! {{Grey}} | N/A  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
Line 885: Line 886:
| void onSpawn(SpawnEvent e)
| void onSpawn(SpawnEvent e)
| Called when the robot spawns
| Called when the robot spawns
! bgcolor="#555555" | N/A  
! {{Grey}} | N/A  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! bgcolor="#555555" | N/A
! {{Grey}} | N/A
! {{Green}} | 100%  
! {{Green}} | 100%  
|-
|-
| void onStatus(StatusEvent e)
| void onStatus(StatusEvent e)
| Called at the beginning of each "turn", before the main loop is run
| Called at the beginning of each "turn", before the main loop is run
! bgcolor="#555555" | N/A  
! {{Grey}} | N/A  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
Line 901: Line 902:
| void onWin(WinEvent e)
| void onWin(WinEvent e)
| Called when the robot (or it's team) wins a league match
| Called when the robot (or it's team) wins a league match
! bgcolor="#555555" | N/A  
! {{Grey}} | N/A  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! {{Green}} | Y  
! bgcolor="#BBBB00" | Y  
! {{Yellow}} | Y  
! {{Red}} | 10%  
! {{Red}} | 10%  
|-
|-

Latest revision as of 01:57, 7 December 2025

About BZRobots

(Note that the following information applies to the BZRobots in the upcoming BZFlag 3.0 release)

BZRobots is a programmable computer player client that is compatible with the BZFS server. It is designed to be an artificial intelligence training and development tool that operates under the BZFlag platform.

BZRobots requires that you have already configured and are running an instance of BZFS, that allows one or more bots (using the -botsPerIP setting). Also, BZRobots is a "headless" client (i.e. there are no graphics, it is only text-based), so if you want to watch your bots in action, you will also need to join as an observer or player using the BZFlag client.

Quick Start: Building

Linux/OS X

The BZRobots client (and support for C++ bots) will by default as a standard part of the bzflag trunk build. However, if you want to build Python bots, you will need to run ./configure with the option --enable-bzrobots-python (and of course have the necessary dependencies)

Windows

Open the bzrobots solution, then build the bzrobots and testbot projects.

Quick Start: Running

(Note: This quick start assumes that you will be testing bzrobots from within the build directory, have already run 'autogen.sh', 'configure', and 'make' and have not run 'make install')

Linux/OS X: Shared Library [.so]

(Due to the use of libtool, the binary TestRobot.so is in the .libs directory) 

# cd bzflag/src/bzrobots
# ./bzrobots -team red sobot@localhost .libs/TestRobot.so

Linux/OS X: Python [.py]

# cd bzflag/src/bzrobots
# ln -s .libs/bzrobot_pyext.so ./bzrobot_pyext.so
# ./bzrobots -team red pybot@localhost ../../bots/python/TestRobot.py

Linux/OS X: LUA [.lua]

# cd bzflag/src/bzrobots
# ./bzrobots -team red luabot@localhost ../../bots/lua/bzbot.lua

Windows: Shared Library [.dll]

# cd bzflag
# bzrobots.exe -team red dllbot@localhost TestRobot.dll

Windows: LUA [.lua]

# cd bzflag
# bzrobots.exe -team red luabot@localhost bots\lua\bzbot.lua

Developing Robots

See Also

BZRobots/Ideas

This page is to collaborate on ideas for the BZRobots Programmable Computer Player Client

Suggested ideas

API functions

  • Provide an API for visual targets based on the same rules a player would see.
    • This would only apply to maps using flags
  • Provide global, team, admin, and report chat APIs so bots can communicate just like players, perhaps with some parsing helper functions.

Input

  • Allows input of coordinates/properties from stdin, so info from other apps, gps, etc. can be pumped into the bot
    • What to do when multiple bots are running in the same client?

Accepted ideas

Scripting

  • Be able to load multiple modules.
    • A small amount of work in bzrobots client should make this happen

Rejected ideas

API functions

  • Have methods to compute travel paths to desired locations, with updates for moving targets.
    • (Rejected as it defeats the purpose of BZRobots as an AI learning tool)
  • Add a getTank(callsign) function
    • (Rejected due because BZRobots now supports the onScannedPlayer event)


History

The BZRobots Programmable Computer Player Client was originally developed by Brigham Young University as a project called BZRC

In 2007 it was further developed by Jørgen Pedersen Tjernø (AKA daxxar) as part of the Google Summer of Code. Information about his work can be found on his GSoC blog at http://gsoc.daxxar.com

This work was continued in 2009 by Mathew Eis (AKA Bulldozer and KingRobot), again as part of Google Summer of Code.

The current BZRobots code can be found in the BZFlag subversion system at http://bzflag.svn.sourceforge.net/svnroot/bzflag/trunk/bzflag/src/bzrobots

BZRobots API

The API for the BZRobots Programmable Computer Player Client.


The BZRobots API is based heavily on the robocode project. It is class-based, meaning that a robot is built by extending from one of the following two classes:

  • Robot (An easy-to-use robot with a simplified API, e.g. degree units, etc.)
  • AdvancedRobot (A robot with more advanced features in the API, e.g. radian units, etc.)


The main control loop is created by overriding the class method run, and then using the methods shown below to control the robot. These control methods fit into two categories 'blocking', and 'non-blocking'. A blocking function, once called, will not return until either the requested action has completed, or the amount of time allotted for a "turn" or "tick" has passed - whichever comes later.

Non-blocking functions will return immediately, allowing for additional processing, but their actions do not take effect immediately; rather, they will take place when the execute method is called. After a blocking function has been called, various "events" that have been generated during that turn may be processed by the various event methods, if they have been overridden.


If you are new to BZRobots, but have Robocode experience, you may want to take a look at BZRobots/API_BZRobots_vs_Robocode


Unless otherwise specified, all units are in map units (distance), degrees (angles), and seconds (time)


API Methods

Note: As BZRobots currently supports bot scripts written in three different languages, the following is language independent description of the methods available for bot development. Actual usage will vary depending on the language used

==Robot/AdvancedRobot Methods==
Method Description Blocking Robot Advanced
Robot 		Robocode
Compatible 		Functional
Status
void ahead(double distance) Moves the robot ahead by distance Y Y Y Y 100%
void back(double distance) Moves the robot back by distance Y Y Y Y 100%
void clearAllEvents() Clears the event queue; any events will be disgarded N N Y Y 100%
void doNothing() Clears the event queue; any events will be disgarded Y Y Y Y 100%
void execute() Causes any action queued by setAhead, setTurnRight, etc. to take place, ending the "turn" Y N Y Y 100%
void fire(double power) Fires a single shot Y Y Y Y 100%
Bullet *fireBullet(double power) Fires a single shot, returning a reference to the fired shot Y Y Y Y 50%
list<Event> getAllEvents() Returns a list of all events currently in the queue N N Y Y 5%
double getBattleFieldLength() Returns the length of the battle field N Y Y N/A 100%
double getBattleFieldWidth() Returns the width of the battle field N Y Y Y 100%
list<Event> getBulletHitBulletEvents() Returns a list of BulletHitBulletEvent currently in the queue N N Y Y 5%
list<Event> getBulletHitEvents() Returns a list of BulletHitEvent currently in the queue N N Y Y 5%
list<Event> getBulletMissedEvents() Returns a list of all BulletMissedEvent currently in the queue N N Y Y 5%
double getDistanceRemaining() Returns the distance remaining from a setAhead/setBack N N Y Y 100%
double getEnergy() For robocode compatibly - robot's current "energy" (Always 16) N Y Y Y N/A
double getGunCoolingRate() Returns the time it takes to reload a single shot N Y Y Y 100%
double getGunHeading() For robocode compatibly - robot's gun heading (Always matches robot heading) N Y Y Y 100%
double getGunHeadingRadians() For robocode compatibly - robot's gun heading (Always matches robot heading) N N Y Y 100%
double getGunHeat() Returns the time until the gun will be ready to fire N Y Y Y 100%
double getGunTurnRemaining() For robocode compatibly - (Always returns 0) N N Y Y N/A
double getGunTurnRemainingRadians() For robocode compatibly - (Always returns 0) N N Y Y N/A
double getHeading() Returns the current heading of the robot N Y Y Y 100%
double getHeadingRadians() Returns the current heading of the robot in radians N N Y Y 100%
double getHeight() Returns the height (Z-size) of the robot N Y Y N 100%
double getLength() Returns the length (Y-size) of the robot N Y Y N/A 100%
string getName() Returns the name (Callsign) of the robot N Y Y Y 100%
int getNumRounds() For robocode compatibly - number of battle rounds (Always 1) N Y Y Y 100%
int getOthers() Returns the number of other robots/tanks currently in the battle N Y Y Y 100%
double getRadarHeading() For robocode compatibly - robot's radar heading (Always matches robot heading) N Y Y Y 100%
double getRadarHeadingRadians() For robocode compatibly - robot's radar heading (Always matches robot heading) N N Y Y 100%
double getRadarTurnRemaining() For robocode compatibly - (Always returns 0) N N Y Y N/A
double getRadarTurnRemainingRadians() For robocode compatibly - (Always returns 0) N N Y Y N/A
list<Event> getRobotDeathEvents() Returns a list of all RobotDeathEvent currently in the queue N N Y Y 5%
int getRoundNum() For robocode compatibly - current battle round (Always 1) N Y Y Y 100%
list<Event> getScannedRobotEvents() Returns a list of all ScannedRobotEvent currently in the queue N N Y Y 5%
list<Event> getStatusEvents() Returns a list of all StatusEvent currently in the queue N N Y Y 5%
double getTime() Returns the current game time N Y Y Y 100%
double getTurnRemaining() Returns the distance remaining from a setTurnLeft/setTurnRight N N Y Y 100%
double getTurnRemainingRadians() Returns the distance remaining from a setTurnLeft/setTurnRight in radians N N Y Y 100%
double getVelocity() Returns the speed of the robot (excluding the Z-speed) N Y Y Y 100%
double getWidth() Returns the width (X-size) of the robot N Y Y Y 100%
double getX() Returns the current X coordinate of the robot N Y Y Y 100%
double getY() Returns the current Y coordinate of the robot N Y Y Y 100%
double getZ() Returns the current Z coordinate of the robot N Y Y Y 100%
bool isAdjustGunForRobotTurn For robocode compatibility - always true N N Y Y N/A
bool isAdjustRadarForGunTurn For robocode compatibility - always true N N Y Y N/A
bool isAdjustRadarForRobotTurn For robocode compatibility - always true N N Y Y N/A
void resume() Resumes any movements saved by a previous call to stop N Y Y Y 100%
void scan() Prompts a radar scan, resulting in onScannedRobot events Y Y Y Y 100%
void setAdjustGunForRobotTurn(bool independent) For robocode compatibly - but has no effect when false N Y Y Y N/A
void setAdjustRadarForGunTurn(bool independent) For robocode compatibly - but has no effect when false N Y Y Y N/A
void setAdjustRadarForRobotTurn(bool independent) For robocode compatibly - but has no effect when false N Y Y Y N/A
void setAhead(double distance) Specifies that the robot should move forward by distance at the next execute() N N Y Y 100%
void setBack(double distance) Specifies that the robot should move backwad by distance at the next execute() N N Y Y 100%
void setFire(double power) Specifies that the robot should fire a bullet of power at the next execute() N N Y Y 100%
Bullet *setFireBullet(double power) Specifies that the robot should fire a bullet of power at the next execute() N N Y Y 50%
void setMaxTurnRate(double maxTurnRate) Sets a limit on the maximum turn rate of the robot at the next execute() N N Y Y 100%
void setMaxVelocity(double maxVelocity) Sets a limit on the maximum speed of the robot at the next execute() N N Y Y 100%
void setResume() Immediately resumes any motion halted by setStop N N Y Y 100%
void setStop(bool overwrite = false) Immediately stops any motion until resumed by setResume N N Y Y 100%
void void setTurnGunLeft(double degrees) For robocode compatablity - has no effect N N Y Y N/A
void void setTurnGunLeftRadians(double radians) For robocode compatablity - has no effect N N Y Y N/A
void void setTurnGunRight(double degrees) For robocode compatablity - has no effect N N Y Y N/A
void void setTurnGunRightRadians(double radians) For robocode compatablity - has no effect N N Y Y N/A
void void setTurnLeft(double degrees) Sets the robot to turn left by degrees at the next execute() N N Y Y 100%
void void setTurnLeftRadians(double radians) Sets the robot to turn left by radians at the next execute() N N Y Y 100%
void void setTurnRadarLeft(double degrees) For robocode compatibility - has no effect N N Y Y N/A
void void setTurnRadarLeftRadians(double radians) For robocode compatibility - has no effect N N Y Y N/A
void void setTurnRadarRight(double degrees) For robocode compatibility - has no effect N N Y Y N/A
void void setTurnRadarRightRadians(double radians) For robocode compatibility - has no effect N N Y Y N/A
void void setTurnRight(double degrees) Sets the robot to turn right by degrees at the next execute() N N Y Y 100%
void void setTurnRightRadians(double radians) Sets the robot to turn right by radians at the next execute() N N Y Y 100%
void stop(bool overwrite = false) Stops the robot, saving any current movements N Y Y Y 100%
void turnGunRight(double degrees) For robocode compatibly - but has no effect N Y Y Y N/A
void turnGunLeft(double degrees) For robocode compatibly - but has no effect N Y Y Y N/A
void turnLeft(double degrees) Turns the robot left degrees degrees Y Y Y Y 100%
void turnLeftRadians(double radians) Turns the robot left radians radians Y N Y Y 100%
void turnRadarRight(double degrees) For robocode compatibly - but has no effect N Y Y Y N/A
void turnRadarLeft(double degrees) For robocode compatibly - but has no effect N Y Y Y N/A
void turnRadarLeftRadians(double radians) For robocode compatibly - but has no effect N N Y Y N/A
void turnRadarRight(double degrees) For robocode compatibly - but has no effect N Y Y Y N/A
void turnRadarRightRadians(double radians) For robocode compatibly - but has no effect N N Y Y N/A
void turnRight(double degrees) Turns the robot right degrees degrees Y Y Y Y 100%
void turnRightRadians(double radians) Turns the robot right radians radians Y N Y Y 100%
==Robot/AdvancedRobot Event Handlers==
Method Description Blocking Robot Advanced
Robot 		Robocode
Compatible 		Functional
Status
void onBattleEnded(BattleEndedEvent e) Called at the end of a league match, or the server shutting down N/A Y Y Y 10%
void onBulletFired(BulletFiredEvent e) Called when another robot/tank fires a bullet N/A Y Y N/A 10%
void onBulletHit(BulletHitEvent e) Called when a bullet fired by the robot hits another robot N/A Y Y Y 80%
void onBulletHitBullet(BulletHitBulletEvente) For robocode compatibility - will never take place N/A Y Y Y N/A
void onBulletMissed(BulletMissedEvent e) Called when a bullet fired by the robot expires or hits a wall N/A Y Y Y 10%
void onDeath(DeathEvent e) Called when the robot dies N/A Y Y Y 100%
void onHitByBullet(HitByBulletEvent e) Called when the robot is hit by a bullet N/A Y Y Y 25%
void onHitRobot(HitRobotEvente) For robocode compatibility - will never be called N/A Y Y Y N/A
void onHitWall(HitWallEvent e) Called when the robot runs into a wall or object N/A Y Y Y 90%
void onRobotDeath(RobotDeathEvent e) Called when the robot is killed N/A Y Y Y 100%
void onScannedRobot(ScannedRobotEvent e) Called each turn as the robot's radar "sees" another robot N/A Y Y Y 100%
void onSpawn(SpawnEvent e) Called when the robot spawns N/A Y Y N/A 100%
void onStatus(StatusEvent e) Called at the beginning of each "turn", before the main loop is run N/A Y Y Y 95%
void onWin(WinEvent e) Called when the robot (or it's team) wins a league match N/A Y Y Y 10%

See Also

Retrieved from "https://wiki.bzflag.org/index.php?title=BZRobots&oldid=10097"