Index (robot-world 0.0.2 API)

A B C D E F G H I J L M N O P Q R S T U V W Z
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

add(ClientRobot) - Method in class za.co.wethinkcode.robots.client.Memory
addAndSetCurrentRobot(ClientRobot) - Method in class za.co.wethinkcode.robots.client.Memory
addLookObjectDetails(String, String) - Static method in class za.co.wethinkcode.robots.server.commands.external.LookCommand: Deprecated.
addObstacle(Position) - Method in class za.co.wethinkcode.robots.server.world.Obstacles
addRobot(Robot) - Method in class za.co.wethinkcode.robots.server.world.World: Returns true if a robot was successfully added to the world
ANSI_RED - Enum constant in enum class za.co.wethinkcode.robots.server.rendering.ServerRenderer.Colour
ANSI_RESET - Enum constant in enum class za.co.wethinkcode.robots.server.rendering.ServerRenderer.Colour
ANSI_YELLOW - Enum constant in enum class za.co.wethinkcode.robots.server.rendering.ServerRenderer.Colour
APOLLO - Enum constant in enum class za.co.wethinkcode.robots.server.robots.RobotKind: Apollo the Scout bot.
applyCommandLineOverrides(ServerOptions) - Method in class za.co.wethinkcode.robots.server.config.WorldConfig: CLI values override config.json only when the operator provides them.

B

back - Enum constant in enum class za.co.wethinkcode.robots.server.commands.ImplementedClientCommands
BackCommand - Class in za.co.wethinkcode.robots.server.commands.external
BackCommand(JsonObject) - Constructor for class za.co.wethinkcode.robots.server.commands.external.BackCommand: Overload command constructor
BackCommand(String, int) - Constructor for class za.co.wethinkcode.robots.server.commands.external.BackCommand

C

clear() - Method in class za.co.wethinkcode.robots.server.world.Obstacles
clearForTesting() - Method in class za.co.wethinkcode.robots.server.world.MazeGenerator
clearForTesting() - Method in class za.co.wethinkcode.robots.server.world.World
Client - Class in za.co.wethinkcode.robots.client
Client() - Constructor for class za.co.wethinkcode.robots.client.Client
ClientAPI - Class in za.co.wethinkcode.robots.api: The Client API class provides generic methods for interacting with the Robot Worlds API as a client
ClientAPI() - Constructor for class za.co.wethinkcode.robots.api.ClientAPI
ClientConnectionException - Exception Class in za.co.wethinkcode.robots.errors: All Exceptions related to the client connecting to the server (especially with regards to the ConnectedClient are handled by this class
ClientConnectionException(String) - Constructor for exception class za.co.wethinkcode.robots.errors.ClientConnectionException
ClientControlledRobot - Class in za.co.wethinkcode.robots.server.robots: A subclass of the domain object robot that is specifically controlled by a client
ClientControlledRobot(String, RobotKind, ClientID) - Constructor for class za.co.wethinkcode.robots.server.robots.ClientControlledRobot: Constructor for a robot controlled by a client.
ClientHandler - Class in za.co.wethinkcode.robots.client
ClientHandler(Socket) - Constructor for class za.co.wethinkcode.robots.client.ClientHandler
ClientID - Record Class in za.co.wethinkcode.robots.server.networking: Record class of a client's ID.
ClientID(String) - Constructor for record class za.co.wethinkcode.robots.server.networking.ClientID: Creates an instance of a ClientID record class.
ClientOptions - Class in za.co.wethinkcode.robots.cli
ClientOptions() - Constructor for class za.co.wethinkcode.robots.cli.ClientOptions
ClientQuitCommand - Class in za.co.wethinkcode.robots.server.commands.external
ClientQuitCommand(JsonObject) - Constructor for class za.co.wethinkcode.robots.server.commands.external.ClientQuitCommand: Overload command constructor
ClientQuitCommand(String) - Constructor for class za.co.wethinkcode.robots.server.commands.external.ClientQuitCommand
ClientRobot - Class in za.co.wethinkcode.robots.client: This class stores the representation of the robot for a client
ClientRobot(String, RobotKind) - Constructor for class za.co.wethinkcode.robots.client.ClientRobot
CliParser - Class in za.co.wethinkcode.robots.cli
CliParser(Object) - Constructor for class za.co.wethinkcode.robots.cli.CliParser
Command - Class in za.co.wethinkcode.robots.server.commands: Every command follows this same pattern: It receives a robot name and arguments It runs against the world It returns a result string
Command(JsonObject) - Constructor for class za.co.wethinkcode.robots.server.commands.Command: Overload command constructor
Command(String) - Constructor for class za.co.wethinkcode.robots.server.commands.Command: Required command constructor
ConfigLoader - Class in za.co.wethinkcode.robots.server.config
ConfigLoader() - Constructor for class za.co.wethinkcode.robots.server.config.ConfigLoader
connect(String, int) - Method in interface za.co.wethinkcode.robots.client.RobotWorldClient: Connects to the Robot Worlds server on specified ip address and port
connect(String, int) - Method in class za.co.wethinkcode.robots.client.RobotWorldJsonClient
ConnectedClient - Class in za.co.wethinkcode.robots.server.networking: This class encapsulates all the behaviour of a single connected client
ConnectedClient(Socket, World) - Constructor for class za.co.wethinkcode.robots.server.networking.ConnectedClient: Standard constructor for a Connected Client
connection() - Method in class za.co.wethinkcode.robots.cli.ClientOptions
ConnectionOptions - Class in za.co.wethinkcode.robots.cli
ConnectionOptions() - Constructor for class za.co.wethinkcode.robots.cli.ConnectionOptions
connectToServerTicket(WorldConfig, String) - Static method in class za.co.wethinkcode.robots.server.rendering.ServerRenderer: Renders the connect to server ticket display based on an IP address invalid input: '&' config
createRequest(String, InputParser) - Static method in class za.co.wethinkcode.robots.api.ClientAPI: builds a JSON request for the server.

D

DEAD - Enum constant in enum class za.co.wethinkcode.robots.server.robots.Status: A dead robot cannot act ever again
defaultIpAddress - Static variable in class za.co.wethinkcode.robots.server.config.WorldConfig
defineCommand(String, ClientID) - Method in class za.co.wethinkcode.robots.server.commands.ExternalCommandSwitcher: Take in the raw string input from a client and return out an ExternalCommand
deleteObstaclesFile(String) - Static method in class za.co.wethinkcode.robots.server.world.MazeGenerator
Direction - Enum Class in za.co.wethinkcode.robots.server.world
disconnect() - Method in interface za.co.wethinkcode.robots.client.RobotWorldClient: Disconnect from server
disconnect() - Method in class za.co.wethinkcode.robots.client.RobotWorldJsonClient
disconnectRobotsFromClientId(ClientID) - Method in class za.co.wethinkcode.robots.server.world.World: Take in a ClientID and remove all bots from the server associated with this clientID
displayMazeAsIBM437(Maze) - Static method in class za.co.wethinkcode.robots.server.rendering.ServerRenderer: Take in a maze and print it in IBM437 format
DumpCommand - Class in za.co.wethinkcode.robots.server.commands.internal
DumpCommand() - Constructor for class za.co.wethinkcode.robots.server.commands.internal.DumpCommand

E

EAST - Enum constant in enum class za.co.wethinkcode.robots.server.world.Direction
enterServerCommand() - Static method in class za.co.wethinkcode.robots.server.rendering.ServerRenderer: Prompt message for a Server Command to be entered
equals(Object) - Method in record class za.co.wethinkcode.robots.server.networking.ClientID: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class za.co.wethinkcode.robots.server.world.Position
error(Exception) - Static method in class za.co.wethinkcode.robots.api.ServerAPI: Return an Error From an exception
error(String) - Static method in class za.co.wethinkcode.robots.api.ServerAPI: Takes in an error message and wraps into a JSON structured error
error(RobotCannotActException) - Static method in class za.co.wethinkcode.robots.api.ServerAPI: Overload to send back a specific error message for the custom RobotCannotActException
error(UnsupportedRobotWorldCommand) - Static method in class za.co.wethinkcode.robots.api.ServerAPI: Overload to send back a specific error message for the custom UnsupportedRobotWorldCommand exception
execute(World) - Method in class za.co.wethinkcode.robots.server.commands.Command: Modern a modern OO implementation of the execute method
execute(World) - Method in class za.co.wethinkcode.robots.server.commands.external.BackCommand: Modern OO implementation of the execute method
execute(World) - Method in class za.co.wethinkcode.robots.server.commands.external.ClientQuitCommand: Modern a modern OO implementation of the execute method
execute(World) - Method in class za.co.wethinkcode.robots.server.commands.external.FireCommand: Modern OO implementation of the execute method
execute(World) - Method in class za.co.wethinkcode.robots.server.commands.external.ForwardCommand: Modern a modern OO implementation of the execute method
execute(World) - Method in class za.co.wethinkcode.robots.server.commands.external.LaunchCommand: Modern a modern OO implementation of the execute method
execute(World) - Method in class za.co.wethinkcode.robots.server.commands.external.LookCommand: Modern a modern OO implementation of the execute method
execute(World) - Method in class za.co.wethinkcode.robots.server.commands.external.ReloadCommand: Modern a modern OO implementation of the execute method
execute(World) - Method in class za.co.wethinkcode.robots.server.commands.external.RepairCommand: Modern a modern OO implementation of the execute method
execute(World) - Method in class za.co.wethinkcode.robots.server.commands.external.StateCommand: Modern a modern OO implementation of the execute method
execute(World) - Method in class za.co.wethinkcode.robots.server.commands.external.TurnCommand: Modern a modern OO implementation of the execute method
execute(World) - Method in class za.co.wethinkcode.robots.server.commands.external.WorldCommand
execute(World) - Method in class za.co.wethinkcode.robots.server.commands.internal.DumpCommand
execute(World) - Method in class za.co.wethinkcode.robots.server.commands.internal.RobotsCommand
execute(World) - Method in class za.co.wethinkcode.robots.server.commands.internal.ServerQuitCommand
executeCommand(Command) - Method in class za.co.wethinkcode.robots.server.SingleThreadConnection: Takes in a Command and executes it.
executeToString(World) - Method in class za.co.wethinkcode.robots.server.commands.Command: Each command must implement this method It does the work and returns a result
executeToString(World) - Method in class za.co.wethinkcode.robots.server.commands.external.BackCommand
executeToString(World) - Method in class za.co.wethinkcode.robots.server.commands.external.ClientQuitCommand
executeToString(World) - Method in class za.co.wethinkcode.robots.server.commands.external.FireCommand
executeToString(World) - Method in class za.co.wethinkcode.robots.server.commands.external.ForwardCommand
executeToString(World) - Method in class za.co.wethinkcode.robots.server.commands.external.LaunchCommand
executeToString(World) - Method in class za.co.wethinkcode.robots.server.commands.external.LookCommand
executeToString(World) - Method in class za.co.wethinkcode.robots.server.commands.external.ReloadCommand
executeToString(World) - Method in class za.co.wethinkcode.robots.server.commands.external.RepairCommand
executeToString(World) - Method in class za.co.wethinkcode.robots.server.commands.external.StateCommand
executeToString(World) - Method in class za.co.wethinkcode.robots.server.commands.external.TurnCommand
executeToString(World) - Method in class za.co.wethinkcode.robots.server.commands.external.WorldCommand
ExternalCommand - Class in za.co.wethinkcode.robots.server.commands.external: Abstract class of commands external to server, typically from clients
ExternalCommand(JsonObject) - Constructor for class za.co.wethinkcode.robots.server.commands.external.ExternalCommand: Overload command constructor
ExternalCommand(String) - Constructor for class za.co.wethinkcode.robots.server.commands.external.ExternalCommand: Required command constructor
ExternalCommandSwitcher - Class in za.co.wethinkcode.robots.server.commands: The Command Switcher class more elegantly responds to incoming command requests in a polymorphic way.
ExternalCommandSwitcher() - Constructor for class za.co.wethinkcode.robots.server.commands.ExternalCommandSwitcher
extractMessage(String) - Static method in class za.co.wethinkcode.robots.api.ClientAPI

F

findRandomValidPosition(Random, int) - Method in class za.co.wethinkcode.robots.server.world.WorldMap: Searches for a random position that is valid for a robot to occupy
findRobot(World) - Method in class za.co.wethinkcode.robots.server.commands.Command: Helper: look up the robot in the world Returns null if the robot doesn't exist
fire - Enum constant in enum class za.co.wethinkcode.robots.server.commands.ImplementedClientCommands
FireCommand - Class in za.co.wethinkcode.robots.server.commands.external: Fire Command - fires a bullet in the direction the robot is facing.
FireCommand(JsonObject) - Constructor for class za.co.wethinkcode.robots.server.commands.external.FireCommand: Construct a fire command from the incoming JSON
FireCommand(String) - Constructor for class za.co.wethinkcode.robots.server.commands.external.FireCommand
formatResponse(String) - Static method in class za.co.wethinkcode.robots.api.ClientAPI
forward - Enum constant in enum class za.co.wethinkcode.robots.server.commands.ImplementedClientCommands
ForwardCommand - Class in za.co.wethinkcode.robots.server.commands.external
ForwardCommand(JsonObject) - Constructor for class za.co.wethinkcode.robots.server.commands.external.ForwardCommand: Overload command constructor
ForwardCommand(String, int) - Constructor for class za.co.wethinkcode.robots.server.commands.external.ForwardCommand

G

generateClientId(World, Socket) - Static method in class za.co.wethinkcode.robots.server.networking.ConnectedClient: Static method to generate a ConnectedClient.ClientID based on a World and Socket
generateMaze(int) - Method in class za.co.wethinkcode.robots.server.world.MazeGenerator
generateRoomMaze(int) - Method in class za.co.wethinkcode.robots.server.world.MazeGenerator
getAliases() - Method in enum class za.co.wethinkcode.robots.server.commands.ImplementedClientCommands: The available aliases of an implemented Client Command
getAll() - Method in class za.co.wethinkcode.robots.server.world.Obstacles
getAllRobots() - Method in class za.co.wethinkcode.robots.server.world.World
getAmmo() - Method in enum class za.co.wethinkcode.robots.server.robots.RobotKind: Getter for this robot's ammunition
getArg(int) - Method in class za.co.wethinkcode.robots.client.InputParser
getArgs() - Method in class za.co.wethinkcode.robots.server.commands.external.ExternalCommand: Getter for the args of an external command
getClientID() - Method in class za.co.wethinkcode.robots.server.networking.ConnectedClient
getCode() - Method in enum class za.co.wethinkcode.robots.server.rendering.ServerRenderer.Colour
getCommand() - Method in class za.co.wethinkcode.robots.client.InputParser: Returns the command name e.g.
getCommandName() - Method in class za.co.wethinkcode.robots.server.commands.external.BackCommand: Return which client command this command implements
getCommandName() - Method in class za.co.wethinkcode.robots.server.commands.external.ClientQuitCommand: Return which client command this command implements
getCommandName() - Method in class za.co.wethinkcode.robots.server.commands.external.ExternalCommand: Return which client command this command implements
getCommandName() - Method in class za.co.wethinkcode.robots.server.commands.external.FireCommand: Return which client command this command implements
getCommandName() - Method in class za.co.wethinkcode.robots.server.commands.external.ForwardCommand: Return which client command this command implements
getCommandName() - Method in class za.co.wethinkcode.robots.server.commands.external.LaunchCommand: Return which client command this command implements
getCommandName() - Method in class za.co.wethinkcode.robots.server.commands.external.LookCommand: Return which client command this command implements
getCommandName() - Method in class za.co.wethinkcode.robots.server.commands.external.ReloadCommand: Return which client command this command implements
getCommandName() - Method in class za.co.wethinkcode.robots.server.commands.external.RepairCommand: Return which client command this command implements
getCommandName() - Method in class za.co.wethinkcode.robots.server.commands.external.StateCommand: Return which client command this command implements
getCommandName() - Method in class za.co.wethinkcode.robots.server.commands.external.TurnCommand: Return which client command this command implements
getCommandName() - Method in class za.co.wethinkcode.robots.server.commands.external.WorldCommand
getCurrentRobot() - Method in class za.co.wethinkcode.robots.client.Memory
getCurrentShots() - Method in class za.co.wethinkcode.robots.server.robots.Robot
getCustomObstacles() - Method in class za.co.wethinkcode.robots.server.config.WorldConfig
getDirection() - Method in class za.co.wethinkcode.robots.server.robots.Robot
getError() - Method in class za.co.wethinkcode.robots.client.InputParser: Returns the error message if the command was invalid, otherwise null
getErrorMessage() - Method in enum class za.co.wethinkcode.robots.server.robots.Status
getHeight() - Method in class za.co.wethinkcode.robots.server.world.MazeGenerator
getHeight() - Method in class za.co.wethinkcode.robots.server.world.World
getIpAddress() - Method in class za.co.wethinkcode.robots.server.config.WorldConfig
getKind() - Method in class za.co.wethinkcode.robots.server.robots.Robot
getKindName() - Method in class za.co.wethinkcode.robots.server.robots.Robot
getLastReloaded() - Method in class za.co.wethinkcode.robots.server.robots.Robot
getLastRepaired() - Method in class za.co.wethinkcode.robots.server.robots.Robot
getMap() - Method in class za.co.wethinkcode.robots.server.world.RobotWorldMap
getMap() - Method in class za.co.wethinkcode.robots.server.world.World
getMaxShields() - Method in class za.co.wethinkcode.robots.server.config.WorldConfig
getMaxShields() - Method in class za.co.wethinkcode.robots.server.robots.Robot
getMaxShields() - Method in class za.co.wethinkcode.robots.server.world.World
getMaxShots() - Method in class za.co.wethinkcode.robots.server.config.WorldConfig
getMaxShots() - Method in class za.co.wethinkcode.robots.server.robots.Robot
getMaxShots() - Method in class za.co.wethinkcode.robots.server.world.World
getMaze() - Method in class za.co.wethinkcode.robots.server.world.World
getMazeType() - Method in class za.co.wethinkcode.robots.server.config.WorldConfig
getName() - Method in class za.co.wethinkcode.robots.client.ClientRobot
getName() - Method in class za.co.wethinkcode.robots.server.robots.Robot
getNumbersConstructor() - Method in class za.co.wethinkcode.robots.server.world.Maze: Deprecated, for removal: This API element is subject to removal in a future version.
getObstacleCount() - Method in class za.co.wethinkcode.robots.server.config.WorldConfig
getObstacleCount() - Method in class za.co.wethinkcode.robots.server.world.MazeGenerator
getObstacles() - Method in class za.co.wethinkcode.robots.server.world.MazeGenerator
getObstacles() - Method in class za.co.wethinkcode.robots.server.world.World
getOwner() - Method in class za.co.wethinkcode.robots.server.robots.ClientControlledRobot
getParts() - Method in class za.co.wethinkcode.robots.client.InputParser: Returns all the words in the input as an array e.g.
getPort() - Method in class za.co.wethinkcode.robots.server.config.WorldConfig
getPosition() - Method in class za.co.wethinkcode.robots.server.robots.Robot
getRandomSpawn() - Method in class za.co.wethinkcode.robots.server.world.World
getReloadTime() - Method in class za.co.wethinkcode.robots.server.config.WorldConfig
getReloadTime() - Method in class za.co.wethinkcode.robots.server.world.World
getRepairTime() - Method in class za.co.wethinkcode.robots.server.config.WorldConfig
getRepairTime() - Method in class za.co.wethinkcode.robots.server.world.World
getRobot(String) - Method in class za.co.wethinkcode.robots.server.world.World
getRobotAt(int, int) - Method in class za.co.wethinkcode.robots.server.world.World
getRobotAt(int, int) - Method in class za.co.wethinkcode.robots.server.world.WorldMap
getRobotKind() - Method in class za.co.wethinkcode.robots.client.ClientRobot
getRobotName() - Method in class za.co.wethinkcode.robots.server.commands.Command: Get the name of the robot that this command is being executed on
getRobotSymbol(Robot) - Static method in class za.co.wethinkcode.robots.server.rendering.ServerRenderer
getShields() - Method in class za.co.wethinkcode.robots.server.robots.Robot
getShields() - Method in enum class za.co.wethinkcode.robots.server.robots.RobotKind: Getter for this robot's shield
getShotDistance() - Method in class za.co.wethinkcode.robots.server.robots.Robot
getShotDistance() - Method in enum class za.co.wethinkcode.robots.server.robots.RobotKind: Getter for how far this robot can shoot
getSocket() - Method in class za.co.wethinkcode.robots.server.networking.ConnectedClient
getStatus() - Method in class za.co.wethinkcode.robots.server.robots.Robot
getUsage() - Method in class za.co.wethinkcode.robots.server.commands.external.BackCommand: Get the way this command is supposed to be used.
getUsage() - Method in class za.co.wethinkcode.robots.server.commands.external.ClientQuitCommand: Get the way this command is supposed to be used.
getUsage() - Method in class za.co.wethinkcode.robots.server.commands.external.ExternalCommand: Get the way this command is supposed to be used.
getUsage() - Method in class za.co.wethinkcode.robots.server.commands.external.FireCommand: Get the way this command is supposed to be used.
getUsage() - Method in class za.co.wethinkcode.robots.server.commands.external.ForwardCommand: Get the way this command is supposed to be used.
getUsage() - Method in class za.co.wethinkcode.robots.server.commands.external.LaunchCommand: Get the way this command is supposed to be used.
getUsage() - Method in class za.co.wethinkcode.robots.server.commands.external.LookCommand: Get the way this command is supposed to be used.
getUsage() - Method in class za.co.wethinkcode.robots.server.commands.external.ReloadCommand: Get the way this command is supposed to be used.
getUsage() - Method in class za.co.wethinkcode.robots.server.commands.external.RepairCommand: Get the way this command is supposed to be used.
getUsage() - Method in class za.co.wethinkcode.robots.server.commands.external.StateCommand: Get the way this command is supposed to be used.
getUsage() - Method in class za.co.wethinkcode.robots.server.commands.external.TurnCommand: Get the way this command is supposed to be used.
getUsage() - Method in class za.co.wethinkcode.robots.server.commands.external.WorldCommand
getVisibility() - Method in class za.co.wethinkcode.robots.server.config.WorldConfig
getVisibility() - Method in class za.co.wethinkcode.robots.server.world.World
getWidth() - Method in class za.co.wethinkcode.robots.server.world.MazeGenerator
getWidth() - Method in class za.co.wethinkcode.robots.server.world.World
getWorldSize() - Method in class za.co.wethinkcode.robots.server.config.WorldConfig
getX() - Method in class za.co.wethinkcode.robots.server.world.Position
getY() - Method in class za.co.wethinkcode.robots.server.world.Position

H

hashCode() - Method in record class za.co.wethinkcode.robots.server.networking.ClientID: Returns a hash code value for this object.
hashCode() - Method in class za.co.wethinkcode.robots.server.world.Position
hasObstacle(Position) - Method in class za.co.wethinkcode.robots.server.world.Obstacles

I

ImplementedClientCommands - Enum Class in za.co.wethinkcode.robots.server.commands: The Implemented client Commands enum captures the allowed variants of a Client Command
InputParser - Class in za.co.wethinkcode.robots.client: Reads a line of user input and checks whether it is a valid, well-formed command.
InputParser(String) - Constructor for class za.co.wethinkcode.robots.client.InputParser: Takes the raw line the user typed and immediately validates it
ipAddress() - Method in class za.co.wethinkcode.robots.server.config.ServerOptions
isAlive() - Method in class za.co.wethinkcode.robots.server.robots.Robot: True if the robot is still in the game.
isConnected() - Method in interface za.co.wethinkcode.robots.client.RobotWorldClient: Checks if client is connected to server
isConnected() - Method in class za.co.wethinkcode.robots.client.RobotWorldJsonClient
isEmpty() - Method in class za.co.wethinkcode.robots.server.world.Obstacles
isObstacleAt(int, int) - Method in class za.co.wethinkcode.robots.server.world.World
isObstacleAt(int, int) - Method in class za.co.wethinkcode.robots.server.world.WorldMap
isValid() - Method in class za.co.wethinkcode.robots.client.InputParser: Returns true if the command is valid and ready to send
isValidPosition(Position) - Method in class za.co.wethinkcode.robots.server.world.World
isValidPosition(Position) - Method in class za.co.wethinkcode.robots.server.world.WorldMap: A position is valid for a robot to occupy if it is within the bounds of the world, is not a wall, is not an obstacle, and is not already occupied by another robot.
isWall(int, int) - Method in class za.co.wethinkcode.robots.server.world.MazeGenerator
isWallAt(int, int) - Method in class za.co.wethinkcode.robots.server.world.World
isWallAt(int, int) - Method in class za.co.wethinkcode.robots.server.world.WorldMap: A position out of bounds counts as a wall so that callers don't need to separately bounds-check before asking about walls.
iterator() - Method in class za.co.wethinkcode.robots.server.world.Obstacles

J

JUGGERNAUT - Enum constant in enum class za.co.wethinkcode.robots.server.robots.RobotKind: Juggernaut the Tank bot.

L

launch - Enum constant in enum class za.co.wethinkcode.robots.server.commands.ImplementedClientCommands
LaunchCommand - Class in za.co.wethinkcode.robots.server.commands.external: Standard Launch command.
LaunchCommand(JsonObject, ClientID) - Constructor for class za.co.wethinkcode.robots.server.commands.external.LaunchCommand: Overload command constructor
LaunchCommand(String, String, int, int) - Constructor for class za.co.wethinkcode.robots.server.commands.external.LaunchCommand: Legacy constructor of the Launch Command
LaunchCommand(String, RobotKind) - Constructor for class za.co.wethinkcode.robots.server.commands.external.LaunchCommand: Standard Constructor of the launch command
loadConfig(String) - Static method in class za.co.wethinkcode.robots.server.config.ConfigLoader
loadObstaclesFromPattern(int) - Method in class za.co.wethinkcode.robots.server.world.Obstacles
logWorldCreation(World) - Static method in class za.co.wethinkcode.robots.server.rendering.ServerRenderer: Log the specs of a world when it is created, printing out its specifications, as well as a picture to the server admin console
look - Enum constant in enum class za.co.wethinkcode.robots.server.commands.ImplementedClientCommands
LookCommand - Class in za.co.wethinkcode.robots.server.commands.external: The Look command class.
LookCommand(JsonObject) - Constructor for class za.co.wethinkcode.robots.server.commands.external.LookCommand: Construct a look command from incoming json
LookCommand(String) - Constructor for class za.co.wethinkcode.robots.server.commands.external.LookCommand: Standard constructor for the look command.
lookObjectDistance(String) - Static method in class za.co.wethinkcode.robots.server.commands.external.LookCommand: Deprecated.
lookObjectType(String) - Static method in class za.co.wethinkcode.robots.server.commands.external.LookCommand: Deprecated.

M

main(String[]) - Static method in class za.co.wethinkcode.robots.client.Client
main(String[]) - Static method in class za.co.wethinkcode.robots.server.Server: The main method of the Server class.
Maze - Class in za.co.wethinkcode.robots.server.world: The maze class serves an abstracted representation of a maze as generated by MazeGenerator
Maze(List<List<Integer>>) - Constructor for class za.co.wethinkcode.robots.server.world.Maze: Deprecated, for removal: This API element is subject to removal in a future version.
MazeGenerator - Class in za.co.wethinkcode.robots.server.world
MazeGenerator(int, int) - Constructor for class za.co.wethinkcode.robots.server.world.MazeGenerator
MazeGenerator(int, int, int) - Constructor for class za.co.wethinkcode.robots.server.world.MazeGenerator
mazeType - Variable in class za.co.wethinkcode.robots.server.config.ServerOptions
Memory - Class in za.co.wethinkcode.robots.client: This class stores the memory of the currently running client The currently selected robot as well as all the robots launched
Memory() - Constructor for class za.co.wethinkcode.robots.client.Memory
MINIMUM_MAZE_SIZE - Static variable in class za.co.wethinkcode.robots.server.config.WorldConfig: The minimum size of a maze in the world.
MissingWorldObjectException - Exception Class in za.co.wethinkcode.robots.errors: This message is thrown when a WorldObject to be found but for whatever reason, is not.
MissingWorldObjectException(String) - Constructor for exception class za.co.wethinkcode.robots.errors.MissingWorldObjectException: This message is thrown when a WorldObject to be found but for whatever reason, is not.

N

namedIpAddress() - Method in class za.co.wethinkcode.robots.cli.ConnectionOptions
newRobotConnectionReceivedCopy() - Static method in class za.co.wethinkcode.robots.server.rendering.ServerRenderer: Immediately renders the copy for a new robot connection being received.
newServer(String[]) - Static method in class za.co.wethinkcode.robots.server.Server: Static style configuration stage for setting up a server.
NORMAL - Enum constant in enum class za.co.wethinkcode.robots.server.robots.Status: A normal robot can do anything it wants
NORTH - Enum constant in enum class za.co.wethinkcode.robots.server.world.Direction

O

Obstacles - Class in za.co.wethinkcode.robots.server.world
Obstacles(Position, Position) - Constructor for class za.co.wethinkcode.robots.server.world.Obstacles
ok(JsonObject) - Static method in class za.co.wethinkcode.robots.api.ServerAPI: Take in a JsonObject and return and OK message as a String
optionIpAddress - Variable in class za.co.wethinkcode.robots.server.config.ServerOptions

P

parse(String[]) - Method in class za.co.wethinkcode.robots.cli.CliParser
parsejson(String) - Static method in class za.co.wethinkcode.robots.api.ServerAPI
port - Variable in class za.co.wethinkcode.robots.server.config.ServerOptions
port() - Method in class za.co.wethinkcode.robots.cli.ConnectionOptions
Position - Class in za.co.wethinkcode.robots.server.world
Position(int, int) - Constructor for class za.co.wethinkcode.robots.server.world.Position
positionalIpAddress - Variable in class za.co.wethinkcode.robots.server.config.ServerOptions
positionalPort - Variable in class za.co.wethinkcode.robots.server.config.ServerOptions
printMaze() - Method in class za.co.wethinkcode.robots.server.world.MazeGenerator
printWorld() - Method in class za.co.wethinkcode.robots.server.world.World: Deprecated.
printWorld(World) - Static method in class za.co.wethinkcode.robots.server.rendering.ServerRenderer

Q

quit - Enum constant in enum class za.co.wethinkcode.robots.server.commands.ImplementedClientCommands

R

rawToJson(String) - Static method in class za.co.wethinkcode.robots.api.ClientAPI: Take in the raw response from a server and format it as a JSON object
reduceShield(int) - Method in class za.co.wethinkcode.robots.server.robots.Robot: Applies shield damage — shields can never go below zero.
reduceShots(int) - Method in class za.co.wethinkcode.robots.server.robots.Robot: Reduces shots — cannot go below zero.
REGGIE - Enum constant in enum class za.co.wethinkcode.robots.server.robots.RobotKind: Reggie the default bot type.
reload - Enum constant in enum class za.co.wethinkcode.robots.server.commands.ImplementedClientCommands
RELOAD - Enum constant in enum class za.co.wethinkcode.robots.server.robots.Status: A reloading robot is waiting for its ammunition to be recharged
ReloadCommand - Class in za.co.wethinkcode.robots.server.commands.external
ReloadCommand(JsonObject) - Constructor for class za.co.wethinkcode.robots.server.commands.external.ReloadCommand: Construct a Reload Command from incoming JSON
ReloadCommand(String) - Constructor for class za.co.wethinkcode.robots.server.commands.external.ReloadCommand
reloadShots() - Method in class za.co.wethinkcode.robots.server.robots.Robot: Reloads weapon back to maximum after reload time is complete.
removeAllRobots() - Method in class za.co.wethinkcode.robots.server.world.World
removeRobot(String) - Method in class za.co.wethinkcode.robots.server.world.World
renderAnInternalDebugMessage(JsonObject) - Static method in class za.co.wethinkcode.robots.server.rendering.ServerRenderer: Overload of internal Debug Message to take in a JSON object
renderAnInternalDebugMessage(String) - Static method in class za.co.wethinkcode.robots.server.rendering.ServerRenderer: Take in a debug message that does not break the program but the server operator should be aware of
renderAnInternalErrorMessage(Exception) - Static method in class za.co.wethinkcode.robots.server.rendering.ServerRenderer
renderAnInternalErrorMessage(String) - Static method in class za.co.wethinkcode.robots.server.rendering.ServerRenderer: Take in an error that does not break the program but the server operator should be aware of
renderMessage(String) - Static method in class za.co.wethinkcode.robots.server.rendering.ServerRenderer: Take in a message render it to the screen
renderMessage(String, ServerRenderer.Colour) - Static method in class za.co.wethinkcode.robots.server.rendering.ServerRenderer: Take in a message and render it in the given colour
repair - Enum constant in enum class za.co.wethinkcode.robots.server.commands.ImplementedClientCommands
REPAIR - Enum constant in enum class za.co.wethinkcode.robots.server.robots.Status: A repairing robot is waiting for its shields to go back online
RepairCommand - Class in za.co.wethinkcode.robots.server.commands.external: The Repair Command restores a robot's shield to their configured maximum.
RepairCommand(JsonObject) - Constructor for class za.co.wethinkcode.robots.server.commands.external.RepairCommand: Construct a repair command from incoming Parsed JSON
RepairCommand(String) - Constructor for class za.co.wethinkcode.robots.server.commands.external.RepairCommand
repairShields() - Method in class za.co.wethinkcode.robots.server.robots.Robot: Restores shields to maximum after repair time is complete.
resolveIpAddress(String) - Method in class za.co.wethinkcode.robots.server.config.WorldConfig
Robot - Class in za.co.wethinkcode.robots.server.robots: Represents a robot in the Robot World game.
Robot(String) - Constructor for class za.co.wethinkcode.robots.server.robots.Robot: Quick constructor for testing — uses default values.
Robot(String, String, int, int) - Constructor for class za.co.wethinkcode.robots.server.robots.Robot: Main constructor used when a player launches into the world.
Robot(String, RobotKind) - Constructor for class za.co.wethinkcode.robots.server.robots.Robot: Robot Constructor based on type.
RobotCannotActException - Exception Class in za.co.wethinkcode.robots.errors: This exception encapsulates the behaviour of a Robot who cannot act, typically due to a mismatched Status such as Status.DEAD
RobotCannotActException() - Constructor for exception class za.co.wethinkcode.robots.errors.RobotCannotActException
RobotCannotActException(String) - Constructor for exception class za.co.wethinkcode.robots.errors.RobotCannotActException: Constructor for a RobotCannotActException for an unclear reason
RobotCannotActException(Status, Robot, World) - Constructor for exception class za.co.wethinkcode.robots.errors.RobotCannotActException: Take in the failing Status Robot and World.
RobotKind - Enum Class in za.co.wethinkcode.robots.server.robots: The Robot Kind Enum encapsulates all the different possible types of robot we can expect to encounter
RobotsCommand - Class in za.co.wethinkcode.robots.server.commands.internal
RobotsCommand() - Constructor for class za.co.wethinkcode.robots.server.commands.internal.RobotsCommand
RobotWorldClient - Interface in za.co.wethinkcode.robots.client: A basic interface that wraps the expected Robot Worlds API so that we can easily connect to and send requests to the server.
RobotWorldJsonClient - Class in za.co.wethinkcode.robots.client
RobotWorldJsonClient() - Constructor for class za.co.wethinkcode.robots.client.RobotWorldJsonClient
RobotWorldMap - Class in za.co.wethinkcode.robots.server.world: The Robot World Map encapsulates all the behaviour of the locations of objects in the world
RobotWorldMap(int, int) - Constructor for class za.co.wethinkcode.robots.server.world.RobotWorldMap: Standard constructor for the Robot World Map
run() - Method in class za.co.wethinkcode.robots.client.ClientHandler
run() - Method in class za.co.wethinkcode.robots.server.commands.internal.ServerCommands
run() - Method in class za.co.wethinkcode.robots.server.SingleThreadConnection

S

saveObstaclesToFile(String) - Method in class za.co.wethinkcode.robots.server.world.MazeGenerator
send(JsonObject) - Method in class za.co.wethinkcode.robots.server.networking.ServerOutput: The send message is the final state of validation that the message being sent over the network adheres to the Robot World API spec
send(String) - Method in class za.co.wethinkcode.robots.server.networking.ServerOutput: A raw string being sent over the network.
sendRequest(String) - Method in interface za.co.wethinkcode.robots.client.RobotWorldClient: Sends a request presented by the Json object to the server
sendRequest(String) - Method in class za.co.wethinkcode.robots.client.RobotWorldJsonClient
sendRequestAsString(String) - Method in interface za.co.wethinkcode.robots.client.RobotWorldClient
sendRequestAsString(String) - Method in class za.co.wethinkcode.robots.client.RobotWorldJsonClient
Server - Class in za.co.wethinkcode.robots.server: Represents the Robot World server.
Server(WorldConfig, World, String) - Constructor for class za.co.wethinkcode.robots.server.Server: The standard constructor of a new Server
ServerAPI - Class in za.co.wethinkcode.robots.api: The Server API class encapsulates all behaviour related to outputting Command Results to the Client
ServerAPI() - Constructor for class za.co.wethinkcode.robots.api.ServerAPI
ServerCommands - Class in za.co.wethinkcode.robots.server.commands.internal
ServerCommands(World) - Constructor for class za.co.wethinkcode.robots.server.commands.internal.ServerCommands
ServerInitilisationError - Exception Class in za.co.wethinkcode.robots.errors: This error is thrown when there is an issue initialising the server for whatever reason.
ServerInitilisationError(String) - Constructor for exception class za.co.wethinkcode.robots.errors.ServerInitilisationError
ServerOptions - Class in za.co.wethinkcode.robots.server.config: Picocli parses startup options into this class before the server starts.
ServerOptions() - Constructor for class za.co.wethinkcode.robots.server.config.ServerOptions
ServerOutput - Class in za.co.wethinkcode.robots.server.networking: The Server Output Class is solely responsible for the networking component of the server output
ServerOutput(Socket) - Constructor for class za.co.wethinkcode.robots.server.networking.ServerOutput: Standard Constructor for the server Output Object
ServerQuitCommand - Class in za.co.wethinkcode.robots.server.commands.internal
ServerQuitCommand() - Constructor for class za.co.wethinkcode.robots.server.commands.internal.ServerQuitCommand
ServerRenderer - Class in za.co.wethinkcode.robots.server.rendering: This class encapsulates all rendering behavior on the server side
ServerRenderer() - Constructor for class za.co.wethinkcode.robots.server.rendering.ServerRenderer
ServerRenderer.Colour - Enum Class in za.co.wethinkcode.robots.server.rendering: Nested Enum of ansi escape characters to make rendering more discoverable
setCurrentRobot(String) - Method in class za.co.wethinkcode.robots.client.Memory
setCurrentRobot(ClientRobot) - Method in class za.co.wethinkcode.robots.client.Memory
setCurrentShots(int) - Method in class za.co.wethinkcode.robots.server.robots.Robot: Directly sets shot count — used by server when needed.
setIpAddress(String) - Method in class za.co.wethinkcode.robots.server.config.WorldConfig
setLastReloaded() - Method in class za.co.wethinkcode.robots.server.robots.Robot: Set the current instant as the last time that this robot reloaded
setLastRepaired() - Method in class za.co.wethinkcode.robots.server.robots.Robot: Set the current instant as the last time that the robot was repaired
setMazeType(int) - Method in class za.co.wethinkcode.robots.server.config.WorldConfig
setPort(int) - Method in class za.co.wethinkcode.robots.server.config.WorldConfig
setPosition(Position) - Method in class za.co.wethinkcode.robots.server.robots.Robot
setRepairTime(int) - Method in class za.co.wethinkcode.robots.server.world.World
setShields(int) - Method in class za.co.wethinkcode.robots.server.robots.Robot: Sets the maximum shields allowed by the world configuration, and spawns the robot with full health.
setStatus(Status) - Method in class za.co.wethinkcode.robots.server.robots.Robot
setWorldSize(int) - Method in class za.co.wethinkcode.robots.server.config.WorldConfig
SingleThreadConnection - Class in za.co.wethinkcode.robots.server: The Single Thread Connection encapsulates an ongoing connection between a client and a server
SingleThreadConnection(World, ConnectedClient) - Constructor for class za.co.wethinkcode.robots.server.SingleThreadConnection
size() - Method in class za.co.wethinkcode.robots.server.world.Obstacles
sleepForReload(int) - Method in class za.co.wethinkcode.robots.server.commands.external.ReloadCommand
sleepForRepair(int) - Method in class za.co.wethinkcode.robots.server.commands.external.RepairCommand
source() - Method in record class za.co.wethinkcode.robots.server.networking.ClientID: Returns the value of the source record component.
SOUTH - Enum constant in enum class za.co.wethinkcode.robots.server.world.Direction
state - Enum constant in enum class za.co.wethinkcode.robots.server.commands.ImplementedClientCommands
StateCommand - Class in za.co.wethinkcode.robots.server.commands.external
StateCommand(JsonObject) - Constructor for class za.co.wethinkcode.robots.server.commands.external.StateCommand: Construct a state command from incoming Json
StateCommand(String) - Constructor for class za.co.wethinkcode.robots.server.commands.external.StateCommand
Stateful - Interface in za.co.wethinkcode.robots.server.commands: Commands that implement the stateful interface manipulate the state of the world and the robots in it
Status - Enum Class in za.co.wethinkcode.robots.server.robots: This enum encapsulates the valid states that a robot can be in
statusSync(World) - Method in class za.co.wethinkcode.robots.server.robots.Robot: Take in the world as it is, and sync the Status of the robot internally.

T

takeDamage(int) - Method in class za.co.wethinkcode.robots.server.robots.Robot: Deals damage to shields.
toJson() - Method in class za.co.wethinkcode.robots.server.world.Position: Return a position as a JSON array
toString() - Method in record class za.co.wethinkcode.robots.server.networking.ClientID: Returns a string representation of this record class.
toString() - Method in class za.co.wethinkcode.robots.server.robots.Robot: Shows full robot state — used by dump and robots server commands.
toString() - Method in class za.co.wethinkcode.robots.server.world.Position
turn - Enum constant in enum class za.co.wethinkcode.robots.server.commands.ImplementedClientCommands
TurnCommand - Class in za.co.wethinkcode.robots.server.commands.external
TurnCommand(JsonObject) - Constructor for class za.co.wethinkcode.robots.server.commands.external.TurnCommand
TurnCommand(String, String) - Constructor for class za.co.wethinkcode.robots.server.commands.external.TurnCommand
turnLeft() - Method in class za.co.wethinkcode.robots.server.robots.Robot: Rotates 90 degrees left — NORTH becomes WEST, WEST becomes SOUTH, etc.
turnLeft() - Method in enum class za.co.wethinkcode.robots.server.world.Direction
turnRight() - Method in class za.co.wethinkcode.robots.server.robots.Robot: Rotates 90 degrees right — NORTH becomes EAST, EAST becomes SOUTH, etc.
turnRight() - Method in enum class za.co.wethinkcode.robots.server.world.Direction

U

UnsupportedRobotWorldCommand - Exception Class in za.co.wethinkcode.robots.errors: Internal Error for Unsupported Robot World Command
UnsupportedRobotWorldCommand() - Constructor for exception class za.co.wethinkcode.robots.errors.UnsupportedRobotWorldCommand
UnsupportedRobotWorldCommand(String) - Constructor for exception class za.co.wethinkcode.robots.errors.UnsupportedRobotWorldCommand

V

valueOf(String) - Static method in enum class za.co.wethinkcode.robots.server.commands.ImplementedClientCommands: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class za.co.wethinkcode.robots.server.rendering.ServerRenderer.Colour: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class za.co.wethinkcode.robots.server.robots.RobotKind: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class za.co.wethinkcode.robots.server.robots.Status: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class za.co.wethinkcode.robots.server.world.Direction: Returns the enum constant of this class with the specified name.
values() - Static method in enum class za.co.wethinkcode.robots.server.commands.ImplementedClientCommands: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class za.co.wethinkcode.robots.server.rendering.ServerRenderer.Colour: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class za.co.wethinkcode.robots.server.robots.RobotKind: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class za.co.wethinkcode.robots.server.robots.Status: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class za.co.wethinkcode.robots.server.world.Direction: Returns an array containing the constants of this enum class, in the order they are declared.
verify(World) - Method in interface za.co.wethinkcode.robots.server.commands.Stateful: Verify if a command is able to be executed given the current state of the robot.

W

WEST - Enum constant in enum class za.co.wethinkcode.robots.server.world.Direction
WHISPER - Enum constant in enum class za.co.wethinkcode.robots.server.robots.RobotKind: Whisper the sniper bot.
world - Enum constant in enum class za.co.wethinkcode.robots.server.commands.ImplementedClientCommands
World - Class in za.co.wethinkcode.robots.server.world: The World Class stores all known information about the world World-level configuration: how many seconds a repair takes.
World(int, int) - Constructor for class za.co.wethinkcode.robots.server.world.World: Deprecated.
World(int, int, int, int) - Constructor for class za.co.wethinkcode.robots.server.world.World: Deprecated.
World(WorldConfig) - Constructor for class za.co.wethinkcode.robots.server.world.World
WorldCommand - Class in za.co.wethinkcode.robots.server.commands.external: The World command describes this world's configuration parameters.
WorldCommand(JsonObject) - Constructor for class za.co.wethinkcode.robots.server.commands.external.WorldCommand
WorldCommand(String) - Constructor for class za.co.wethinkcode.robots.server.commands.external.WorldCommand
WorldConfig - Class in za.co.wethinkcode.robots.server.config
WorldConfig() - Constructor for class za.co.wethinkcode.robots.server.config.WorldConfig
WorldEdge - Class in za.co.wethinkcode.robots.server.world: The internals of the edge of an existing world
WorldEdge() - Constructor for class za.co.wethinkcode.robots.server.world.WorldEdge
WorldMap - Class in za.co.wethinkcode.robots.server.world: WorldMap answers questions about a single location in the world: is it in bounds, is it a wall, is it an obstacle, is a robot standing there, and is it therefore a valid place for a robot to be.
WorldMap(int, int, MazeGenerator, List<Position>, Supplier<Collection<Robot>>) - Constructor for class za.co.wethinkcode.robots.server.world.WorldMap
WorldObject - Interface in za.co.wethinkcode.robots.server.world: Standard World Object Interface that allows polymorphic implementation of Objects in the World
worldSize - Variable in class za.co.wethinkcode.robots.server.config.ServerOptions

Z

za.co.wethinkcode.robots - package za.co.wethinkcode.robots: The Parent module of the entire Robot World Game, both server and client.
za.co.wethinkcode.robots.api - package za.co.wethinkcode.robots.api: Behaviour related to the behaviour and interactions with the robot-world api
za.co.wethinkcode.robots.cli - package za.co.wethinkcode.robots.cli
za.co.wethinkcode.robots.client - package za.co.wethinkcode.robots.client: Parent module of the client of the Robot World Game
za.co.wethinkcode.robots.errors - package za.co.wethinkcode.robots.errors: This package contains custom errors designed for implementation in the Robot World
za.co.wethinkcode.robots.server - package za.co.wethinkcode.robots.server: Parent module for the server of the Robot World game
za.co.wethinkcode.robots.server.commands - package za.co.wethinkcode.robots.server.commands: This module stores all commands executed in the Robot World Game
za.co.wethinkcode.robots.server.commands.external - package za.co.wethinkcode.robots.server.commands.external: This package represents all commands sent in from clients in the Robot World Game
za.co.wethinkcode.robots.server.commands.internal - package za.co.wethinkcode.robots.server.commands.internal: This package contains all commands that are called by the server administrator in the Robot World Game.
za.co.wethinkcode.robots.server.config - package za.co.wethinkcode.robots.server.config: Classes and submodules in this module are responsible for configuring the server
za.co.wethinkcode.robots.server.networking - package za.co.wethinkcode.robots.server.networking: Classes in this package encapsulate networking related behavior e.g.
za.co.wethinkcode.robots.server.rendering - package za.co.wethinkcode.robots.server.rendering: This module contains classes required for rendering the server UI
za.co.wethinkcode.robots.server.robots - package za.co.wethinkcode.robots.server.robots: This package contains all functionality related to the titular Robots of the Robot World Game
za.co.wethinkcode.robots.server.world - package za.co.wethinkcode.robots.server.world: Classes and submodules in this module encapsulate all functionality of the world

A B C D E F G H I J L M N O P Q R S T U V W Z
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form