FOPBot/fopbot

Package-level declarations

This is the main package of the FoPBot project. It contains all the classes and functions needed to create a FoPBot environment and run it.

Types

Block

public class Block extends FieldEntity

A field entity that represents a block on a graphical user interface.

Coin

public class Coin extends FieldEntity

A field entity that represents coins on a graphical user interface.

ColorProfile

public final class ColorProfile extends Record

A color profile for drawing the world.

Direction

public enum Direction

Defines the (viewing) direction that an entity can have.

Field

public class Field

A single field in a 2D world where field entities can be placed.

FieldClickEvent

public final class FieldClickEvent

A FieldClickEvent represents a click on a field.

FieldClickListener

public interface FieldClickListener implements EventListener

A FieldClickListener is a listener for FieldClickEvents.

FieldEntity

public abstract class FieldEntity

This class represents a field entity on a graphical user interface and acts as a parent class of every entity on the field.

FieldHoverEvent

public class FieldHoverEvent

A FieldHoverEvent represents a hover over a field.

FieldHoverListener

public interface FieldHoverListener implements EventListener

A FieldHoverListener is a listener for FieldHoverEvents.

GuiPanel

@ApiStatus.Internal()

public class GuiPanel extends JPanel

The graphical user interface in which the FoPBot world is represented.

InputHandler

public class InputHandler

The InputHandler is responsible for handling input events of the GuiPanel.

KarelWorld

public class KarelWorld

Represents the FOP Bot world on a graphical user interface.

Key

public enum Key

A constant of this enumeration represents a key registered by the InputHandler.

KeyPressEvent

public final class KeyPressEvent

A KeyPressEvent represents a key press registered by the InputHandler.

KeyPressListener

public interface KeyPressListener implements EventListener

A KeyPressListener is a listener for key press events registered by the InputHandler.

PaintUtils

public class PaintUtils

A utility class that provides useful drawing operations.

Robot

public class Robot extends FieldEntity

A field entity that represents a robot on a graphical user interface.

RobotFamily

public interface RobotFamily

An enumeration of robot families.

RobotTrace

public class RobotTrace implements Iterable<T>

Enables the analysis or tracing of the actions of robots.

SvgBasedRobotFamily

public class SvgBasedRobotFamily implements RobotFamily

A robot family that is based on SVG images.

Transition

public class Transition

Defines the transition of a robot with its associated action.

Wall

public class Wall extends FieldEntity

A field entity that represents a wall on a graphical user interface.

World

public class World

A wrapper of a KarelWorld which represents a global world.