This wiki is archived and useful information is being migrated to the main bzflag.org website
Editing BZRobots/API
Warning: The database has been locked for maintenance, so you will not be able to save your edits right now. You may wish to copy and paste your text into a text file and save it for later.
The administrator who locked it offered this explanation: Archived wiki
The edit can be undone.
Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision | Your text | ||
Line 13: | Line 13: | ||
− | + | Unless otherwise specified, all units are in map units (distance), degrees (angles), and seconds (time) | |
− | |||
− | |||
=API Methods= | =API Methods= | ||
Line 57: | Line 55: | ||
! bgcolor="#00BB00" | 100% | ! bgcolor="#00BB00" | 100% | ||
|- | |- | ||
− | | void | + | | void execute() |
− | | | + | | Causes any action queued by setAhead, setTurnRight, etc. to take place, ending the "turn" |
− | + | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
+ | ! bgcolor="#BB0000" | N | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
! bgcolor="#00BB00" | 100% | ! bgcolor="#00BB00" | 100% | ||
|- | |- | ||
− | | void | + | | void doNothing() |
− | | | + | | Does nothing (equivalent of a short sleep) |
+ | ! bgcolor="#00BB00" | Y | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
− | |||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
! bgcolor="#00BB00" | 100% | ! bgcolor="#00BB00" | 100% | ||
|- | |- | ||
− | | void fire( | + | | void fire() |
| Fires a single shot | | Fires a single shot | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
− | ! bgcolor="# | + | ! bgcolor="#00BB00" | Y |
! bgcolor="#00BB00" | 100% | ! bgcolor="#00BB00" | 100% | ||
|- | |- | ||
− | | Bullet *fireBullet( | + | | Bullet *fireBullet() |
| Fires a single shot, returning a reference to the fired shot | | Fires a single shot, returning a reference to the fired shot | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
− | ! bgcolor="# | + | ! bgcolor="#00BB00" | Y |
! bgcolor="#BBBB00" | 50% | ! bgcolor="#BBBB00" | 50% | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
| double getBattleFieldLength() | | double getBattleFieldLength() | ||
Line 102: | Line 92: | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
− | ! bgcolor="#555555" | N/A | + | ! bgcolor="#555555" | N/A (*) |
! bgcolor="#00BB00" | 100% | ! bgcolor="#00BB00" | 100% | ||
|- | |- | ||
Line 113: | Line 103: | ||
! bgcolor="#00BB00" | 100% | ! bgcolor="#00BB00" | 100% | ||
|- | |- | ||
− | | | + | | double getDistanceRemaining() |
− | | Returns | + | | Returns the distance remaining from a setAhead/setBack |
! bgcolor="#BB0000" | N | ! bgcolor="#BB0000" | N | ||
! bgcolor="#BB0000" | N | ! bgcolor="#BB0000" | N | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
− | ! bgcolor="#00BB00" | Y | + | ! bgcolor="#00BB00" | Y |
− | ! bgcolor="# | + | ! bgcolor="#00BB00" | 100% |
|- | |- | ||
− | + | | double getTurnRemaining() | |
− | + | | Returns the distance remaining from a setTurnLeft/setTurnRight | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | | double | + | |
− | | Returns the distance remaining from a | + | |
! bgcolor="#BB0000" | N | ! bgcolor="#BB0000" | N | ||
! bgcolor="#BB0000" | N | ! bgcolor="#BB0000" | N | ||
Line 146: | Line 120: | ||
|- | |- | ||
| double getEnergy() | | double getEnergy() | ||
− | | For robocode compatibly - robot's current "energy" (Always | + | | For robocode compatibly - robot's current "energy" (Always 100) |
! bgcolor="#BB0000" | N | ! bgcolor="#BB0000" | N | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
− | ! bgcolor="#00BB00" | Y | + | ! bgcolor="#00BB00" | Y (*) |
! bgcolor="#555555" | N/A | ! bgcolor="#555555" | N/A | ||
|- | |- | ||
Line 158: | Line 132: | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
− | ! bgcolor="#BBBB00" | Y | + | ! bgcolor="#BBBB00" | Y (*) |
! bgcolor="#00BB00" | 100% | ! bgcolor="#00BB00" | 100% | ||
|- | |- | ||
Line 165: | Line 139: | ||
! bgcolor="#BB0000" | N | ! bgcolor="#BB0000" | N | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
Line 182: | Line 148: | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
− | ! bgcolor="#BBBB00" | Y | + | ! bgcolor="#BBBB00" | Y (*) |
! bgcolor="#00BB00" | 100% | ! bgcolor="#00BB00" | 100% | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
| double getHeading() | | double getHeading() | ||
Line 207: | Line 157: | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
! bgcolor="#00BB00" | 100% | ! bgcolor="#00BB00" | 100% | ||
|- | |- | ||
Line 222: | Line 164: | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
− | ! bgcolor="#BB0000" | N | + | ! bgcolor="#BB0000" | N (*) |
! bgcolor="#00BB00" | 100% | ! bgcolor="#00BB00" | 100% | ||
|- | |- | ||
Line 230: | Line 172: | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
− | ! bgcolor="#555555" | N/A | + | ! bgcolor="#555555" | N/A (*) |
! bgcolor="#00BB00" | 100% | ! bgcolor="#00BB00" | 100% | ||
|- | |- | ||
Line 255: | Line 197: | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
− | ! bgcolor="# | + | ! bgcolor="#BB0000" | 0% |
|- | |- | ||
| double getRadarHeading() | | double getRadarHeading() | ||
Line 264: | Line 206: | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
! bgcolor="#00BB00" | 100% | ! bgcolor="#00BB00" | 100% | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
| int getRoundNum() | | int getRoundNum() | ||
Line 304: | Line 214: | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
! bgcolor="#00BB00" | 100% | ! bgcolor="#00BB00" | 100% | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
| double getTime() | | double getTime() | ||
Line 326: | Line 220: | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
− | ! bgcolor="#BBBB00" | Y | + | ! bgcolor="#BBBB00" | Y (*) |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
! bgcolor="#00BB00" | 100% | ! bgcolor="#00BB00" | 100% | ||
|- | |- | ||
Line 358: | Line 236: | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
− | ! bgcolor="#00BB00" | Y | + | ! bgcolor="#00BB00" | Y (*) |
! bgcolor="#00BB00" | 100% | ! bgcolor="#00BB00" | 100% | ||
|- | |- | ||
Line 384: | Line 262: | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
! bgcolor="#00BB00" | 100% | ! bgcolor="#00BB00" | 100% | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
| void resume() | | void resume() | ||
Line 438: | Line 292: | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
− | ! bgcolor="#BBBB00" | Y | + | ! bgcolor="#BBBB00" | Y (*) |
! bgcolor="#555555" | N/A | ! bgcolor="#555555" | N/A | ||
|- | |- | ||
Line 446: | Line 300: | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
− | ! bgcolor="#BBBB00" | Y | + | ! bgcolor="#BBBB00" | Y (*) |
! bgcolor="#555555" | N/A | ! bgcolor="#555555" | N/A | ||
|- | |- | ||
Line 470: | Line 324: | ||
! bgcolor="#BB0000" | N | ! bgcolor="#BB0000" | N | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
− | ! bgcolor="#BBBB00" | Y | + | ! bgcolor="#BBBB00" | Y (*) |
! bgcolor="#00BB00" | 100% | ! bgcolor="#00BB00" | 100% | ||
|- | |- | ||
Line 478: | Line 332: | ||
! bgcolor="#BB0000" | N | ! bgcolor="#BB0000" | N | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
− | ! bgcolor="#BBBB00" | Y | + | ! bgcolor="#BBBB00" | Y (*) |
! bgcolor="#BBBB00" | 50% | ! bgcolor="#BBBB00" | 50% | ||
|- | |- | ||
Line 512: | Line 366: | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
! bgcolor="#00BB00" | 100% | ! bgcolor="#00BB00" | 100% | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
| void void setTurnLeft(double degrees) | | void void setTurnLeft(double degrees) | ||
− | | Sets the robot to turn left by '' | + | | Sets the robot to turn left by ''degress'' at the next execute() |
! bgcolor="#BB0000" | N | ! bgcolor="#BB0000" | N | ||
! bgcolor="#BB0000" | N | ! bgcolor="#BB0000" | N | ||
Line 553: | Line 375: | ||
! bgcolor="#00BB00" | 100% | ! bgcolor="#00BB00" | 100% | ||
|- | |- | ||
− | | void void | + | | void void setTurnRate(double turnRate) |
− | | Sets the | + | | Sets the maximum turn rate for the robot at the next execute() |
! bgcolor="#BB0000" | N | ! bgcolor="#BB0000" | N | ||
! bgcolor="#BB0000" | N | ! bgcolor="#BB0000" | N | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
− | ! bgcolor="#00BB00" | Y | + | ! bgcolor="#00BB00" | Y (*) |
! bgcolor="#00BB00" | 100% | ! bgcolor="#00BB00" | 100% | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
| void void setTurnRight(double degrees) | | void void setTurnRight(double degrees) | ||
− | | Sets the robot to turn right by '' | + | | Sets the robot to turn right by ''degress'' at the next execute() |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
! bgcolor="#BB0000" | N | ! bgcolor="#BB0000" | N | ||
! bgcolor="#BB0000" | N | ! bgcolor="#BB0000" | N | ||
Line 637: | Line 419: | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
Line 661: | Line 435: | ||
! bgcolor="#BB0000" | N | ! bgcolor="#BB0000" | N | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
! bgcolor="#BBBB00" | Y | ! bgcolor="#BBBB00" | Y | ||
Line 693: | Line 443: | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
Line 720: | Line 462: | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
− | ! bgcolor="# | + | ! bgcolor="#BB0000" | N |
− | ! bgcolor="#BB0000" | | + | ! bgcolor="#BB0000" | 0% |
|- | |- | ||
| void onBulletFired(BulletFiredEvent e) | | void onBulletFired(BulletFiredEvent e) | ||
Line 728: | Line 470: | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
− | ! bgcolor="# | + | ! bgcolor="#BB0000" | N |
− | ! bgcolor="#BB0000" | | + | ! bgcolor="#BB0000" | 0% |
|- | |- | ||
| void onBulletHit(BulletHitEvent e) | | void onBulletHit(BulletHitEvent e) | ||
Line 752: | Line 494: | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
− | ! bgcolor="# | + | ! bgcolor="#BB0000" | N |
− | ! bgcolor="#BB0000" | | + | ! bgcolor="#BB0000" | 0% |
|- | |- | ||
| void onDeath(DeathEvent e) | | void onDeath(DeathEvent e) | ||
Line 768: | Line 510: | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
− | ! bgcolor="# | + | ! bgcolor="#BBBB00" | Y |
− | ! bgcolor="#BB0000" | | + | ! bgcolor="#BB0000" | 0% |
|- | |- | ||
| void onHitRobot(HitRobotEvente) | | void onHitRobot(HitRobotEvente) | ||
Line 800: | Line 542: | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
− | ! bgcolor="# | + | ! bgcolor="#BBBB00" | Y (*) |
− | ! bgcolor="# | + | ! bgcolor="#22BB00" | 90% |
|- | |- | ||
| void onSpawn(SpawnEvent e) | | void onSpawn(SpawnEvent e) | ||
Line 808: | Line 550: | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
− | ! bgcolor="# | + | ! bgcolor="#BB0000" | N |
! bgcolor="#00BB00" | 100% | ! bgcolor="#00BB00" | 100% | ||
|- | |- | ||
Line 816: | Line 558: | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
− | ! bgcolor="# | + | ! bgcolor="#BB0000" | N |
− | ! bgcolor="# | + | ! bgcolor="#BB3300" | 20% |
|- | |- | ||
| void onWin(WinEvent e) | | void onWin(WinEvent e) | ||
Line 824: | Line 566: | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
! bgcolor="#00BB00" | Y | ! bgcolor="#00BB00" | Y | ||
− | ! bgcolor="# | + | ! bgcolor="#BB0000" | N |
− | ! bgcolor="#BB0000" | | + | ! bgcolor="#BB0000" | 0% |
|- | |- | ||
|} | |} | ||
Line 831: | Line 573: | ||
=See Also= | =See Also= | ||
− | + | [[BZRobots/Ideas]] - Ideas for a possible future release | |
− | + |