Menu

Command Palette

Search for a command to run...

Navigation

HomeGetting StartedGuidesAPI ReferenceCommon ErrorsAcknowledgments

Documentation

Getting Started

Introduction

Agent

Agent Controller

Common

Direction
Location

World

World
Cell

Agent Commands

End Turn
Move
Save Surv
Sleep

Introduction

Explore the Aegis API, which provides structures, commands, and functionality for interacting with the world.

Overview

The entirety of the public API is exposed here. The following sections will help you discover the API's capabilities and components.

Common

Contains core data structures and types used across Aegis.

Direction

Enum

Enum representing different cardinal and intercardinal directions.

Location

Class

Represents a location in the world.

World

Defines the world and its cell-based structure for simulation.

World

Class

Represents a 2D grid of cells.

Cell

Class

Represents a cell in the world.

Agent Commands

Commands available for agents interacting with Aegis.

End Turn

AgentCommand

Represents a command that allows an agent to tell the server it is done with its turn.

Move

AgentCommand

Represents a command for an agent to move in a specified direction.

Save Surv

AgentCommand

Represents a command for an agent to save a survivor.

Agent

Contains the core components for agents.

AgentController

Class

An interface for controlling an agent and interacting with the Aegis system.