core/de.jvstvshd.vyreka.core.map

Package-level declarations

This package contains the map representation of the library. The VyrekaMap class is a central object of the library, representing a grid of cells, identified by their x, y and z coordinates (Location object).

Types

LayeredMap

interface LayeredMap : VyrekaMap

This class represents a map in a 3-dimensional grid that contains multiple layers. Each layer is a 2-dimensional grid in which each cell has the same y-coordinate. The layers are ordered by their y-coordinate, with the first layer having the lowest y-coordinate and the last layer having the highest y-coordinate.

MapLayer

interface MapLayer

A layer of a map. A layer is a two-dimensional grid of cells which are all on the same y-level. Each cell has a location that is unique within the layer. The layer is responsible for managing the cells and providing access to them.

SimpleGridMap

open class SimpleGridMap(val width: Int, val height: Int, val depth: Int) : VyrekaMap

A simple implementation of a VyrekaMap that is used in a grid-based map.

VyrekaMap

interface VyrekaMap

A map of locations that are arranged in a 3-dimensional grid. Each location within bounds should contain a cell, except stated otherwise by an implementation. A cell can be accessed through its location. The map has a width, height and depth, which represent the x, y and z axes respectively.