Interface WorldAPI

public interface WorldAPI

WorldAPI Interface:
Provides callbacks into Simulator so your Robot can take actions in the virtual world.
The underlying class type is an inner class defined inside the simulator which is opaque to your robot.

Method Summary

Methods

Modifier and Type	Method and Description
void	build(int power)
Robot.AttackResult	capsuleAttack(int power_of_capsule, Robot.GridCell cell) Capsule attack: attack with a capsule
void	charge(int power, Robot.GridCell ally) Spend power to charge an adjacent ally robot.
void	defend(int power) Defend: increase defense
void	drop_capsule(Robot.GridCell adjacent_cell, int power_of_capsule) drop_capsule: drop a capsule (for an ally to pick up, presumably)
Robot.BuildStatus	getBuildStatus() Tells us what we're in the middle of building.
Robot.GridCell	getBuildTarget()
int	getInvestedBuildPower()
Robot.GridCell[][]	getVisibleNeighborhood() Gets a copy of the portion of the world visible to the robot.
Robot.GridCell[][]	getWorld(int power) Gets a copy of the entire world.
Robot.AttackResult	meleeAttack(int power, Robot.GridCell adjacent_cell) Melee attack: attack an adjacent grid cell
void	move(int steps, Robot.Direction way) move: move robot
void	pick_up_capsule(Robot.GridCell adjacent_cell) pick_up_capsule: pick up a capsule
Robot.AttackResult	rangedAttack(int power, Robot.GridCell nonadjacent_cell) Ranged attack: attack nonadjacent grid cell within certain range
void	repair(int power) Spend power to repair yourself.
void	scanEnemy(Robot.Robot_Specs enemySpecs, Robot.Robot_Status enemyStatus, Robot.GridCell toScan) Scans an enemy (or ally), retrieving information about the robot.
void	sendMessage(byte[] message, int power) Sends a message to an ally or allies.
void	setBuildTarget(Robot.BuildStatus status, Robot.GridCell location) Tells the simulator the robot is beginning to build something in an adjacent cell (or, for capsules, inside itself). In order to mark a capsule or robot as "done", call this method with both parameters null.
void	setBuildTarget(Robot.BuildStatus status, Robot.GridCell location, byte[] creation_message) Tells the simulator the robot is beginning to build something in an adjacent cell (or, for capsules, inside itself). In order to mark a capsule or robot as "done", call this method with both parameters null.

Method Detail

meleeAttack

Robot.AttackResult meleeAttack(int power,
                             Robot.GridCell adjacent_cell)
                               throws RoboSim.RoboSimExecutionException

Melee attack: attack an adjacent grid cell

Parameters:

power - Power to use for attack (may not exceed attack skill)

adjacent_cell - Adjacent GridCell to attack

Returns:

AttackResult indicating whether attack succeeded and/or destroyed target of attack.

Throws:

RoboSim.RoboSimExecutionException

rangedAttack

Robot.AttackResult rangedAttack(int power,
                              Robot.GridCell nonadjacent_cell)
                                throws RoboSim.RoboSimExecutionException

Ranged attack: attack nonadjacent grid cell within certain range

Parameters:

power - Power to use for attack (may not exceed attack skill)

nonadjacent_cell - non-adjacent GridCell to attack

Returns:

AttackResult indicating whether attack succeeded and/or destroyed target of attack.

Throws:

RoboSim.RoboSimExecutionException

capsuleAttack

Robot.AttackResult capsuleAttack(int power_of_capsule,
                               Robot.GridCell cell)
                                 throws RoboSim.RoboSimExecutionException

Capsule attack: attack with a capsule

Parameters:

power_of_capsule - power of the capsule to use in the attack

cell - GridCell (may be adjacent or nonadjacent) to attack

Throws:

RoboSim.RoboSimExecutionException

defend

void defend(int power)
            throws RoboSim.RoboSimExecutionException

Defend: increase defense

Parameters:

power - power to use for defense (may not exceed defense skill)

Throws:

RoboSim.RoboSimExecutionException

move

void move(int steps,
        Robot.Direction way)
          throws RoboSim.RoboSimExecutionException

move: move robot

Parameters:

steps - how far to move

way - which way to move

Throws:

RoboSim.RoboSimExecutionException

pick_up_capsule

void pick_up_capsule(Robot.GridCell adjacent_cell)
                     throws RoboSim.RoboSimExecutionException

pick_up_capsule: pick up a capsule

Parameters:

adjacent_cell - GridCell where capsule is that you want to pick up (must be adjacent)

Throws:

RoboSim.RoboSimExecutionException

drop_capsule

void drop_capsule(Robot.GridCell adjacent_cell,
                int power_of_capsule)
                  throws RoboSim.RoboSimExecutionException

drop_capsule: drop a capsule (for an ally to pick up, presumably)

Parameters:

adjacent_cell - where to drop capsule (must be adjacent)

power_of_capsule - how powerful a capsule to drop

Throws:

RoboSim.RoboSimExecutionException

getBuildStatus

Robot.BuildStatus getBuildStatus()
                                 throws RoboSim.RoboSimExecutionException

Tells us what we're in the middle of building.

Returns:

BuildStatus object indicating what we're building. Is null if we're not building anything.

Throws:

RoboSim.RoboSimExecutionException

getBuildTarget

Robot.GridCell getBuildTarget()
                              throws RoboSim.RoboSimExecutionException

Returns:

GridCell indicating the target of our building efforts. Is null if we're not building anything.

Throws:

RoboSim.RoboSimExecutionException

getInvestedBuildPower

int getInvestedBuildPower()
                          throws RoboSim.RoboSimExecutionException

Returns:

how much we've invested in our current build target.

Throws:

RoboSim.RoboSimExecutionException

setBuildTarget

void setBuildTarget(Robot.BuildStatus status,
                  Robot.GridCell location)
                    throws RoboSim.RoboSimExecutionException

Tells the simulator the robot is beginning to build something in an adjacent cell (or, for capsules, inside itself).
In order to mark a capsule or robot as "done", call this method with both parameters null. This will destroy any in-progress build.

Note that you must not move from your current cell while in the process of building anything other than a capsule. If you do, you will lose any in-progress work on a wall or fort, and a robot will be automatically finalized with however many skill points you've invested up to that point.

Parameters:

status - what we're going to start building (or, in the case of an energy capsule, resume building)

location - where to direct our building efforts. Must be an adjacent, empty location, or null if status=capsule.

Throws:

RoboSim.RoboSimExecutionException

setBuildTarget

void setBuildTarget(Robot.BuildStatus status,
                  Robot.GridCell location,
                  byte[] creation_message)
                    throws RoboSim.RoboSimExecutionException

Tells the simulator the robot is beginning to build something in an adjacent cell (or, for capsules, inside itself).
In order to mark a capsule or robot as "done", call this method with both parameters null. This will destroy any in-progress build.

Note that you must not move from your current cell while in the process of building anything other than a capsule. If you do, you will lose any in-progress work on a wall or fort, and a robot will be automatically finalized with however many skill points you've invested up to that point.

Parameters:

status - what we're going to start building (or, in the case of an energy capsule, resume building)

location - where to direct our building efforts. Must be an adjacent, empty location, or null if status=capsule.

creation_message - message to send to newly created robot (if we're finalizing one)

Throws:

RoboSim.RoboSimExecutionException

build

void build(int power)
           throws RoboSim.RoboSimExecutionException

Parameters:

power - how much power to apply to building the current target. Must not be more than remaining power needed to finish building target.

Throws:

RoboSim.RoboSimExecutionException

repair

void repair(int power)
            throws RoboSim.RoboSimExecutionException

Spend power to repair yourself. 2 power restores 1 health.

Parameters:

power - amount of power to spend on repairs. Should be even.

Throws:

RoboSim.RoboSimExecutionException

charge

void charge(int power,
          Robot.GridCell ally)
            throws RoboSim.RoboSimExecutionException

Spend power to charge an adjacent ally robot. 1-for-1 efficiency.

Parameters:

power - amount of power to use for charging ally

ally - cell containing ally to charge. Must be adjacent.

Throws:

RoboSim.RoboSimExecutionException

sendMessage

void sendMessage(byte[] message,
               int power)
                 throws RoboSim.RoboSimExecutionException

Sends a message to an ally or allies.

Parameters:

message - 64-byte array containing message to transmit

power - amount of power to use for sending message

Throws:

RoboSim.RoboSimExecutionException

getVisibleNeighborhood

Robot.GridCell[][] getVisibleNeighborhood()

Gets a copy of the portion of the world visible to the robot. Range is equal to defense skill. Does not cost any power.

Returns:

a 2-dimensional array containing a GridCell for each cell visible to the robot.

getWorld

Robot.GridCell[][] getWorld(int power)
                            throws RoboSim.RoboSimExecutionException

Gets a copy of the entire world. Takes 3 power, plus additional if jamming is taking place (which won't be; jamming is not implemented).

Parameters:

power - to spend attempting to get the world

Returns:

a 2-dimensional array containing a GridCell for each cell in the world. Will be null if jamming has prevented the world from being retrieved.

Throws:

RoboSim.RoboSimExecutionException

scanEnemy

void scanEnemy(Robot.Robot_Specs enemySpecs,
             Robot.Robot_Status enemyStatus,
             Robot.GridCell toScan)
               throws RoboSim.RoboSimExecutionException

Scans an enemy (or ally), retrieving information about the robot. The cell scanned must be visible (within defense cells from us).
Takes 1 power.

Parameters:

enemySpecs - empty Robot_Specs object to be filled in

enemyStatus - empty Robot_Status object to be filled in

toScan - cell containing robot we want to scan

Throws:

RoboSim.RoboSimExecutionException