Class AdvancedRobot
- All Implemented Interfaces:
Runnable,IAdvancedEvents,IAdvancedRobot,IBasicEvents,IBasicEvents2,IBasicEvents3,IBasicRobot,IInteractiveEvents,IInteractiveRobot,IPaintEvents,IPaintRobot
- Direct Known Subclasses:
TeamRobot
If you have not already, you should create a Robot first.
- Author:
- Mathew A. Nelson (original), Flemming N. Larsen (contributor), Robert D. Maupin (contributor), Pavel Savara (contributor)
- See Also:
-
Field Summary
Fields inherited from class robocode._RobotBase
out -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddCustomEvent(Condition condition) Registers a custom event to be called when a condition is met.voidClears out any pending events in the robot's event queue immediately.voidexecute()Executes any pending actions, or continues executing actions that are in process.final IAdvancedEventsDo not call this method!Returns a vector containing all events currently in the robot's queue.Returns a vector containing all BulletHitBulletEvents currently in the robot's queue.Returns a vector containing all BulletHitEvents currently in the robot's queue.Returns a vector containing all BulletMissedEvents currently in the robot's queue.Returns a file representing a data directory for the robot, which can be written to usingRobocodeFileOutputStreamorRobocodeFileWriter.getDataFile(String filename) Returns a file in your data directory that you can write to usingRobocodeFileOutputStreamorRobocodeFileWriter.longReturns the data quota available in your data directory, i.e.doubleReturns the distance remaining in the robot's current move measured in pixels.intgetEventPriority(String eventClass) Returns the current priority of a class of events.doubleReturns the direction that the robot's gun is facing, in radians.doubleReturns the angle remaining in the gun's turn, in degrees.doubleReturns the angle remaining in the gun's turn, in radians.doubleReturns the direction that the robot's body is facing, in radians.Returns a vector containing all HitByBulletEvents currently in the robot's queue.Returns a vector containing all HitRobotEvents currently in the robot's queue.Returns a vector containing all HitWallEvents currently in the robot's queue.doubleReturns the direction that the robot's radar is facing, in radians.doubleReturns the angle remaining in the radar's turn, in degrees.doubleReturns the angle remaining in the radar's turn, in radians.Returns a vector containing all RobotDeathEvents currently in the robot's queue.Returns a vector containing all ScannedRobotEvents currently in the robot's queue.Returns a vector containing all StatusEvents currently in the robot's queue.doubleReturns the angle remaining in the robots's turn, in degrees.doubleReturns the angle remaining in the robot's turn, in radians.booleanChecks if the gun is set to adjust for the robot turning, i.e.booleanChecks if the radar is set to adjust for the gun turning, i.e.booleanChecks if the radar is set to adjust for the robot turning, i.e.voidonCustomEvent(CustomEvent event) This method is called when a custom condition is met.voidonDeath(DeathEvent event) This method is called if your robot dies.voidonSkippedTurn(SkippedTurnEvent event) This method is called if the robot is using too much time between actions.voidremoveCustomEvent(Condition condition) Removes a custom event that was previously added by callingaddCustomEvent(Condition).voidsetAhead(double distance) Sets the robot to move ahead (forward) by distance measured in pixels when the next execution takes place.voidsetBack(double distance) Sets the robot to move back by distance measured in pixels when the next execution takes place.voidsetEventPriority(String eventClass, int priority) Sets the priority of a class of events.voidsetFire(double power) Sets the gun to fire a bullet when the next execution takes place.setFireBullet(double power) Sets the gun to fire a bullet when the next execution takes place.voidsetInterruptible(boolean interruptible) Call this during an event handler to allow new events of the same priority to restart the event handler.voidsetMaxTurnRate(double newMaxTurnRate) Sets the maximum turn rate of the robot measured in degrees if the robot should turn slower thanRules.MAX_TURN_RATE(10 degress/turn).voidsetMaxVelocity(double newMaxVelocity) Sets the maximum velocity of the robot measured in pixels/turn if the robot should move slower thanRules.MAX_VELOCITY(8 pixels/turn).voidvoidsetStop()voidsetStop(boolean overwrite) This call is identical tostop(boolean), but returns immediately, and will not execute until you callexecute()or take an action that executes.voidsetTurnGunLeft(double degrees) Sets the robot's gun to turn left by degrees when the next execution takes place.voidsetTurnGunLeftRadians(double radians) Sets the robot's gun to turn left by radians when the next execution takes place.voidsetTurnGunRight(double degrees) Sets the robot's gun to turn right by degrees when the next execution takes place.voidsetTurnGunRightRadians(double radians) Sets the robot's gun to turn right by radians when the next execution takes place.voidsetTurnLeft(double degrees) Sets the robot's body to turn left by degrees when the next execution takes place.voidsetTurnLeftRadians(double radians) Sets the robot's body to turn left by radians when the next execution takes place.voidsetTurnRadarLeft(double degrees) Sets the robot's radar to turn left by degrees when the next execution takes place.voidsetTurnRadarLeftRadians(double radians) Sets the robot's radar to turn left by radians when the next execution takes place.voidsetTurnRadarRight(double degrees) Sets the robot's radar to turn right by degrees when the next execution takes place.voidsetTurnRadarRightRadians(double radians) Sets the robot's radar to turn right by radians when the next execution takes place.voidsetTurnRight(double degrees) Sets the robot's body to turn right by degrees when the next execution takes place.voidsetTurnRightRadians(double radians) Sets the robot's body to turn right by radians when the next execution takes place.voidturnGunLeftRadians(double radians) Immediately turns the robot's gun to the left by radians.voidturnGunRightRadians(double radians) Immediately turns the robot's gun to the right by radians.voidturnLeftRadians(double radians) Immediately turns the robot's body to the left by radians.voidturnRadarLeftRadians(double radians) Immediately turns the robot's radar to the left by radians.voidturnRadarRightRadians(double radians) Immediately turns the robot's radar to the right by radians.voidturnRightRadians(double radians) Immediately turns the robot's body to the right by radians.voidDoes not return until a condition is met, i.e.Methods inherited from class robocode._AdvancedRobot
endTurn, getGunHeadingDegrees, getHeadingDegrees, getMaxWaitCount, getRadarHeadingDegrees, getWaitCount, setTurnGunLeftDegrees, setTurnGunRightDegrees, setTurnLeftDegrees, setTurnRadarLeftDegrees, setTurnRadarRightDegrees, setTurnRightDegrees, turnGunLeftDegrees, turnGunRightDegrees, turnLeftDegrees, turnRadarLeftDegrees, turnRadarRightDegrees, turnRightDegreesMethods inherited from class robocode.Robot
ahead, back, doNothing, fire, fireBullet, getBasicEventListener, getBattleFieldHeight, getBattleFieldWidth, getEnergy, getGraphics, getGunCoolingRate, getGunHeading, getGunHeat, getHeading, getHeight, getInteractiveEventListener, getName, getNumRounds, getNumSentries, getOthers, getPaintEventListener, getRadarHeading, getRobotRunnable, getRoundNum, getSentryBorderSize, getTime, getVelocity, getWidth, getX, getY, onBattleEnded, onBulletHit, onBulletHitBullet, onBulletMissed, onHitByBullet, onHitRobot, onHitWall, onKeyPressed, onKeyReleased, onKeyTyped, onMouseClicked, onMouseDragged, onMouseEntered, onMouseExited, onMouseMoved, onMousePressed, onMouseReleased, onMouseWheelMoved, onPaint, onRobotDeath, onRoundEnded, onScannedRobot, onStatus, onWin, resume, run, scan, setAdjustGunForRobotTurn, setAdjustRadarForGunTurn, setAdjustRadarForRobotTurn, setAllColors, setBodyColor, setBulletColor, setColors, setColors, setDebugProperty, setGunColor, setRadarColor, setScanColor, stop, stop, turnGunLeft, turnGunRight, turnLeft, turnRadarLeft, turnRadarRight, turnRightMethods inherited from class robocode._Robot
getBattleNum, getGunCharge, getGunImageName, getLife, getNumBattles, getRadarImageName, getRobotImageName, setGunImageName, setRadarImageName, setRobotImageNameMethods inherited from class robocode._RobotBase
finalize, setOut, setPeerMethods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface robocode.robotinterfaces.IBasicRobot
getBasicEventListener, getRobotRunnable, setOut, setPeer
-
Constructor Details
-
AdvancedRobot
public AdvancedRobot()
-
-
Method Details
-
getDistanceRemaining
public double getDistanceRemaining()Returns the distance remaining in the robot's current move measured in pixels.This call returns both positive and negative values. Positive values means that the robot is currently moving forwards. Negative values means that the robot is currently moving backwards. If the returned value is 0, the robot currently stands still.
- Returns:
- the distance remaining in the robot's current move measured in pixels.
- See Also:
-
getTurnRemaining
public double getTurnRemaining()Returns the angle remaining in the robots's turn, in degrees.This call returns both positive and negative values. Positive values means that the robot is currently turning to the right. Negative values means that the robot is currently turning to the left. If the returned value is 0, the robot is currently not turning.
- Returns:
- the angle remaining in the robots's turn, in degrees
- See Also:
-
getGunTurnRemaining
public double getGunTurnRemaining()Returns the angle remaining in the gun's turn, in degrees.This call returns both positive and negative values. Positive values means that the gun is currently turning to the right. Negative values means that the gun is currently turning to the left. If the returned value is 0, the gun is currently not turning.
- Returns:
- the angle remaining in the gun's turn, in degrees
- See Also:
-
getRadarTurnRemaining
public double getRadarTurnRemaining()Returns the angle remaining in the radar's turn, in degrees.This call returns both positive and negative values. Positive values means that the radar is currently turning to the right. Negative values means that the radar is currently turning to the left. If the returned value is 0, the radar is currently not turning.
- Returns:
- the angle remaining in the radar's turn, in degrees
- See Also:
-
setAhead
public void setAhead(double distance) Sets the robot to move ahead (forward) by distance measured in pixels when the next execution takes place.This call returns immediately, and will not execute until you call
execute()or take an action that executes.Note that both positive and negative values can be given as input, where positive values means that the robot is set to move ahead, and negative values means that the robot is set to move back. If 0 is given as input, the robot will stop its movement, but will have to decelerate till it stands still, and will thus not be able to stop its movement immediately, but eventually.
Example:
// Set the robot to move 50 pixels ahead setAhead(50); // Set the robot to move 100 pixels back // (overrides the previous order) setAhead(-100); ... // Executes the last setAhead() execute();
- Parameters:
distance- the distance to move measured in pixels. Ifdistance> 0 the robot is set to move ahead. Ifdistanceinvalid input: '<' 0 the robot is set to move back. Ifdistance= 0 the robot is set to stop its movement.- See Also:
-
setBack
public void setBack(double distance) Sets the robot to move back by distance measured in pixels when the next execution takes place.This call returns immediately, and will not execute until you call
execute()or take an action that executes.Note that both positive and negative values can be given as input, where positive values means that the robot is set to move back, and negative values means that the robot is set to move ahead. If 0 is given as input, the robot will stop its movement, but will have to decelerate till it stands still, and will thus not be able to stop its movement immediately, but eventually.
Example:
// Set the robot to move 50 pixels back setBack(50); // Set the robot to move 100 pixels ahead // (overrides the previous order) setBack(-100); ... // Executes the last setBack() execute();
- Parameters:
distance- the distance to move measured in pixels. Ifdistance> 0 the robot is set to move back. Ifdistanceinvalid input: '<' 0 the robot is set to move ahead. Ifdistance= 0 the robot is set to stop its movement.- See Also:
-
setTurnLeft
public void setTurnLeft(double degrees) Sets the robot's body to turn left by degrees when the next execution takes place.This call returns immediately, and will not execute until you call execute() or take an action that executes.
Note that both positive and negative values can be given as input, where negative values means that the robot's body is set to turn right instead of left.
Example:
// Set the robot to turn 180 degrees to the left setTurnLeft(180); // Set the robot to turn 90 degrees to the right instead of left // (overrides the previous order) setTurnLeft(-90); ... // Executes the last setTurnLeft() execute();
- Parameters:
degrees- the amount of degrees to turn the robot's body to the left. Ifdegrees> 0 the robot is set to turn left. Ifdegreesinvalid input: '<' 0 the robot is set to turn right. Ifdegrees= 0 the robot is set to stop turning.- See Also:
-
setTurnRight
public void setTurnRight(double degrees) Sets the robot's body to turn right by degrees when the next execution takes place.This call returns immediately, and will not execute until you call execute() or take an action that executes.
Note that both positive and negative values can be given as input, where negative values means that the robot's body is set to turn left instead of right.
Example:
// Set the robot to turn 180 degrees to the right setTurnRight(180); // Set the robot to turn 90 degrees to the left instead of right // (overrides the previous order) setTurnRight(-90); ... // Executes the last setTurnRight() execute();
- Parameters:
degrees- the amount of degrees to turn the robot's body to the right. Ifdegrees> 0 the robot is set to turn right. Ifdegreesinvalid input: '<' 0 the robot is set to turn left. Ifdegrees= 0 the robot is set to stop turning.- See Also:
-
setFire
public void setFire(double power) Sets the gun to fire a bullet when the next execution takes place. The bullet will travel in the direction the gun is pointing.This call returns immediately, and will not execute until you call execute() or take an action that executes.
The specified bullet power is an amount of energy that will be taken from the robot's energy. Hence, the more power you want to spend on the bullet, the more energy is taken from your robot.
The bullet will do (4 * power) damage if it hits another robot. If power is greater than 1, it will do an additional 2 * (power - 1) damage. You will get (3 * power) back if you hit the other robot. You can call Rules#getBulletDamage(double)} for getting the damage that a bullet with a specific bullet power will do.
The specified bullet power should be between
Rules.MIN_BULLET_POWERandRules.MAX_BULLET_POWER.Note that the gun cannot fire if the gun is overheated, meaning that
Robot.getGunHeat()returns a value > 0.An event is generated when the bullet hits a robot, wall, or another bullet.
Example:
// Fire a bullet with maximum power if the gun is ready if (getGunHeat() == 0) { setFire(Rules.MAX_BULLET_POWER); } ... execute();- Parameters:
power- the amount of energy given to the bullet, and subtracted from the robot's energy.- See Also:
-
setFireBullet
Sets the gun to fire a bullet when the next execution takes place. The bullet will travel in the direction the gun is pointing.This call returns immediately, and will not execute until you call execute() or take an action that executes.
The specified bullet power is an amount of energy that will be taken from the robot's energy. Hence, the more power you want to spend on the bullet, the more energy is taken from your robot.
The bullet will do (4 * power) damage if it hits another robot. If power is greater than 1, it will do an additional 2 * (power - 1) damage. You will get (3 * power) back if you hit the other robot. You can call
Rules.getBulletDamage(double)for getting the damage that a bullet with a specific bullet power will do.The specified bullet power should be between
Rules.MIN_BULLET_POWERandRules.MAX_BULLET_POWER.Note that the gun cannot fire if the gun is overheated, meaning that
Robot.getGunHeat()returns a value > 0.A event is generated when the bullet hits a robot (
BulletHitEvent), wall (BulletMissedEvent), or another bullet (BulletHitBulletEvent).Example:
Bullet bullet = null;
// Fire a bullet with maximum power if the gun is ready if (getGunHeat() == 0) { bullet = setFireBullet(Rules.MAX_BULLET_POWER); } ... execute(); ... // Get the velocity of the bullet if (bullet != null) { double bulletVelocity = bullet.getVelocity(); }
- Parameters:
power- the amount of energy given to the bullet, and subtracted from the robot's energy.- Returns:
- a
Bulletthat contains information about the bullet if it was actually fired, which can be used for tracking the bullet after it has been fired. If the bullet was not fired,nullis returned. - See Also:
-
addCustomEvent
Registers a custom event to be called when a condition is met. When you are finished with your condition or just want to remove it you must callremoveCustomEvent(Condition).Example:
// Create the condition for our custom event Condition triggerHitCondition = new Condition("triggerhit") { public boolean test() { return (getEnergy() invalid input: '<'= trigger); } } // Add our custom event based on our condition addCustomEvent(triggerHitCondition);- Parameters:
condition- the condition that must be met.- Throws:
NullPointerException- if the condition parameter has been set tonull.- See Also:
-
removeCustomEvent
Removes a custom event that was previously added by callingaddCustomEvent(Condition).Example:
// Create the condition for our custom event Condition triggerHitCondition = new Condition("triggerhit") { public boolean test() { return (getEnergy() invalid input: '<'= trigger); } } // Add our custom event based on our condition addCustomEvent(triggerHitCondition); ... do something with your robot ... // Remove the custom event based on our condition removeCustomEvent(triggerHitCondition);- Parameters:
condition- the condition that was previous added and that must be removed now.- Throws:
NullPointerException- if the condition parameter has been set tonull.- See Also:
-
clearAllEvents
public void clearAllEvents()Clears out any pending events in the robot's event queue immediately.- See Also:
-
execute
public void execute()Executes any pending actions, or continues executing actions that are in process. This call returns after the actions have been started.Note that advanced robots must call this function in order to execute pending set* calls like e.g.
setAhead(double),setFire(double),setTurnLeft(double)etc. Otherwise, these calls will never get executed.In this example the robot will move while turning:
setTurnRight(90); setAhead(100); execute(); while (getDistanceRemaining() > 0 invalid input: '&'invalid input: '&' getTurnRemaining() > 0) { execute(); }
-
getAllEvents
Returns a vector containing all events currently in the robot's queue. You might, for example, call this while processing another event.Example:
for (Event event : getAllEvents()) { if (event instanceof HitRobotEvent) { // do something with the event } else if (event instanceof HitByBulletEvent) { // do something with the event } }- Returns:
- a vector containing all events currently in the robot's queue
- See Also:
-
getBulletHitBulletEvents
Returns a vector containing all BulletHitBulletEvents currently in the robot's queue. You might, for example, call this while processing another event.Example:
for (BulletHitBulletEvent event : getBulletHitBulletEvents()) { // do something with the event }- Returns:
- a vector containing all BulletHitBulletEvents currently in the robot's queue
- See Also:
-
getBulletHitEvents
Returns a vector containing all BulletHitEvents currently in the robot's queue. You might, for example, call this while processing another event.Example:
for (BulletHitEvent event: getBulletHitEvents()) { // do something with the event }- Returns:
- a vector containing all BulletHitEvents currently in the robot's queue
- See Also:
-
getBulletMissedEvents
Returns a vector containing all BulletMissedEvents currently in the robot's queue. You might, for example, call this while processing another event.Example:
for (BulletMissedEvent event : getBulletMissedEvents()) { // do something with the event }- Returns:
- a vector containing all BulletMissedEvents currently in the robot's queue
- See Also:
-
getDataDirectory
Returns a file representing a data directory for the robot, which can be written to usingRobocodeFileOutputStreamorRobocodeFileWriter.The system will automatically create the directory for you, so you do not need to create it by yourself.
- Returns:
- a file representing the data directory for your robot
- See Also:
-
getDataFile
Returns a file in your data directory that you can write to usingRobocodeFileOutputStreamorRobocodeFileWriter.The system will automatically create the directory for you, so you do not need to create it by yourself.
Please notice that the max. size of your data file is set to 200000 (~195 KB).
See the
sample.SittingDuckto see an example of how to use this method.- Parameters:
filename- the file name of the data file for your robot- Returns:
- a file representing the data file for your robot or null if the data file could not be created due to an error.
- See Also:
-
getDataQuotaAvailable
public long getDataQuotaAvailable()Returns the data quota available in your data directory, i.e. the amount of bytes left in the data directory for the robot.- Returns:
- the amount of bytes left in the robot's data directory
- See Also:
-
getEventPriority
Returns the current priority of a class of events. An event priority is a value from 0 - 99. The higher value, the higher priority.Example:
int myHitRobotPriority = getEventPriority("HitRobotEvent");The default priorities are, from highest to lowest:
RoundEndedEvent: 100 (reserved)BattleEndedEvent: 100 (reserved)WinEvent: 100 (reserved)SkippedTurnEvent: 100 (reserved)StatusEvent: 99 Key and mouse events: 98CustomEvent: 80 (default value)MessageEvent: 75RobotDeathEvent: 70BulletMissedEvent: 60BulletHitBulletEvent: 55BulletHitEvent: 50HitByBulletEvent: 40HitWallEvent: 30HitRobotEvent: 20ScannedRobotEvent: 10PaintEvent: 5DeathEvent: -1 (reserved)- Parameters:
eventClass- the name of the event class (string)- Returns:
- the current priority of a class of events
- See Also:
-
getHitByBulletEvents
Returns a vector containing all HitByBulletEvents currently in the robot's queue. You might, for example, call this while processing another event.Example:
for (HitByBulletEvent event : getHitByBulletEvents()) { // do something with the event }- Returns:
- a vector containing all HitByBulletEvents currently in the robot's queue
- See Also:
-
getHitRobotEvents
Returns a vector containing all HitRobotEvents currently in the robot's queue. You might, for example, call this while processing another event.Example:
for (HitRobotEvent event : getHitRobotEvents()) { // do something with the event }- Returns:
- a vector containing all HitRobotEvents currently in the robot's queue
- See Also:
-
getHitWallEvents
Returns a vector containing all HitWallEvents currently in the robot's queue. You might, for example, call this while processing another event.Example:
for (HitWallEvent event : getHitWallEvents()) { // do something with the event }- Returns:
- a vector containing all HitWallEvents currently in the robot's queue
- See Also:
-
getRobotDeathEvents
Returns a vector containing all RobotDeathEvents currently in the robot's queue. You might, for example, call this while processing another event.Example:
for (RobotDeathEvent event : getRobotDeathEvents()) { // do something with the event }- Returns:
- a vector containing all RobotDeathEvents currently in the robot's queue
- See Also:
-
getScannedRobotEvents
Returns a vector containing all ScannedRobotEvents currently in the robot's queue. You might, for example, call this while processing another event.Example:
for (ScannedRobotEvent event : getScannedRobotEvents()) { // do something with the event }- Returns:
- a vector containing all ScannedRobotEvents currently in the robot's queue
- See Also:
-
getStatusEvents
Returns a vector containing all StatusEvents currently in the robot's queue. You might, for example, call this while processing another event.Example:
for (StatusEvent event : getStatusEvents()) { // do something with the event }- Returns:
- a vector containing all StatusEvents currently in the robot's queue
- Since:
- 1.6.1
- See Also:
-
isAdjustGunForRobotTurn
public boolean isAdjustGunForRobotTurn()Checks if the gun is set to adjust for the robot turning, i.e. to turn independent from the robot's body turn.This call returns
trueif the gun is set to turn independent of the turn of the robot's body. Otherwise,falseis returned, meaning that the gun is set to turn with the robot's body turn.- Returns:
trueif the gun is set to turn independent of the robot turning;falseif the gun is set to turn with the robot turning- See Also:
-
isAdjustRadarForRobotTurn
public boolean isAdjustRadarForRobotTurn()Checks if the radar is set to adjust for the robot turning, i.e. to turn independent from the robot's body turn.This call returns
trueif the radar is set to turn independent of the turn of the robot. Otherwise,falseis returned, meaning that the radar is set to turn with the robot's turn.- Returns:
trueif the radar is set to turn independent of the robot turning;falseif the radar is set to turn with the robot turning- See Also:
-
isAdjustRadarForGunTurn
public boolean isAdjustRadarForGunTurn()Checks if the radar is set to adjust for the gun turning, i.e. to turn independent from the gun's turn.This call returns
trueif the radar is set to turn independent of the turn of the gun. Otherwise,falseis returned, meaning that the radar is set to turn with the gun's turn.- Returns:
trueif the radar is set to turn independent of the gun turning;falseif the radar is set to turn with the gun turning- See Also:
-
onCustomEvent
This method is called when a custom condition is met.See the sample robots for examples of use, e.g. the
sample.Targetrobot.- Specified by:
onCustomEventin interfaceIAdvancedEvents- Parameters:
event- the custom event that occurred- See Also:
-
setEventPriority
Sets the priority of a class of events.Events are sent to the onXXX handlers in order of priority. Higher priority events can interrupt lower priority events. For events with the same priority, newer events are always sent first. Valid priorities are 0 - 99, where 100 is reserved and 80 is the default priority.
Example:
setEventPriority("RobotDeathEvent", 15);The default priorities are, from highest to lowest:
WinEvent: 100 (reserved)SkippedTurnEvent: 100 (reserved)StatusEvent: 99CustomEvent: 80MessageEvent: 75RobotDeathEvent: 70BulletMissedEvent: 60BulletHitBulletEvent: 55BulletHitEvent: 50HitByBulletEvent: 40HitWallEvent: 30HitRobotEvent: 20ScannedRobotEvent: 10PaintEvent: 5DeathEvent: -1 (reserved)Note that you cannot change the priority for events with the special priority value -1 or 100 (reserved) as these event are system events. Also note that you cannot change the priority of CustomEvent. Instead you must change the priority of the condition(s) for your custom event(s).
- Parameters:
eventClass- the name of the event class (string) to set the priority forpriority- the new priority for that event class- Since:
- 1.5, the priority of DeathEvent was changed from 100 to -1 in order to let robots process pending events on its event queue before it dies. When the robot dies, it will not be able to process events.
- See Also:
-
setInterruptible
public void setInterruptible(boolean interruptible) Call this during an event handler to allow new events of the same priority to restart the event handler.Example:
public void onScannedRobot(ScannedRobotEvent e) { fire(1); setInterruptible(true); ahead(100); // If you see a robot while moving ahead, // this handler will start from the top // Without setInterruptible(true), we wouldn't // receive scan events at all! // We'll only get here if we don't see a robot during the move. out.println("Ok, I can't see anyone"); }- Overrides:
setInterruptiblein class_Robot- Parameters:
interruptible-trueif the event handler should be interrupted if new events of the same priority occurs;falseotherwise- See Also:
-
setMaxTurnRate
public void setMaxTurnRate(double newMaxTurnRate) Sets the maximum turn rate of the robot measured in degrees if the robot should turn slower thanRules.MAX_TURN_RATE(10 degress/turn).- Parameters:
newMaxTurnRate- the new maximum turn rate of the robot measured in degrees. Valid values are 0 -Rules.MAX_TURN_RATE- See Also:
-
setMaxVelocity
public void setMaxVelocity(double newMaxVelocity) Sets the maximum velocity of the robot measured in pixels/turn if the robot should move slower thanRules.MAX_VELOCITY(8 pixels/turn).- Parameters:
newMaxVelocity- the new maximum turn rate of the robot measured in pixels/turn. Valid values are 0 -Rules.MAX_VELOCITY- See Also:
-
setResume
public void setResume()Sets the robot to resume the movement stopped bystop()orsetStop(), if any.This call returns immediately, and will not execute until you call
execute()or take an action that executes.- See Also:
-
setStop
public void setStop()This call is identical tostop(), but returns immediately, and will not execute until you callexecute()or take an action that executes.If there is already movement saved from a previous stop, this will have no effect.
This call is equivalent to calling
setStop(false);- See Also:
-
setStop
public void setStop(boolean overwrite) This call is identical tostop(boolean), but returns immediately, and will not execute until you callexecute()or take an action that executes.If there is already movement saved from a previous stop, you can overwrite it by calling
setStop(true).- Parameters:
overwrite-trueif the movement saved from a previous stop should be overwritten;falseotherwise.- See Also:
-
setTurnGunLeft
public void setTurnGunLeft(double degrees) Sets the robot's gun to turn left by degrees when the next execution takes place.This call returns immediately, and will not execute until you call execute() or take an action that executes.
Note that both positive and negative values can be given as input, where negative values means that the robot's gun is set to turn right instead of left.
Example:
// Set the gun to turn 180 degrees to the left setTurnGunLeft(180); // Set the gun to turn 90 degrees to the right instead of left // (overrides the previous order) setTurnGunLeft(-90); ... // Executes the last setTurnGunLeft() execute();
- Parameters:
degrees- the amount of degrees to turn the robot's gun to the left. Ifdegrees> 0 the robot's gun is set to turn left. Ifdegreesinvalid input: '<' 0 the robot's gun is set to turn right. Ifdegrees= 0 the robot's gun is set to stop turning.- See Also:
-
setTurnGunRight
public void setTurnGunRight(double degrees) Sets the robot's gun to turn right by degrees when the next execution takes place.This call returns immediately, and will not execute until you call execute() or take an action that executes.
Note that both positive and negative values can be given as input, where negative values means that the robot's gun is set to turn left instead of right.
Example:
// Set the gun to turn 180 degrees to the right setTurnGunRight(180); // Set the gun to turn 90 degrees to the left instead of right // (overrides the previous order) setTurnGunRight(-90); ... // Executes the last setTurnGunRight() execute();
- Parameters:
degrees- the amount of degrees to turn the robot's gun to the right. Ifdegrees> 0 the robot's gun is set to turn right. Ifdegreesinvalid input: '<' 0 the robot's gun is set to turn left. Ifdegrees= 0 the robot's gun is set to stop turning.- See Also:
-
setTurnRadarLeft
public void setTurnRadarLeft(double degrees) Sets the robot's radar to turn left by degrees when the next execution takes place.This call returns immediately, and will not execute until you call execute() or take an action that executes.
Note that both positive and negative values can be given as input, where negative values means that the robot's radar is set to turn right instead of left.
Example:
// Set the radar to turn 180 degrees to the left setTurnRadarLeft(180); // Set the radar to turn 90 degrees to the right instead of left // (overrides the previous order) setTurnRadarLeft(-90); ... // Executes the last setTurnRadarLeft() execute();
- Parameters:
degrees- the amount of degrees to turn the robot's radar to the left. Ifdegrees> 0 the robot's radar is set to turn left. Ifdegreesinvalid input: '<' 0 the robot's radar is set to turn right. Ifdegrees= 0 the robot's radar is set to stop turning.- See Also:
-
setTurnRadarRight
public void setTurnRadarRight(double degrees) Sets the robot's radar to turn right by degrees when the next execution takes place.This call returns immediately, and will not execute until you call execute() or take an action that executes.
Note that both positive and negative values can be given as input, where negative values means that the robot's radar is set to turn left instead of right.
Example:
// Set the radar to turn 180 degrees to the right setTurnRadarRight(180); // Set the radar to turn 90 degrees to the right instead of right // (overrides the previous order) setTurnRadarRight(-90); ... // Executes the last setTurnRadarRight() execute();
- Parameters:
degrees- the amount of degrees to turn the robot's radar to the right. Ifdegrees> 0 the robot's radar is set to turn right. Ifdegreesinvalid input: '<' 0 the robot's radar is set to turn left. Ifdegrees= 0 the robot's radar is set to stop turning.- See Also:
-
waitFor
Does not return until a condition is met, i.e. when aCondition.test()returnstrue.This call executes immediately.
See the
sample.Crazyrobot for how this method can be used.- Parameters:
condition- the condition that must be met before this call returns- See Also:
-
onDeath
This method is called if your robot dies.You should override it in your robot if you want to be informed of this event. Actions will have no effect if called from this section. The intent is to allow you to perform calculations or print something out when the robot is killed.
- Specified by:
onDeathin interfaceIBasicEvents- Overrides:
onDeathin classRobot- Parameters:
event- the death event set by the game- See Also:
-
onSkippedTurn
This method is called if the robot is using too much time between actions. When this event occur, the robot's turn is skipped, meaning that it cannot take action anymore in this turn.If you receive 30 skipped turn event, your robot will be removed from the round and loose the round.
You will only receive this event after taking an action. So a robot in an infinite loop will not receive any events, and will simply be stopped.
No correctly working, reasonable robot should ever receive this event unless it is using too many CPU cycles.
- Specified by:
onSkippedTurnin interfaceIAdvancedEvents- Parameters:
event- the skipped turn event set by the game- See Also:
-
getHeadingRadians
public double getHeadingRadians()Returns the direction that the robot's body is facing, in radians. The value returned will be between 0 and 2 * PI (is excluded).Note that the heading in Robocode is like a compass, where 0 means North, PI / 2 means East, PI means South, and 3 * PI / 2 means West.
- Overrides:
getHeadingRadiansin class_AdvancedRadiansRobot- Returns:
- the direction that the robot's body is facing, in radians.
- See Also:
-
setTurnLeftRadians
public void setTurnLeftRadians(double radians) Sets the robot's body to turn left by radians when the next execution takes place.This call returns immediately, and will not execute until you call execute() or take an action that executes.
Note that both positive and negative values can be given as input, where negative values means that the robot's body is set to turn right instead of left.
Example:
// Set the robot to turn 180 degrees to the left setTurnLeftRadians(Math.PI); // Set the robot to turn 90 degrees to the right instead of left // (overrides the previous order) setTurnLeftRadians(-Math.PI / 2); ... // Executes the last setTurnLeftRadians() execute();
- Overrides:
setTurnLeftRadiansin class_AdvancedRadiansRobot- Parameters:
radians- the amount of radians to turn the robot's body to the left. Ifradians> 0 the robot is set to turn left. Ifradiansinvalid input: '<' 0 the robot is set to turn right. Ifradians= 0 the robot is set to stop turning.- See Also:
-
setTurnRightRadians
public void setTurnRightRadians(double radians) Sets the robot's body to turn right by radians when the next execution takes place.This call returns immediately, and will not execute until you call execute() or take an action that executes.
Note that both positive and negative values can be given as input, where negative values means that the robot's body is set to turn left instead of right.
Example:
// Set the robot to turn 180 degrees to the right setTurnRightRadians(Math.PI); // Set the robot to turn 90 degrees to the left instead of right // (overrides the previous order) setTurnRightRadians(-Math.PI / 2); ... // Executes the last setTurnRightRadians() execute();
- Overrides:
setTurnRightRadiansin class_AdvancedRadiansRobot- Parameters:
radians- the amount of radians to turn the robot's body to the right. Ifradians> 0 the robot is set to turn right. Ifradiansinvalid input: '<' 0 the robot is set to turn left. Ifradians= 0 the robot is set to stop turning.- See Also:
-
turnLeftRadians
public void turnLeftRadians(double radians) Immediately turns the robot's body to the left by radians.This call executes immediately, and does not return until it is complete, i.e. when the angle remaining in the robot's turn is 0.
Note that both positive and negative values can be given as input, where negative values means that the robot's body is set to turn right instead of left.
Example:
// Turn the robot 180 degrees to the left turnLeftRadians(Math.PI); // Afterwards, turn the robot 90 degrees to the right turnLeftRadians(-Math.PI / 2);
- Overrides:
turnLeftRadiansin class_AdvancedRadiansRobot- Parameters:
radians- the amount of radians to turn the robot's body to the left. Ifradians> 0 the robot will turn right. Ifradiansinvalid input: '<' 0 the robot will turn left. Ifradians= 0 the robot will not turn, but execute.- See Also:
-
turnRightRadians
public void turnRightRadians(double radians) Immediately turns the robot's body to the right by radians. This call executes immediately, and does not return until it is complete, i.e. when the angle remaining in the robot's turn is 0.Note that both positive and negative values can be given as input, where negative values means that the robot's body is set to turn left instead of right.
Example:
// Turn the robot 180 degrees to the right turnRightRadians(Math.PI); // Afterwards, turn the robot 90 degrees to the left turnRightRadians(-Math.PI / 2);
- Overrides:
turnRightRadiansin class_AdvancedRadiansRobot- Parameters:
radians- the amount of radians to turn the robot's body to the right. Ifradians> 0 the robot will turn right. Ifradiansinvalid input: '<' 0 the robot will turn left. Ifradians= 0 the robot will not turn, but execute.- See Also:
-
getGunHeadingRadians
public double getGunHeadingRadians()Returns the direction that the robot's gun is facing, in radians. The value returned will be between 0 and 2 * PI (is excluded).Note that the heading in Robocode is like a compass, where 0 means North, PI / 2 means East, PI means South, and 3 * PI / 2 means West.
- Overrides:
getGunHeadingRadiansin class_AdvancedRadiansRobot- Returns:
- the direction that the robot's gun is facing, in radians.
- See Also:
-
getRadarHeadingRadians
public double getRadarHeadingRadians()Returns the direction that the robot's radar is facing, in radians. The value returned will be between 0 and 2 * PI (is excluded).Note that the heading in Robocode is like a compass, where 0 means North, PI / 2 means East, PI means South, and 3 * PI / 2 means West.
- Overrides:
getRadarHeadingRadiansin class_AdvancedRadiansRobot- Returns:
- the direction that the robot's radar is facing, in radians.
- See Also:
-
setTurnGunLeftRadians
public void setTurnGunLeftRadians(double radians) Sets the robot's gun to turn left by radians when the next execution takes place.This call returns immediately, and will not execute until you call execute() or take an action that executes.
Note that both positive and negative values can be given as input, where negative values means that the robot's gun is set to turn right instead of left.
Example:
// Set the gun to turn 180 degrees to the left setTurnGunLeftRadians(Math.PI); // Set the gun to turn 90 degrees to the right instead of left // (overrides the previous order) setTurnGunLeftRadians(-Math.PI / 2); ... // Executes the last setTurnGunLeftRadians() execute();
- Overrides:
setTurnGunLeftRadiansin class_AdvancedRadiansRobot- Parameters:
radians- the amount of radians to turn the robot's gun to the left. Ifradians> 0 the robot's gun is set to turn left. Ifradiansinvalid input: '<' 0 the robot's gun is set to turn right. Ifradians= 0 the robot's gun is set to stop turning.- See Also:
-
setTurnGunRightRadians
public void setTurnGunRightRadians(double radians) Sets the robot's gun to turn right by radians when the next execution takes place.This call returns immediately, and will not execute until you call execute() or take an action that executes.
Note that both positive and negative values can be given as input, where negative values means that the robot's gun is set to turn left instead of right.
Example:
// Set the gun to turn 180 degrees to the right setTurnGunRightRadians(Math.PI); // Set the gun to turn 90 degrees to the left instead of right // (overrides the previous order) setTurnGunRightRadians(-Math.PI / 2); ... // Executes the last setTurnGunRightRadians() execute();
- Overrides:
setTurnGunRightRadiansin class_AdvancedRadiansRobot- Parameters:
radians- the amount of radians to turn the robot's gun to the right. Ifradians> 0 the robot's gun is set to turn left. Ifradiansinvalid input: '<' 0 the robot's gun is set to turn right. Ifradians= 0 the robot's gun is set to stop turning.- See Also:
-
setTurnRadarLeftRadians
public void setTurnRadarLeftRadians(double radians) Sets the robot's radar to turn left by radians when the next execution takes place.This call returns immediately, and will not execute until you call execute() or take an action that executes.
Note that both positive and negative values can be given as input, where negative values means that the robot's radar is set to turn right instead of left.
Example:
// Set the radar to turn 180 degrees to the left setTurnRadarLeftRadians(Math.PI); // Set the radar to turn 90 degrees to the right instead of left // (overrides the previous order) setTurnRadarLeftRadians(-Math.PI / 2); ... // Executes the last setTurnRadarLeftRadians() execute();
- Overrides:
setTurnRadarLeftRadiansin class_AdvancedRadiansRobot- Parameters:
radians- the amount of radians to turn the robot's radar to the left. Ifradians> 0 the robot's radar is set to turn left. Ifradiansinvalid input: '<' 0 the robot's radar is set to turn right. Ifradians= 0 the robot's radar is set to stop turning.- See Also:
-
setTurnRadarRightRadians
public void setTurnRadarRightRadians(double radians) Sets the robot's radar to turn right by radians when the next execution takes place.This call returns immediately, and will not execute until you call execute() or take an action that executes.
Note that both positive and negative values can be given as input, where negative values means that the robot's radar is set to turn left instead of right.
Example:
// Set the radar to turn 180 degrees to the right setTurnRadarRightRadians(Math.PI); // Set the radar to turn 90 degrees to the right instead of right // (overrides the previous order) setTurnRadarRightRadians(-Math.PI / 2); ... // Executes the last setTurnRadarRightRadians() execute();
- Overrides:
setTurnRadarRightRadiansin class_AdvancedRadiansRobot- Parameters:
radians- the amount of radians to turn the robot's radar to the right. Ifradians> 0 the robot's radar is set to turn left. Ifradiansinvalid input: '<' 0 the robot's radar is set to turn right. Ifradians= 0 the robot's radar is set to stop turning.- See Also:
-
turnGunLeftRadians
public void turnGunLeftRadians(double radians) Immediately turns the robot's gun to the left by radians.This call executes immediately, and does not return until it is complete, i.e. when the angle remaining in the gun's turn is 0.
Note that both positive and negative values can be given as input, where negative values means that the robot's gun is set to turn right instead of left.
Example:
// Turn the robot's gun 180 degrees to the left turnGunLeftRadians(Math.PI); // Afterwards, turn the robot's gun 90 degrees to the right turnGunLeftRadians(-Math.PI / 2);
- Overrides:
turnGunLeftRadiansin class_AdvancedRadiansRobot- Parameters:
radians- the amount of radians to turn the robot's gun to the left. Ifradians> 0 the robot's gun will turn left. Ifradiansinvalid input: '<' 0 the robot's gun will turn right. Ifradians= 0 the robot's gun will not turn, but execute.- See Also:
-
turnGunRightRadians
public void turnGunRightRadians(double radians) Immediately turns the robot's gun to the right by radians. This call executes immediately, and does not return until it is complete, i.e. when the angle remaining in the gun's turn is 0.Note that both positive and negative values can be given as input, where negative values means that the robot's gun is set to turn left instead of right.
Example:
// Turn the robot's gun 180 degrees to the right turnGunRightRadians(Math.PI); // Afterwards, turn the robot's gun 90 degrees to the left turnGunRightRadians(-Math.PI / 2);
- Overrides:
turnGunRightRadiansin class_AdvancedRadiansRobot- Parameters:
radians- the amount of radians to turn the robot's gun to the right. Ifradians> 0 the robot's gun will turn right. Ifradiansinvalid input: '<' 0 the robot's gun will turn left. Ifradians= 0 the robot's gun will not turn, but execute.- See Also:
-
turnRadarLeftRadians
public void turnRadarLeftRadians(double radians) Immediately turns the robot's radar to the left by radians.This call executes immediately, and does not return until it is complete, i.e. when the angle remaining in the radar's turn is 0.
Note that both positive and negative values can be given as input, where negative values means that the robot's radar is set to turn right instead of left.
Example:
// Turn the robot's radar 180 degrees to the left turnRadarLeftRadians(Math.PI); // Afterwards, turn the robot's radar 90 degrees to the right turnRadarLeftRadians(-Math.PI / 2);
- Overrides:
turnRadarLeftRadiansin class_AdvancedRadiansRobot- Parameters:
radians- the amount of radians to turn the robot's radar to the left. Ifradians> 0 the robot's radar will turn left. Ifradiansinvalid input: '<' 0 the robot's radar will turn right. Ifradians= 0 the robot's radar will not turn, but execute.- See Also:
-
turnRadarRightRadians
public void turnRadarRightRadians(double radians) Immediately turns the robot's radar to the right by radians. This call executes immediately, and does not return until it is complete, i.e. when the angle remaining in the radar's turn is 0.Note that both positive and negative values can be given as input, where negative values means that the robot's radar is set to turn left instead of right.
Example:
// Turn the robot's radar 180 degrees to the right turnRadarRightRadians(Math.PI); // Afterwards, turn the robot's radar 90 degrees to the left turnRadarRightRadians(-Math.PI / 2);
- Overrides:
turnRadarRightRadiansin class_AdvancedRadiansRobot- Parameters:
radians- the amount of radians to turn the robot's radar to the right. Ifradians> 0 the robot's radar will turn right. Ifradiansinvalid input: '<' 0 the robot's radar will turn left. Ifradians= 0 the robot's radar will not turn, but execute.- See Also:
-
getGunTurnRemainingRadians
public double getGunTurnRemainingRadians()Returns the angle remaining in the gun's turn, in radians.This call returns both positive and negative values. Positive values means that the gun is currently turning to the right. Negative values means that the gun is currently turning to the left.
- Overrides:
getGunTurnRemainingRadiansin class_AdvancedRadiansRobot- Returns:
- the angle remaining in the gun's turn, in radians
- See Also:
-
getRadarTurnRemainingRadians
public double getRadarTurnRemainingRadians()Returns the angle remaining in the radar's turn, in radians.This call returns both positive and negative values. Positive values means that the radar is currently turning to the right. Negative values means that the radar is currently turning to the left.
- Overrides:
getRadarTurnRemainingRadiansin class_AdvancedRadiansRobot- Returns:
- the angle remaining in the radar's turn, in radians
- See Also:
-
getTurnRemainingRadians
public double getTurnRemainingRadians()Returns the angle remaining in the robot's turn, in radians.This call returns both positive and negative values. Positive values means that the robot is currently turning to the right. Negative values means that the robot is currently turning to the left.
- Overrides:
getTurnRemainingRadiansin class_AdvancedRadiansRobot- Returns:
- the angle remaining in the robot's turn, in radians
- See Also:
-
getAdvancedEventListener
Do not call this method!This method is called by the game to notify this robot about advanced robot event. Hence, this method must be implemented so it returns your
IAdvancedEventslistener.- Specified by:
getAdvancedEventListenerin interfaceIAdvancedRobot- Returns:
- listener to advanced events or
nullif this robot should not receive the notifications.
-