This wiki is archived and useful information is being migrated to the main bzflag.org website

Editing BZRobots/API

Jump to: navigation, search

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:
  
  
−
If you are new to BZRobots, but have Robocode experience, you may want to take a look at [[BZRobots/API_BZRobots_vs_Robocode]]
+
'''Note:''' ''As BZRobots currently supports bot scripts written in three different languages, the following is a C-style, but language independent description of the methods available for bot development.''
−
 
+
−
 
+
−
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''
+
  
 
{| cellpadding=4 {{Prettytable}}
 
{| cellpadding=4 {{Prettytable}}
 
|-
 
|-
−
! colspan=7 {{Hl3}} | ==Robot/AdvancedRobot Methods==  
+
! colspan=7 {{Hl3}} |==BZRobot Methods==  
 
|-
 
|-
 
| {{Hl3}} |'''Method'''  
 
| {{Hl3}} |'''Method'''  
Line 49: Line 43:
 
! bgcolor="#00BB00" | 100%  
 
! bgcolor="#00BB00" | 100%  
 
|-
 
|-
−
| void clearAllEvents()  
+
| void doNothing()
−
| Clears the event queue; any events will be disgarded
+
| Does nothing (equivalent of a short sleep)
−
! bgcolor="#BB0000" | N
+
−
! bgcolor="#BB0000" | N
+
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | 100%
 
−
|-
 
−
| void doNothing()
 
−
| Clears the event queue; any events will be disgarded
 
−
! bgcolor="#BB0000" | Y
 
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
Line 65: Line 51:
 
! bgcolor="#00BB00" | 100%  
 
! bgcolor="#00BB00" | 100%  
 
|-
 
|-
−
| void execute()  
+
| void fire()
−
| Causes any action queued by setAhead, setTurnRight, etc. to take place, ending the "turn"
+
| Fires a single shot
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | 100%
 
−
|-
 
−
| void fire(double power)
 
−
| Fires a single shot
 
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
−
! bgcolor="#BBBB00" | Y
 
 
! bgcolor="#00BB00" | 100%  
 
! bgcolor="#00BB00" | 100%  
−
|-
 
−
| Bullet *fireBullet(double power)
 
−
| Fires a single shot, returning a reference to the fired shot
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#BBBB00" | Y
 
−
! bgcolor="#BBBB00" | 50%
 
−
|-
 
−
| list<Event> getAllEvents()
 
−
| Returns a list of all events currently in the queue
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#BB0000" | 5%
 
 
|-
 
|-
 
| double getBattleFieldLength()
 
| double getBattleFieldLength()
Line 102: Line 64:
 
! 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 112: Line 74:
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | 100%  
 
! bgcolor="#00BB00" | 100%  
−
|-
 
−
| list<Event> getBulletHitBulletEvents()
 
−
| Returns a list of BulletHitBulletEvent currently in the queue
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#BB0000" | 5%
 
−
|-
 
−
| list<Event> getBulletHitEvents()
 
−
| Returns a list of BulletHitEvent currently in the queue
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#BB0000" | 5%
 
−
|-
 
−
| list<Event> getBulletMissedEvents()
 
−
| Returns a list of all BulletMissedEvent currently in the queue
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#BB0000" | 5%
 
−
|-
 
−
| double getDistanceRemaining()
 
−
| Returns the distance remaining from a setAhead/setBack
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | 100%
 
−
|-
 
−
| double getEnergy()
 
−
| For robocode compatibly - robot's current "energy" (Always 16)
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#555555" | N/A
 
 
|-
 
|-
 
| double getGunCoolingRate()
 
| double getGunCoolingRate()
Line 158: Line 80:
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
−
! bgcolor="#BBBB00" | Y
+
! bgcolor="#BBBB00" | Y (*)
−
! bgcolor="#00BB00" | 100%  
+
! bgcolor="#BB0000" | 100%  
 
|-
 
|-
 
| double getGunHeading()
 
| double getGunHeading()
−
| For robocode compatibly - robot's gun heading (Always matches robot heading)
+
| Returns the heading of the gun (Will always be the same as the robot's heading)  
 
! 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="#00BB00" | 100%
+
! bgcolor="#BB0000" | 100%  
−
|-
+
−
| double getGunHeadingRadians()
+
−
| For robocode compatibly - robot's gun heading (Always matches robot heading)
+
−
! bgcolor="#BB0000" | N
+
−
! bgcolor="#BB0000" | N
+
−
! bgcolor="#00BB00" | Y
+
−
! bgcolor="#00BB00" | Y
+
−
! bgcolor="#00BB00" | 100%  
+
 
|-
 
|-
 
| double getGunHeat()
 
| double getGunHeat()
Line 182: Line 96:
 
! 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 getGunTurnRemaining()
 
−
| For robocode compatibly - (Always returns 0)
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#555555" | N/A
 
−
|-
 
−
| double getGunTurnRemainingRadians()
 
−
| For robocode compatibly - (Always returns 0)
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#555555" | N/A
 
 
|-
 
|-
 
| double getHeading()
 
| double getHeading()
Line 207: Line 105:
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
−
! bgcolor="#00BB00" | 100%
 
−
|-
 
−
| double getHeadingRadians()
 
−
| Returns the current heading of the robot in radians
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
 
! bgcolor="#00BB00" | 100%  
 
! bgcolor="#00BB00" | 100%  
 
|-
 
|-
Line 222: Line 112:
 
! 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 120:
 
! 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 240: Line 130:
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | 100%  
 
! bgcolor="#00BB00" | 100%  
−
|-
 
−
| int getNumRounds()
 
−
| For robocode compatibly - number of battle rounds (Always '''1''')
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | 100%
 
−
|-
 
−
| int getOthers()
 
−
| Returns the number of other robots/tanks currently in the battle
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | 100%
 
−
|-
 
−
| double getRadarHeading()
 
−
| For robocode compatibly - robot's radar heading (Always matches robot heading)
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | 100%
 
−
|-
 
−
| double getRadarHeadingRadians()
 
−
| For robocode compatibly - robot's radar heading (Always matches robot heading)
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | 100%
 
−
|-
 
−
| double getRadarTurnRemaining()
 
−
| For robocode compatibly - (Always returns 0)
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#555555" | N/A
 
−
|-
 
−
| double getRadarTurnRemainingRadians()
 
−
| For robocode compatibly - (Always returns 0)
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#555555" | N/A
 
−
|-
 
−
| list<Event> getRobotDeathEvents()
 
−
| Returns a list of all RobotDeathEvent currently in the queue
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#BB0000" | 5%
 
−
|-
 
−
| int getRoundNum()
 
−
| For robocode compatibly - current battle round (Always '''1''')
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | 100%
 
−
|-
 
−
| list<Event> getScannedRobotEvents()
 
−
| Returns a list of all ScannedRobotEvent currently in the queue
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#BB0000" | 5%
 
−
|-
 
−
| list<Event> getStatusEvents()
 
−
| Returns a list of all StatusEvent currently in the queue
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#BB0000" | 5%
 
 
|-
 
|-
 
| double getTime()
 
| double getTime()
Line 326: Line 136:
 
! 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 getTurnRemaining()
+
| double getWidth()
−
| Returns the distance remaining from a setTurnLeft/setTurnRight
+
| Returns the width (X-size) of the robot
−
! bgcolor="#BB0000" | N
+
 
! bgcolor="#BB0000" | N  
 
! bgcolor="#BB0000" | N  
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | 100%
 
−
|-
 
−
| double getTurnRemainingRadians()
 
−
| Returns the distance remaining from a setTurnLeft/setTurnRight in radians
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#BB0000" | N
 
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
−
! bgcolor="#00BB00" | Y
+
! bgcolor="#00BB00" | Y (*)
 
! bgcolor="#00BB00" | 100%  
 
! bgcolor="#00BB00" | 100%  
 
|-
 
|-
 
| double getVelocity()
 
| double getVelocity()
 
| Returns the speed of the robot (excluding the Z-speed)
 
| Returns the speed of the robot (excluding the Z-speed)
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | 100%
 
−
|-
 
−
| double getWidth()
 
−
| Returns the width (X-size) of the robot
 
 
! bgcolor="#BB0000" | N  
 
! bgcolor="#BB0000" | N  
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
Line 384: Line 178:
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | 100%  
 
! bgcolor="#00BB00" | 100%  
−
|-
 
−
| bool isAdjustGunForRobotTurn
 
−
| For robocode compatibility - always true
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#555555" | N/A
 
−
|-
 
−
| bool isAdjustRadarForGunTurn
 
−
| For robocode compatibility - always true
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#555555" | N/A
 
−
|-
 
−
| bool isAdjustRadarForRobotTurn
 
−
| For robocode compatibility - always true
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#555555" | N/A
 
 
|-
 
|-
 
| void resume()
 
| void resume()
Line 423: Line 193:
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
−
! bgcolor="#00BB00" | 100%
 
−
|-
 
−
| void setAdjustGunForRobotTurn(bool independent)
 
−
| For robocode compatibly - but has no effect when false
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#BBBB00" | Y
 
−
! bgcolor="#555555" | N/A
 
−
|-
 
−
| void setAdjustRadarForGunTurn(bool independent)
 
−
| For robocode compatibly - but has no effect when false
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#BBBB00" | Y
 
−
! bgcolor="#555555" | N/A
 
−
|-
 
−
| void setAdjustRadarForRobotTurn(bool independent)
 
−
| For robocode compatibly - but has no effect when false
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#BBBB00" | Y
 
−
! bgcolor="#555555" | N/A
 
−
|-
 
−
| void setAhead(double distance)
 
−
| Specifies that the robot should move forward by ''distance'' at the next execute()
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | 100%
 
−
|-
 
−
| void setBack(double distance)
 
−
| Specifies that the robot should move backwad by ''distance'' at the next execute()
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | 100%
 
−
|-
 
−
| void setFire(double power)
 
−
| Specifies that the robot should fire a bullet of ''power'' at the next execute()
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#BBBB00" | Y
 
−
! bgcolor="#00BB00" | 100%
 
−
|-
 
−
| Bullet *setFireBullet(double power)
 
−
| Specifies that the robot should fire a bullet of ''power'' at the next execute()
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#BBBB00" | Y
 
−
! bgcolor="#BBBB00" | 50%
 
−
|-
 
−
| void setMaxTurnRate(double maxTurnRate)
 
−
| Sets a limit on the maximum turn rate of the robot at the next execute()
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | 100%
 
−
|-
 
−
| void setMaxVelocity(double maxVelocity)
 
−
| Sets a limit on the maximum speed of the robot at the next execute()
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | 100%
 
−
|-
 
−
| void setResume()
 
−
| Immediately resumes any motion halted by setStop
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | 100%
 
−
|-
 
−
| void setStop(bool overwrite = false)
 
−
| Immediately stops any motion until resumed by setResume
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | 100%
 
−
|-
 
−
| void void setTurnGunLeft(double degrees)
 
−
| For robocode compatablity - has no effect
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#BBBB00" | Y
 
−
! bgcolor="#555555" | N/A
 
−
|-
 
−
| void void setTurnGunLeftRadians(double radians)
 
−
| For robocode compatablity - has no effect
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#BBBB00" | Y
 
−
! bgcolor="#555555" | N/A
 
−
|-
 
−
| void void setTurnGunRight(double degrees)
 
−
| For robocode compatablity - has no effect
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#BBBB00" | Y
 
−
! bgcolor="#555555" | N/A
 
−
|-
 
−
| void void setTurnGunRightRadians(double radians)
 
−
| For robocode compatablity - has no effect
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#BBBB00" | Y
 
−
! bgcolor="#555555" | N/A
 
−
|-
 
−
| void void setTurnLeft(double degrees)
 
−
| Sets the robot to turn left by ''degrees'' at the next execute()
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | 100%
 
−
|-
 
−
| void void setTurnLeftRadians(double radians)
 
−
| Sets the robot to turn left by ''radians'' at the next execute()
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | 100%
 
−
|-
 
−
| void void setTurnRadarLeft(double degrees)
 
−
| For robocode compatibility - has no effect
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#BBBB00" | Y
 
−
! bgcolor="#555555" | N/A
 
−
|-
 
−
| void void setTurnRadarLeftRadians(double radians)
 
−
| For robocode compatibility - has no effect
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#BBBB00" | Y
 
−
! bgcolor="#555555" | N/A
 
−
|-
 
−
| void void setTurnRadarRight(double degrees)
 
−
| For robocode compatibility - has no effect
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#BBBB00" | Y
 
−
! bgcolor="#555555" | N/A
 
−
|-
 
−
| void void setTurnRadarRightRadians(double radians)
 
−
| For robocode compatibility - has no effect
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#BBBB00" | Y
 
−
! bgcolor="#555555" | N/A
 
−
|-
 
−
| void void setTurnRight(double degrees)
 
−
| Sets the robot to turn right by ''degrees'' at the next execute()
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | 100%
 
−
|-
 
−
| void void setTurnRightRadians(double radians)
 
−
| Sets the robot to turn right by ''radians'' at the next execute()
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
 
! bgcolor="#00BB00" | 100%  
 
! bgcolor="#00BB00" | 100%  
 
|-
 
|-
Line 616: Line 202:
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | 100%  
 
! bgcolor="#00BB00" | 100%  
−
|-
 
−
| void turnGunRight(double degrees)
 
−
| For robocode compatibly - but has no effect
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#BBBB00" | Y
 
−
! bgcolor="#555555" | N/A
 
−
|-
 
−
| void turnGunLeft(double degrees)
 
−
| For robocode compatibly - but has no effect
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#BBBB00" | Y
 
−
! bgcolor="#555555" | N/A
 
 
|-
 
|-
 
| void turnLeft(double degrees)
 
| void turnLeft(double degrees)
Line 640: Line 210:
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | 100%  
 
! bgcolor="#00BB00" | 100%  
−
|-
 
−
| void turnLeftRadians(double radians)
 
−
| Turns the robot left ''radians'' radians
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | 100%
 
−
|-
 
−
| void turnRadarRight(double degrees)
 
−
| For robocode compatibly - but has no effect
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#BBBB00" | Y
 
−
! bgcolor="#555555" | N/A
 
−
|-
 
−
| void turnRadarLeft(double degrees)
 
−
| For robocode compatibly - but has no effect
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#BBBB00" | Y
 
−
! bgcolor="#555555" | N/A
 
−
|-
 
−
| void turnRadarLeftRadians(double radians)
 
−
| For robocode compatibly - but has no effect
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#BBBB00" | Y
 
−
! bgcolor="#555555" | N/A
 
−
|-
 
−
| void turnRadarRight(double degrees)
 
−
| For robocode compatibly - but has no effect
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#BBBB00" | Y
 
−
! bgcolor="#555555" | N/A
 
−
|-
 
−
| void turnRadarRightRadians(double radians)
 
−
| For robocode compatibly - but has no effect
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#BBBB00" | Y
 
−
! bgcolor="#555555" | N/A
 
 
|-
 
|-
 
| void turnRight(double degrees)
 
| void turnRight(double degrees)
Line 696: Line 218:
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | 100%  
 
! bgcolor="#00BB00" | 100%  
−
|-
 
−
| void turnRightRadians(double radians)
 
−
| Turns the robot right ''radians'' radians
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#BB0000" | N
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | Y
 
−
! bgcolor="#00BB00" | 100%
 
−
|-
 
−
! colspan=7 {{Hl3}} | ==Robot/AdvancedRobot Event Handlers==
 
 
|-
 
|-
 
| {{Hl3}} |'''Method'''  
 
| {{Hl3}} |'''Method'''  
Line 720: Line 232:
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
−
! bgcolor="#00BB00" | Y
+
! bgcolor="#BB0000" | N  
−
! bgcolor="#BB0000" | 10%
+
! bgcolor="#BB0000" | 0%  
−
|-
+
−
| void onBulletFired(BulletFiredEvent e)
+
−
| Called when another robot/tank fires a bullet
+
−
! bgcolor="#555555" | N/A
+
−
! bgcolor="#00BB00" | Y
+
−
! bgcolor="#00BB00" | Y
+
−
! bgcolor="#555555" | N/A
+
−
! bgcolor="#BB0000" | 10%  
+
 
|-
 
|-
 
| void onBulletHit(BulletHitEvent e)
 
| void onBulletHit(BulletHitEvent e)
Line 736: Line 240:
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
−
! bgcolor="#00BB00" | Y
+
! bgcolor="#BB0000" | N
−
! bgcolor="#BBBB00" | 80%  
+
! bgcolor="#BB0000" | 0%  
−
|-
+
−
| void onBulletHitBullet(BulletHitBulletEvente)
+
−
| For robocode compatibility - will never take place
+
−
! bgcolor="#555555" | N/A
+
−
! bgcolor="#00BB00" | Y
+
−
! bgcolor="#00BB00" | Y
+
−
! bgcolor="#00BB00" | Y
+
−
! bgcolor="#555555" | N/A
+
 
|-
 
|-
 
| void onBulletMissed(BulletMissedEvent e)
 
| void onBulletMissed(BulletMissedEvent e)
Line 752: Line 248:
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
−
! bgcolor="#00BB00" | Y
+
! bgcolor="#BB0000" | N
−
! bgcolor="#BB0000" | 10%  
+
! bgcolor="#BB0000" | 0%  
 
|-
 
|-
 
| void onDeath(DeathEvent e)
 
| void onDeath(DeathEvent e)
Line 768: Line 264:
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
−
! bgcolor="#00BB00" | Y  
+
! bgcolor="#BB0000" | Y  
−
! bgcolor="#BB0000" | 25%  
+
! bgcolor="#BB0000" | 0%  
−
|-
+
−
| void onHitRobot(HitRobotEvente)
+
−
| For robocode compatibility - will never be called
+
−
! bgcolor="#555555" | N/A
+
−
! bgcolor="#00BB00" | Y
+
−
! bgcolor="#00BB00" | Y
+
−
! bgcolor="#00BB00" | Y
+
−
! bgcolor="#555555" | N/A
+
 
|-
 
|-
 
| void onHitWall(HitWallEvent e)
 
| void onHitWall(HitWallEvent e)
Line 792: Line 280:
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
−
! bgcolor="#00BB00" | Y
+
! bgcolor="#BB0000" | N
−
! bgcolor="#00BB00" | 100%  
+
! bgcolor="#BB0000" | 0%  
 
|-
 
|-
 
| void onScannedRobot(ScannedRobotEvent e)
 
| void onScannedRobot(ScannedRobotEvent e)
Line 800: Line 288:
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
−
! bgcolor="#00BB00" | Y
+
! bgcolor="#BBBB00" | Y (*)
−
! bgcolor="#00BB00" | 100%  
+
! bgcolor="#22BB00" | 90%  
 
|-
 
|-
 
| void onSpawn(SpawnEvent e)
 
| void onSpawn(SpawnEvent e)
Line 808: Line 296:
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
−
! bgcolor="#555555" | N/A
+
! bgcolor="#00BB00" | Y
−
! bgcolor="#00BB00" | 100%
+
! bgcolor="#00BB00" | Y
 
|-
 
|-
 
| void onStatus(StatusEvent e)
 
| void onStatus(StatusEvent e)
Line 816: Line 304:
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
−
! bgcolor="#00BB00" | Y
+
! bgcolor="#BB0000" | N
−
! bgcolor="#00BB00" | 95%  
+
! bgcolor="#BB3300" | 20%  
 
|-
 
|-
 
| void onWin(WinEvent e)
 
| void onWin(WinEvent e)
Line 824: Line 312:
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
 
! bgcolor="#00BB00" | Y  
−
! bgcolor="#BBBB00" | Y
+
! bgcolor="#BB0000" | N
−
! bgcolor="#BB0000" | 10%  
+
! bgcolor="#BB0000" | 0%  
 
|-
 
|-
 
|}
 
|}
Line 831: Line 319:
 
=See Also=
 
=See Also=
  
−
* [[BZRobots/API_BZRobots_vs_Robocode]] - Differences between Robocode and BZRobots
+
[[BZRobots/Ideas]] - Ideas for a possible future release
−
* [[BZRobots/Ideas]] - Ideas for a possible future release
+

Please note that all contributions to BZFlagWiki may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see BZFlagWiki:Copyrights for details). Do not submit copyrighted work without permission!

To edit this page, please answer the question that appears below (more info):

Cancel | Editing help (opens in new window)

Templates used on this page:

Retrieved from "https://wiki.bzflag.org/BZRobots/API"