MapEngine

https://mapengine.finndohrmann.de/javadoc
Admin
MapEngine is an API designed for developing applications that interact with and render maps,...
Tokens:93,884
Snippets:548
Trust Score:2.1
Update:1 year ago
Show doc for...
Tokens:
Raw
### MapEngineApi.instance Method

Source: https://mapengine.finndohrmann.de/javadoc/index-files/index-9

Utility method to get the instance of the MapEngineApi.

```APIDOC
## instance() Static Method

### Description
Utility method to get the instance of the MapEngineApi.

### Method
Static

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
* **MapEngineApi** - The instance of the MapEngineApi.
```

--------------------------------

### Javadoc Search Examples

Source: https://mapengine.finndohrmann.de/javadoc/help-doc

Demonstrates various ways to use the Javadoc search functionality to find specific API elements. The search supports partial names, camelCase abbreviations, and multiple search terms.

```javadoc
"j.l.obj"
```

```javadoc
"InpStr"
```

```javadoc
"math exact long"
```

--------------------------------

### Map Event API

Source: https://mapengine.finndohrmann.de/javadoc/index-files/index-7

Details methods for handling map events, including getting and setting handlers.

```APIDOC
## POST /api/map/event/handlers

### Description
Allows setting handlers for map events and retrieving the current list of handlers.

### Method
POST

### Endpoint
/api/map/event/handlers

#### Request Body
- **handler** (function) - The handler function to add to the map event.

### Request Example
```json
{
  "handler": "function(event) { console.log('Map event occurred:', event); }"
}
```

### Response
#### Success Response (200)
- **handlerList** (array) - A list of all currently registered handler functions.

#### Response Example
```json
{
  "handlerList": [
    "function(event) { console.log('Map event occurred:', event); }"
  ]
}
```
```

--------------------------------

### MapEngineApi - Instance

Source: https://mapengine.finndohrmann.de/javadoc/de/pianoman911/mapengine/api/MapEngineApi

Provides utility to get the instance of the MapEngineApi. It's crucial that MapEngine is enabled before calling this method.

```APIDOC
## GET /mapengine/instance

### Description
Utility method to get the instance of the MapEngineApi. You can also use `Bukkit.getServicesManager()` to get the instance.

### Method
GET

### Endpoint
/mapengine/instance

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **instance** (MapEngineApi) - The instance of the MapEngineApi.

#### Response Example
```json
{
  "instance": "MapEngineApi_instance_object"
}
```

### Throws
- `IllegalStateException` - if MapEngine is not enabled before calling this method
```

--------------------------------

### Get MapEngine API Instance (Java)

Source: https://mapengine.finndohrmann.de/javadoc/index-files/index-9

Provides a utility method to retrieve the singleton instance of the MapEngineApi. This is the entry point for interacting with the MapEngine functionality.

```Java
MapEngineApi instance()
```

--------------------------------

### Access Display Provider (Java)

Source: https://mapengine.finndohrmann.de/javadoc/de/pianoman911/mapengine/api/MapEngineApi

Gets the IDisplayProvider, responsible for creating IMapDisplay and IHoldableDisplay objects. This provider is the entry point for generating and managing map displays within the engine.

```java
IDisplayProvider displayProvider = api.displayProvider();
```

--------------------------------

### Pipeline Output Methods

Source: https://mapengine.finndohrmann.de/javadoc/de/pianoman911/mapengine/api/pipeline/IPipelineProvider

Methods for creating and managing pipeline output instances.

```APIDOC
## output

### Description
Deprecated, for removal: This API element is subject to removal in a future version.
Creates a new pipeline output instance, which flushes the buffer to the map display of the context. **WARNING: This creates a IPipelineOutput for a MapDisplay**

### Method
`default IPipelineOutput`

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
#### Success Response (200)
- `IPipelineOutput` - a new default pipeline output instance

#### Response Example
N/A
```

```APIDOC
## createMapOutput

### Description
Creates a pipeline output for `IMapDisplay`'s.

### Method
`IPipelineOutput`

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
#### Success Response (200)
- `IPipelineOutput` - a new default pipeline output instance

#### Response Example
N/A
```

```APIDOC
## createHoldableOutput

### Description
Creates a pipeline output for `IHoldableDisplay`'s.

### Method
`IPipelineOutput`

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
#### Success Response (200)
- `IPipelineOutput` - a new default pipeline output instance

#### Response Example
N/A
```

--------------------------------

### Alignment Enum Constant START

Source: https://mapengine.finndohrmann.de/javadoc/index-files/index-16

Represents the starting alignment for x and y axes.

```APIDOC
## START

### Description
Left for x-alignment, Top for y-alignment.

### Method
[METHOD_TYPE]

### Endpoint
[ENDPOINT]

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- None

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **Alignment** - The START enum constant.

#### Response Example
```json
{
  "example": "START"
}
```
```

--------------------------------

### Get Display in Player View (Deprecated) (Java)

Source: https://mapengine.finndohrmann.de/javadoc/de/pianoman911/mapengine/api/MapEngineApi

Deprecated method to get an IMapDisplay within a player's view. Use `traceDisplayInView` instead. It checks for a display within a specified maximum distance.

```java
IMapDisplay display = api.displayInView(player, maxDistance);
```

--------------------------------

### Pipeline Context API

Source: https://mapengine.finndohrmann.de/javadoc/de/pianoman911/mapengine/api/pipeline/IPipelineProvider

APIs for creating and managing pipeline contexts.

```APIDOC
## ctx (Deprecated)

### Description
Deprecated, for removal: This API element is subject to removal in a future version.
use `createCtx(IDisplay)` instead
Creates a new context instance for the provided `IMapDisplay`.
The display can be retrieved again by using `IPipelineContext.getDisplay()`.

### Method
`@Deprecated(forRemoval=true) default IPipelineContext ctx(IMapDisplay display)`

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- None

### Request Example
```json
{
  "example": "No request body for this method"
}
```

### Response
#### Success Response (200)
- **IPipelineContext** - A new pipelining context

#### Response Example
```json
{
  "example": "IPipelineContext object"
}
```
```

```APIDOC
## createCtx

### Description
Creates a new context instance for the provided `IMapDisplay`.
The display can be retrieved again by using `IPipelineContext.getDisplay()`.

### Method
`IPipelineContext createCtx(IDisplay display)`

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- None

### Request Example
```json
{
  "example": "No request body for this method"
}
```

### Response
#### Success Response (200)
- **IPipelineContext** - A new pipelining context

#### Response Example
```json
{
  "example": "IPipelineContext object"
}
```
```

--------------------------------

### Pipeline Provider Interface Methods

Source: https://mapengine.finndohrmann.de/javadoc/index-files/index-3

Methods for creating and managing pipeline contexts, drawing spaces, and outputs.

```APIDOC
## createCtx(IDisplay)

### Description
Creates a new context instance for the provided `IMapDisplay`. The display can be retrieved again by using `IPipelineContext.getDisplay()`.

### Method
Method

### Endpoint
N/A (Interface method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
Returns a new context instance.

#### Response Example
None
```

```APIDOC
## createDrawingSpace(int, int, IDisplay)

### Description
Creates a drawing space for the given context and creates a new RGB buffer with the given width and height.

### Method
Method

### Endpoint
N/A (Interface method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
Returns a drawing space.

#### Response Example
None
```

```APIDOC
## createDrawingSpace(IDisplay)

### Description
Creates a drawing space for the given map display.

### Method
Method

### Endpoint
N/A (Interface method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
Returns a drawing space.

#### Response Example
None
```

```APIDOC
## createDrawingSpace(FullSpacedColorBuffer, IDisplay)

### Description
Creates a drawing space for the given context and buffer.

### Method
Method

### Endpoint
N/A (Interface method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
Returns a drawing space.

#### Response Example
None
```

```APIDOC
## createHoldableOutput()

### Description
Creates a pipeline output for `IHoldableDisplay`'s.

### Method
Method

### Endpoint
N/A (Interface method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
Returns a pipeline output.

#### Response Example
None
```

```APIDOC
## createLayeredDrawingSpace(int, int, IDisplay)

### Description
Creates a layered drawing space for the given context and creates a new RGB buffer with the given width and height.

### Method
Method

### Endpoint
N/A (Interface method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
Returns a layered drawing space.

#### Response Example
None
```

```APIDOC
## createLayeredDrawingSpace(IDisplay)

### Description
Creates a layered drawing space for the given map display.

### Method
Method

### Endpoint
N/A (Interface method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
Returns a layered drawing space.

#### Response Example
None
```

```APIDOC
## createLayeredDrawingSpace(FullSpacedColorBuffer, IDisplay)

### Description
Creates a layered drawing space for the given context and buffer.

### Method
Method

### Endpoint
N/A (Interface method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
Returns a layered drawing space.

#### Response Example
None
```

```APIDOC
## createMapOutput()

### Description
Creates a pipeline output for `IMapDisplay`'s.

### Method
Method

### Endpoint
N/A (Interface method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
Returns a pipeline output.

#### Response Example
None
```

```APIDOC
## createPipeline(IPipelineOutput, IPipelineStream...)

### Description
Creates a new pipeline with the given output and the specified streams.

### Method
Method

### Endpoint
N/A (Interface method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
Returns a new pipeline.

#### Response Example
None
```

```APIDOC
## createPipeline(IPipelineStream...)

### Description
Creates a new pipeline with the given output and the specified streams. The initial pipeline output is created using `IPipelineProvider.output()`.

### Method
Method

### Endpoint
N/A (Interface method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
Returns a new pipeline.

#### Response Example
None
```

```APIDOC
## ctx(IMapDisplay)

### Description
Deprecated, for removal: This API element is subject to removal in a future version. Retrieves the context for the provided `IMapDisplay`.

### Method
Method

### Endpoint
N/A (Interface method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
Returns the context.

#### Response Example
None
```

--------------------------------

### Get and Set Converter for Map Colors - Java

Source: https://mapengine.finndohrmann.de/javadoc/de/pianoman911/mapengine/api/pipeline/IPipelineContext

Provides functionality to get the current Converter used for converting RGB buffers to Minecraft map colors, and to set a new Converter. The Converter can be used for dithering, such as with Converter.FLOYD_STEINBERG.

```java
Converter converter()
// A Converter is used for converting the RGB buffer to minecraft map colors.
// These can be used e.g. for applying dithering to the buffer (Converter.FLOYD_STEINBERG).
// Returns: the current Converter for this context
```

```java
void converter(Converter converter)
// Parameters:
// `converter` - the new `Converter` to be set in this context
```

--------------------------------

### Drawing Space Methods

Source: https://mapengine.finndohrmann.de/javadoc/de/pianoman911/mapengine/api/pipeline/IPipelineProvider

Methods for creating and managing drawing space instances.

```APIDOC
## drawingSpace (Deprecated)

### Description
Deprecated, for removal: This API element is subject to removal in a future version.
use `createDrawingSpace(IDisplay)` instead
Creates a drawing space for the given map display. The width and height is the total width and height of the specified map display. The context is the default for this map and is created using `ctx(IMapDisplay)`.

### Method
`default IDrawingSpace`

### Endpoint
N/A

### Parameters
- **display** (IMapDisplay) - Required - the map display used for creating the drawing space

### Request Example
N/A

### Response
#### Success Response (200)
- `IDrawingSpace` - a new drawing space used for drawing shapes

#### Response Example
N/A
```

```APIDOC
## createDrawingSpace (IDisplay)

### Description
Creates a drawing space for the given map display. The width and height is the total width and height of the specified map display. The context is the default for this map and is created using `createCtx(IDisplay)`.

### Method
`default IDrawingSpace`

### Endpoint
N/A

### Parameters
- **display** (IDisplay) - Required - the map display used for creating the drawing space

### Request Example
N/A

### Response
#### Success Response (200)
- `IDrawingSpace` - a new drawing space used for drawing shapes

#### Response Example
N/A
```

```APIDOC
## drawingSpace (Deprecated, width, height, display)

### Description
Deprecated, for removal: This API element is subject to removal in a future version.
use `createDrawingSpace(int, int, IDisplay)` instead
Creates a drawing space for the given context and creates a new rgb buffer with the given width and height.

### Method
`default IDrawingSpace`

### Endpoint
N/A

### Parameters
- **width** (int) - Required - the width for the new drawing space
- **height** (int) - Required - the height for the new drawing space
- **display** (IMapDisplay) - Required - the map display used for creating the drawing space

### Request Example
N/A

### Response
#### Success Response (200)
- `IDrawingSpace` - a new drawing space used for drawing shapes

#### Response Example
N/A
```

```APIDOC
## createDrawingSpace (width, height, display)

### Description
Creates a drawing space for the given context and creates a new rgb buffer with the given width and height.

### Method
`default IDrawingSpace`

### Endpoint
N/A

### Parameters
- **width** (int) - Required - the width for the new drawing space
- **height** (int) - Required - the height for the new drawing space
- **display** (IDisplay) - Required - the map display used for creating the drawing space

### Request Example
N/A

### Response
#### Success Response (200)
- `IDrawingSpace` - a new drawing space used for drawing shapes

#### Response Example
N/A
```

```APIDOC
## drawingSpace (Deprecated, buffer, display)

### Description
Deprecated, for removal: This API element is subject to removal in a future version.
use `createDrawingSpace(FullSpacedColorBuffer, IDisplay)` instead
Creates a drawing space for the given context and buffer.

### Method
`default IDrawingSpace`

### Endpoint
N/A

### Parameters
- **buffer** (FullSpacedColorBuffer) - Required - the buffer used for drawing
- **display** (IMapDisplay) - Required - the map display used for creating the drawing space

### Request Example
N/A

### Response
#### Success Response (200)
- `IDrawingSpace` - a new drawing space used for drawing shapes

#### Response Example
N/A
```

```APIDOC
## createDrawingSpace (buffer, display)

### Description
Creates a drawing space for the given context and buffer.

### Method
`default IDrawingSpace`

### Endpoint
N/A

### Parameters
- **buffer** (FullSpacedColorBuffer) - Required - the buffer used for drawing
- **display** (IDisplay) - Required - the map display used for creating the drawing space

### Request Example
N/A

### Response
#### Success Response (200)
- `IDrawingSpace` - a new drawing space used for drawing shapes

#### Response Example
N/A
```

```APIDOC
## drawingSpace (ctx, width, height)

### Description
Creates a drawing space for the given context and creates a new rgb buffer with the given width and height.

### Method
`default IDrawingSpace`

### Endpoint
N/A

### Parameters
- **ctx** (IPipelineContext) - Required - the context for this drawing space
- **width** (int) - Required - the width for the new drawing space
- **height** (int) - Required - the height for the new drawing space

### Request Example
N/A

### Response
#### Success Response (200)
- `IDrawingSpace` - a new drawing space used for drawing shapes

#### Response Example
N/A
```

```APIDOC
## drawingSpace (ctx, buffer)

### Description
Creates a drawing space for the given context and buffer.

### Method
`IDrawingSpace`

### Endpoint
N/A

### Parameters
- **ctx** (IPipelineContext) - Required - the context for this drawing space
- **buffer** (FullSpacedColorBuffer) - Required - the buffer used for drawing

### Request Example
N/A

### Response
#### Success Response (200)
- `IDrawingSpace` - a new drawing space used for drawing shapes

#### Response Example
N/A
```

```APIDOC
## layeredDrawingSpace (Deprecated)

### Description
Deprecated, for removal: This API element is subject to removal in a future version.
use `createLayeredDrawingSpace(IDisplay)` instead

### Method
`default ILayeredDrawingSpace`

### Endpoint
N/A

### Parameters
- **display** (IMapDisplay) - Required - The map display for which to create a layered drawing space.

### Request Example
N/A

### Response
#### Success Response (200)
- `ILayeredDrawingSpace` - A new layered drawing space.

#### Response Example
N/A
```

--------------------------------

### Pipeline Creation API

Source: https://mapengine.finndohrmann.de/javadoc/de/pianoman911/mapengine/api/pipeline/IPipelineProvider

This section details the methods for creating various pipeline-related objects, including contexts, drawing spaces, and pipelines themselves.

```APIDOC
## IPipelineProvider Interface

Manages the creation of objects related to pipelines.

### Methods

- **createCtx(IDisplay display)**
  - Description: Creates a new context instance for the provided IMapDisplay. The display can be retrieved again by using `IPipelineContext.getDisplay()`.
  - Returns: `IPipelineContext`

- **createDrawingSpace(int width, int height, IDisplay display)**
  - Description: Creates a drawing space for the given context and creates a new RGB buffer with the given width and height.
  - Returns: `IDrawingSpace`

- **createDrawingSpace(IDisplay display)**
  - Description: Creates a drawing space for the given map display.
  - Returns: `IDrawingSpace`

- **createDrawingSpace(FullSpacedColorBuffer buffer, IDisplay display)**
  - Description: Creates a drawing space for the given context and buffer.
  - Returns: `IDrawingSpace`

- **createHoldableOutput()**
  - Description: Creates a pipeline output for `IHoldableDisplay`'s.
  - Returns: `IPipelineOutput`

- **createLayeredDrawingSpace(int width, int height, IDisplay display)**
  - Description: Creates a layered drawing space for the given context and creates a new RGB buffer with the given width and height.
  - Returns: `ILayeredDrawingSpace`

- **createLayeredDrawingSpace(IDisplay display)**
  - Description: Creates a layered drawing space for the given map display.
  - Returns: `ILayeredDrawingSpace`

- **createLayeredDrawingSpace(FullSpacedColorBuffer buffer, IDisplay display)**
  - Description: Creates a layered drawing space for the given context and buffer.
  - Returns: `ILayeredDrawingSpace`

- **createMapOutput()**
  - Description: Creates a pipeline output for `IMapDisplay`'s.
  - Returns: `IPipelineOutput`

- **createPipeline(IPipelineOutput output, IPipelineStream... streams)**
  - Description: Creates a new pipeline with the given output and the specified streams.
  - Parameters:
    - `output` (IPipelineOutput) - The pipeline output.
    - `streams` (IPipelineStream...) - The initial streams to be set on the pipeline.
  - Returns: `IPipeline`

- **createPipeline(IPipelineStream... streams)**
  - Description: Creates a new pipeline with the given output and the specified streams. The initial pipeline output is created using `output()`.
  - WARNING: This Pipeline can only be used with a `IMapDisplay`.
  - Parameters:
    - `streams` (IPipelineStream...) - The initial streams to be set on the pipeline.
  - Returns: `IPipeline`

### Deprecated Methods (Use `create` equivalents)

- **ctx(IMapDisplay display)**
- **drawingSpace(int width, int height, IMapDisplay display)**
- **drawingSpace(IMapDisplay display)**
- **drawingSpace(IPipelineContext ctx, int width, int height)**
- **drawingSpace(IPipelineContext ctx, FullSpacedColorBuffer buffer)**
- **drawingSpace(FullSpacedColorBuffer buffer, IMapDisplay display)**
- **layeredDrawingSpace(int width, int height, IMapDisplay display)**
- **layeredDrawingSpace(IMapDisplay display)**
- **layeredDrawingSpace(IPipelineContext ctx, int width, int height)**
- **layeredDrawingSpace(IPipelineContext ctx, FullSpacedColorBuffer buffer)**
- **layeredDrawingSpace(FullSpacedColorBuffer buffer, IMapDisplay display)**
- **output()**
```

--------------------------------

### Get Result Buffer

Source: https://mapengine.finndohrmann.de/javadoc/de/pianoman911/mapengine/api/drawing/ILayeredDrawingSpace

Retrieves the result buffer of the ILayeredDrawingSpace.

```APIDOC
## GET /resultBuffer

### Description
Retrieves the result buffer of the ILayeredDrawingSpace.

### Method
GET

### Endpoint
`/resultBuffer`

### Parameters
None

### Request Body
None

### Response
#### Success Response (200)
- **resultBuffer** (FullSpacedColorBuffer) - The result buffer of the drawing space.

#### Response Example
```json
{
  "resultBuffer": { /* FullSpacedColorBuffer object */ }
}
```
```

--------------------------------

### Alignment API

Source: https://mapengine.finndohrmann.de/javadoc/index-files/index-7

Provides methods to get alignment offsets.

```APIDOC
## GET /api/alignment/offset

### Description
Retrieves the offset for a given alignment integer.

### Method
GET

### Endpoint
/api/alignment/offset

#### Query Parameters
- **alignmentInt** (integer) - Required - The integer representing the alignment.

### Request Example
```
/api/alignment/offset?alignmentInt=1
```

### Response
#### Success Response (200)
- **offset** (integer) - The calculated offset value.

#### Response Example
```json
{
  "offset": 10
}
```
```

--------------------------------

### Client-Side Display Interfaces

Source: https://mapengine.finndohrmann.de/javadoc/de/pianoman911/mapengine/api/clientside/package-tree

Documentation for interfaces related to displaying map information on the client-side.

```APIDOC
## Interface Hierarchy: Client-Side Display

### Description
This section details the hierarchy of interfaces related to client-side map display functionalities.

### Interfaces

#### `de.pianoman911.mapengine.api.clientside.IDisplay`

- **Description**: Base interface for displayable elements.

#### `de.pianoman911.mapengine.api.clientside.IHoldableDisplay`

- **Description**: Interface for displayable elements that can be held or managed.
- **Extends**: `de.pianoman911.mapengine.api.clientside.IMap`, `de.pianoman911.mapengine.api.clientside.IDisplay`

#### `de.pianoman911.mapengine.api.clientside.IMapDisplay`

- **Description**: Interface for displaying map content.
- **Extends**: `de.pianoman911.mapengine.api.clientside.IDisplay`

#### `de.pianoman911.mapengine.api.clientside.IDisplayProvider`

- **Description**: Interface for providing display elements.

#### `de.pianoman911.mapengine.api.clientside.IMap`

- **Description**: Base interface for map functionalities.

#### `de.pianoman911.mapengine.api.clientside.IFrame`

- **Description**: Interface representing a frame within the map context.
- **Extends**: `de.pianoman911.mapengine.api.clientside.IMap`
```

--------------------------------

### Get Drawing Context

Source: https://mapengine.finndohrmann.de/javadoc/de/pianoman911/mapengine/api/drawing/ILayeredDrawingSpace

Retrieves the drawing context associated with the ILayeredDrawingSpace.

```APIDOC
## GET /ctx

### Description
Retrieves the drawing context associated with the ILayeredDrawingSpace.

### Method
GET

### Endpoint
`/ctx`

### Parameters
None

### Request Body
None

### Response
#### Success Response (200)
- **ctx** (IPipelineContext) - The context in which everything is drawn.

#### Response Example
```json
{
  "ctx": { /* IPipelineContext object */ }
}
```
```

--------------------------------

### JavaDoc Navigation and Search

Source: https://mapengine.finndohrmann.de/javadoc/help-doc

Explains how to navigate through the JavaDoc documentation using links, search, and outlines the different types of pages available.

```APIDOC
## JavaDoc Navigation and Search

### Description
This section details how to navigate the JavaDoc-generated API documentation and utilize its search functionality. It covers the different types of pages available and how to access them.

### Navigation
- Use links on each page and in the navigation bar at the top.
- Access the Index and Search box for specific declarations and summary pages.

### Search Features
- Search for modules, packages, types, fields, methods, system properties.
- Use part or all of the name, "camelCase" abbreviations, or multiple terms separated by whitespace.
- Examples:
  - `"j.l.obj"` matches `java.lang.Object`
  - `"InpStr"` matches `java.io.InputStream`
  - `"math exact long"` matches `java.lang.Math.absExact(long)`
- Refer to the Javadoc Search Specification for full details.

### Kinds of Pages
- **Overview**: Front page, lists all packages with summaries and an overall description.
- **Package**: Lists classes and interfaces within a package, with summaries.
- **Class or Interface**: Contains declaration, description, member summaries, and detailed member descriptions for a specific class or interface.
- **Other Files**: Additional information related to declarations within packages or modules.
- **Tree (Class Hierarchy)**: Displays the inheritance structure of classes and interfaces.
- **Deprecated API**: Lists all deprecated API with recommended replacements.
- **Constant Field Values**: Lists static final fields and their values.
- **All Packages**: An alphabetic index of all packages.
- **All Classes and Interfaces**: An alphabetic index of all classes and interfaces.
- **Index**: An alphabetic index of all elements (classes, interfaces, constructors, methods, fields).
```

--------------------------------

### IMapDisplay.interactDistance Methods

Source: https://mapengine.finndohrmann.de/javadoc/index-files/index-9

Gets or sets the distance at which the player can interact with the map display.

```APIDOC
## interactDistance() Method

### Description
Gets the distance at which the player can interact with the map display. The default distance is at 6 blocks.

### Method
GET

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
* **double** - The interaction distance.
```

```APIDOC
## interactDistance(double) Method

### Description
Sets the distance at which the player can interact with the map display. The default distance is at 6 blocks.

### Method
SET

### Endpoint
N/A

### Parameters
* **distance** (double) - The desired interaction distance.

### Request Example
N/A

### Response
N/A
```

--------------------------------

### FullSpacedColorBuffer Constructors

Source: https://mapengine.finndohrmann.de/javadoc/de/pianoman911/mapengine/api/util/FullSpacedColorBuffer

Provides details on how to instantiate a FullSpacedColorBuffer object.

```APIDOC
## Constructors

### FullSpacedColorBuffer(int[] data, int width, int height)

Wraps the given argb data into a color buffer.

### FullSpacedColorBuffer(int width, int height)

Creates a new color buffer with the given width and height.

### FullSpacedColorBuffer(int size, int width, int height)

Deprecated. Should not be used for creation, use `FullSpacedColorBuffer(int, int)` instead.
```

--------------------------------

### Create Basic Map Display with Default Pipeline (Java)

Source: https://mapengine.finndohrmann.de/javadoc/de/pianoman911/mapengine/api/clientside/IDisplayProvider

Creates a basic map display using a default pipeline. This method requires two block vector points defining a 2D box and a direction for interaction and map facing. It returns a new map display instance.

```Java
default IMapDisplay createBasic(org.bukkit.util.BlockVector a, org.bukkit.util.BlockVector b, org.bukkit.block.BlockFace direction)
IMapDisplay createBasic(org.bukkit.util.BlockVector a, org.bukkit.util.BlockVector b, org.bukkit.block.BlockFace direction, org.bukkit.block.BlockFace visualDirection)
```

--------------------------------

### Get Layer by Index

Source: https://mapengine.finndohrmann.de/javadoc/de/pianoman911/mapengine/api/drawing/ILayeredDrawingSpace

Retrieves a specific layer from the ILayeredDrawingSpace using its index.

```APIDOC
## GET /layers/{index}

### Description
Retrieves a specific layer from the ILayeredDrawingSpace using its index.

### Method
GET

### Endpoint
`/layers/{index}`

### Parameters
#### Path Parameters
- **index** (int) - Required - The index of the wanted layer.

### Request Body
None

### Response
#### Success Response (200)
- **layer** (IDrawingSpace) - The drawing space (layer) with the given index.

#### Response Example
```json
{
  "layer": { /* IDrawingSpace object */ }
}
```

#### Error Response (400)
- **message** (string) - "IndexOutOfBoundsException: if the index is invalid."
```

--------------------------------

### Get All Layers

Source: https://mapengine.finndohrmann.de/javadoc/de/pianoman911/mapengine/api/drawing/ILayeredDrawingSpace

Retrieves a list of all drawing spaces (layers) within the ILayeredDrawingSpace.

```APIDOC
## GET /layers

### Description
Retrieves a list of all drawing spaces (layers) within the ILayeredDrawingSpace.

### Method
GET

### Endpoint
`/layers`

### Parameters
None

### Request Body
None

### Response
#### Success Response (200)
- **layers** (List<IDrawingSpace>) - A list containing all the drawing spaces (layers).

#### Response Example
```json
{
  "layers": [
    { /* IDrawingSpace object */ },
    { /* IDrawingSpace object */ }
  ]
}
```
```

--------------------------------

### Pipeline Context Creation

Source: https://mapengine.finndohrmann.de/javadoc/index-files/index-3

Provides guidance on creating a pipeline context using `IPipelineProvider.createCtx(IDisplay)`.

```APIDOC
## Pipeline Context Creation

### Description
Use `IPipelineProvider.createCtx(IDisplay)` to create a new pipeline context.

### Method
(Not specified, likely a static or factory method)

### Endpoint
(Not applicable, this is a library/SDK method)

### Parameters
#### Path Parameters
(None)

#### Query Parameters
(None)

#### Request Body
(None)

### Request Example
```java
// Example usage (assuming IDisplay is defined elsewhere)
// IDisplay display = ...;
// IPipelineContext context = IPipelineProvider.createCtx(display);
```

### Response
#### Success Response (200)
(Not applicable, this is a method call)

#### Response Example
(Not applicable)
```

--------------------------------

### MapClickEvent - passthroughMode()

Source: https://mapengine.finndohrmann.de/javadoc/index-files/index-14

Sets or gets the passthrough mode for the MapClickEvent, used for filtering packets.

```APIDOC
## MapClickEvent - passthroughMode()

### Description
Used for filtering the `PassthroughMode` of the packets which triggered this event.

### Method
`passthroughMode(PassthroughMode mode)`

### Endpoint
N/A (Method within a class)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "example": "N/A"
}
```

### Response
#### Success Response (200)
N/A (Method return type depends on implementation)

#### Response Example
```json
{
  "example": "N/A"
}
```
```

--------------------------------

### ColorBuffer and FullSpacedColorBuffer Size Methods

Source: https://mapengine.finndohrmann.de/javadoc/index-files/index-16

Provides methods to get the size of ColorBuffer and FullSpacedColorBuffer instances.

```APIDOC
## size()

### Description
Returns the size of the color buffer.

### Method
[METHOD_TYPE]

### Endpoint
[ENDPOINT]

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- None

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **int** - The size of the color buffer.

#### Response Example
```json
{
  "example": "[SIZE_INTEGER]"
}
```
```

--------------------------------

### Create Display Provider Methods (Java)

Source: https://mapengine.finndohrmann.de/javadoc/index-files/index-3

Provides methods for creating various display-related objects, including basic 2D boxes, holdable displays, and raw pipeline displays. These methods are crucial for initializing visual elements within the MapEngine.

```java
/**
 * The a and b points should build a 2d box.
 * @param a The first corner of the box.
 * @param b The second corner of the box.
 * @param face The face of the block.
 * @return An IDisplayProvider instance.
 */
IDisplayProvider createBasic(BlockVector a, BlockVector b, BlockFace face)
```

```java
/**
 * The a and b points should build a 2d box.
 * @param a The first corner of the box.
 * @param b The second corner of the box.
 * @param face1 The first face.
 * @param face2 The second face.
 * @return An IDisplayProvider instance.
 */
IDisplayProvider createBasic(BlockVector a, BlockVector b, BlockFace face1, BlockFace face2)
```

```java
/**
 * Creates a holdable display.
 * @return An IDisplayProvider instance.
 */
IDisplayProvider createHoldableDisplay()
```

```java
/**
 * Creates a raw pipeline display.
 * @param a The first corner.
 * @param b The second corner.
 * @param face The face.
 * @param pipeline The pipeline to use.
 * @return An IDisplayProvider instance.
 */
IDisplayProvider createRawPipelineDisplay(BlockVector a, BlockVector b, BlockFace face, IPipeline pipeline)
```

```java
/**
 * Creates a raw pipeline display.
 * @param a The first corner.
 * @param b The second corner.
 * @param face1 The first face.
 * @param face2 The second face.
 * @param pipeline The pipeline to use.
 * @return An IDisplayProvider instance.
 */
IDisplayProvider createRawPipelineDisplay(BlockVector a, BlockVector b, BlockFace face1, BlockFace face2, IPipeline pipeline)
```

```java
/**
 * Creates a raw pipeline holdable display.
 * @param pipeline The pipeline to use.
 * @return An IDisplayProvider instance.
 */
IDisplayProvider createRawPipelineHoldableDisplay(IPipeline pipeline)
```

--------------------------------

### Get Pipeline Streams (Java)

Source: https://mapengine.finndohrmann.de/javadoc/index-files/index-16

Retrieves streams that are executed in order when flushed. This is part of the IPipeline interface.

```java
public java.util.stream.Stream<?> streams()
```

--------------------------------

### Vec2i Constructor and Factory Method - Java

Source: https://mapengine.finndohrmann.de/javadoc/de/pianoman911/mapengine/api/util/Vec2i

Shows the primary constructor for creating Vec2i instances and a static factory method 'of' for convenient instantiation. These are essential for initializing and creating Vec2i objects.

```java
public Vec2i(int x, int y)

public static Vec2i of(int x, int y)
```

--------------------------------

### IDisplay Interface Methods

Source: https://mapengine.finndohrmann.de/javadoc/index-files/index-4

Methods for managing display resources.

```APIDOC
## destroy() IDisplay

### Description
Destroys the display and internal related resources. **WARNING: This method should be called when the display is no longer needed.**

### Method
Method

### Endpoint
N/A (Interface Method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (void)
This method does not return a value.

#### Response Example
None
```

--------------------------------

### MapClickEvent Class Method

Source: https://mapengine.finndohrmann.de/javadoc/index-files/index-1

Method to get the 2D integer vector representation of the click event.

```APIDOC
## MapClickEvent Method

### Description
Method to get the 2D integer vector representation of the click event.

### asVec2i()

#### Description
Returns the click event coordinates as a 2D integer vector.

#### Method
GET

#### Endpoint
`/websites/mapengine_finndohrmann_de/api/event/click/asVec2i`

#### Parameters
None

### Response
#### Success Response (200)
- **vector** (Vec2i) - The 2D integer vector representation of the click.

#### Response Example
```json
{
  "vector": {
    "x": 10,
    "y": 20
  }
}
```
```

--------------------------------

### Interface: IPipelineOutput.output(FullSpacedColorBuffer, IPipelineContext)

Source: https://mapengine.finndohrmann.de/javadoc/index-files/index-13

Details on the output(FullSpacedColorBuffer, IPipelineContext) method in the IPipelineOutput interface.

```APIDOC
## IPipelineOutput.output(FullSpacedColorBuffer, IPipelineContext)

### Description
N/A

### Method
Method

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
N/A

#### Response Example
N/A
```

--------------------------------

### Get Handlers Method

Source: https://mapengine.finndohrmann.de/javadoc/index-files/index-7

Retrieves the handlers associated with a MapEvent instance. This method is part of the MapEvent class.

```java
getHandlers() - Method in class de.pianoman911.mapengine.api.event.MapEvent
```

--------------------------------

### IDisplay Interface

Source: https://mapengine.finndohrmann.de/javadoc/de/pianoman911/mapengine/api/clientside/IDisplay

Documentation for the IDisplay interface, which serves as a marker for all map displays. It includes methods for managing the display's lifecycle and accessing its properties.

```APIDOC
## IDisplay Interface

### Description
Marker interface for all map displays.

### Methods

#### `destroy()`

- **Description**: Destroys the display and internal related resources. It is not guaranteed that a display will work correctly after this method is called.
- **Warning**: This method should be called when the display is no longer needed.
- **Method Signature**: `void destroy()`

#### `pipeline()`

- **Description**: Returns the default `IPipeline` for this display. You can also use multiple own pipelines for different purposes with the same display.
- **Method Signature**: `IPipeline pipeline()`

#### `pixelHeight()`

- **Description**: Returns the display total height in available pixels.
- **Method Signature**: `int pixelHeight()`

#### `pixelWidth()`

- **Description**: Returns the display total width in available pixels.
- **Method Signature**: `int pixelWidth()`

### Known Subinterfaces
- `IHoldableDisplay`
- `IMapDisplay`
```

--------------------------------

### IPipelineInput Interface Documentation

Source: https://mapengine.finndohrmann.de/javadoc/de/pianoman911/mapengine/api/pipeline/IPipelineInput

Documentation for the IPipelineInput interface, detailing its methods and inheritance.

```APIDOC
## IPipelineInput Interface

### Description
Represents an input node within a pipeline, extending the capabilities of `IPipelineNode`. It provides methods to access the internal buffer, the pipeline context, and to flush the drawing space to the display.

### Superinterfaces
- `IPipelineNode`

### Known Subinterfaces
- `IDrawingSpace`
- `ILayeredDrawingSpace`

### Methods

#### `buffer()`

- **Description**: Returns the internal buffer of the drawing space.
- **Return Type**: `FullSpacedColorBuffer`

#### `ctx()`

- **Description**: Returns the pipeline context of this drawing space.
- **Return Type**: `IPipelineContext`

#### `flush()`

- **Description**: Flushes the drawing space to the display using the display's pipeline.
- **Modifier**: `default void`

### Inherited Methods

#### `destroy()`

- **Description**: Inherited from `IPipelineNode`.

```

--------------------------------

### Create Basic Map Display

Source: https://mapengine.finndohrmann.de/javadoc/de/pianoman911/mapengine/api/clientside/IDisplayProvider

Creates a basic map display using two block vectors and a direction. This method uses a default pipeline.

```APIDOC
## POST /websites/mapengine_finndohrmann_de_javadoc/createBasic

### Description
Creates a basic map display. The provided points should define a 2D box.

### Method
POST

### Endpoint
/websites/mapengine_finndohrmann_de_javadoc/createBasic

### Parameters
#### Query Parameters
- **a** (BlockVector) - Required - The first position for the item frame box.
- **b** (BlockVector) - Required - The second position for the item frame box.
- **direction** (BlockFace) - Required - The direction used for interactions and in which the map faces.
- **visualDirection** (BlockFace) - Optional - The direction in which the map faces.

### Request Example
```json
{
  "a": {"x": 0, "y": 0, "z": 0},
  "b": {"x": 1, "y": 1, "z": 1},
  "direction": "NORTH",
  "visualDirection": "EAST"
}
```

### Response
#### Success Response (200)
- **IMapDisplay** (object) - A new map display instance with a default pipeline.

#### Response Example
```json
{
  "displayId": "unique-display-id"
}
```
```

--------------------------------

### Get Handler List Static Method

Source: https://mapengine.finndohrmann.de/javadoc/index-files/index-7

Retrieves a static list of handlers for MapEvents. This method is part of the MapEvent class.

```java
getHandlerList() - Static method in class de.pianoman911.mapengine.api.event.MapEvent
```

--------------------------------

### Get Display Interface Method

Source: https://mapengine.finndohrmann.de/javadoc/index-files/index-7

Retrieves the display object associated with the pipeline context. This method is part of the IPipelineContext interface.

```java
getDisplay() - Method in interface de.pianoman911.mapengine.api.pipeline.IPipelineContext
```
Tokens:
Raw