Yarn

https://maven.fabricmc.net/docs/yarn-1.21.8+build.1/
Admin
Yarn is a deobfuscation mapping project for Minecraft that provides human-readable names for...
Tokens:20,162,978
Snippets:73,541
Trust Score:9.7
Update:3 months ago
Show doc for...
Tokens:
Raw
### setup Method Details

Source: https://maven.fabricmc.net/docs/yarn-1.21.8%2Bbuild.1/net/minecraft/test/TestEnvironmentDefinition.html

Details for the setup method.

```APIDOC
## Method: setup

### Description
Sets up the test environment in the given ServerWorld.

### Signature
`void setup(ServerWorld world)`

### Parameters
* **world** (ServerWorld) - The server world to set up the environment in.
```

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

### start Method

Source: https://maven.fabricmc.net/docs/yarn-1.21.8%2Bbuild.1/net/minecraft/entity/ai/goal/FleeEntityGoal.html

Starts the FleeEntityGoal execution.

```APIDOC
## start Method

### Description
Initiates the FleeEntityGoal's behavior.

### Method
`public void start()`

### Overrides
`start` in class `Goal`

### Mappings

Namespace | Name | Mixin selector
---|---|---
named | `start` | `Lnet/minecraft/entity/ai/goal/Goal;start()V`
intermediary | `method_6269` | `Lnet/minecraft/class_1352;method_6269()V`
official | `d` | `Lchi;d()V`
```

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

### Method Details: start()

Source: https://maven.fabricmc.net/docs/yarn-1.21.8%2Bbuild.1/net/minecraft/entity/mob/PhantomEntity.StartAttackGoal.html

Details for the 'start' method in PhantomEntity.StartAttackGoal.

```APIDOC
## Method: start()

### Description
Executes the starting logic for the AI goal.

### Return Type
`void`

### Overrides
`start` in class `Goal`

### Mappings
| Namespace    | Name       | Mixin selector                               |
|--------------|------------|----------------------------------------------|
| named        | `start`    | `Lnet/minecraft/entity/ai/goal/Goal;start()V`  |
| intermediary | `method_6269` | `Lnet/minecraft/class_1352;method_6269()V`    |
| official     | `d`        | `Lchi;d()V`                                  |
```

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

### start Method

Source: https://maven.fabricmc.net/docs/yarn-1.21.8%2Bbuild.1/net/minecraft/entity/ai/goal/EscapeDangerGoal.html

Documentation for the `start` method, which initiates the AI goal.

```APIDOC
## start

### Description
Public method to start the AI goal. Overrides the `start` method in the `Goal` class.

### Method
public void start()

### Endpoint
N/A (Java method)

### Parameters
None

### Request Body
None

### Response
This method does not return a value.

### Mappings
- **named**: `Lnet/minecraft/entity/ai/goal/Goal;start()V`
- **intermediary**: `method_6269` in `Lnet/minecraft/class_1352;method_6269()V`
- **official**: `d` in `Lchi;d()V`
```

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

### start Method

Source: https://maven.fabricmc.net/docs/yarn-1.21.8%2Bbuild.1/net/minecraft/test/TestRunContext.html

Details for the start method, which initiates the test run.

```APIDOC
    * ### start 
public void start()

Mappings:
    
Namespace | Name | Mixin selector  
---|---|---  
named | `start` | `Lnet/minecraft/test/TestRunContext;start()V`  
intermediary | `method_56226` | `Lnet/minecraft/class_4520;method_56226()V`  
official | `b` | `Lte;b()V`
```

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

### start Method

Source: https://maven.fabricmc.net/docs/yarn-1.21.8%2Bbuild.1/net/minecraft/entity/passive/BeeEntity.FindHiveGoal.html

Executes the starting logic for the FindHiveGoal.

```APIDOC
## Method Details

### start

```java
public void start()
```

**Description:**
Called when the FindHiveGoal is first activated. It sets up the initial state for the bee to begin searching for a hive.

**Overrides:**
`start` in class `Goal`
```

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

### Get Examples API

Source: https://maven.fabricmc.net/docs/yarn-1.21.8%2Bbuild.1/net/minecraft/command/argument/EntityArgumentType.html

Provides a method to get examples for a specific argument type.

```APIDOC
## GET /api/examples

### Description
Retrieves a collection of example strings for the EntitySelector argument type.

### Method
GET

### Endpoint
/api/examples

### Response
#### Success Response (200)
- **examples** (collection) - A collection of example strings.

#### Response Example
```json
{
  "examples": [
    "example1",
    "example2"
  ]
}
```
```

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

### setupServer Method

Source: https://maven.fabricmc.net/docs/yarn-1.21.8%2Bbuild.1/net/minecraft/server/MinecraftServer.html

Sets up the Minecraft server, preparing it for player connections by loading properties and worlds. Returns a boolean indicating success or failure.

```APIDOC
## setupServer Method

### Description
Setups a Minecraft server to be ready for players to connect. This method does several things including loading server properties and loading worlds.

### Method
`protected abstract boolean setupServer()`

### Endpoint
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **boolean** - `true` if the Minecraft server was successfully setup, `false` if the server failed to be setup.

#### Response Example
None

### Throws
- `IOException`

### Mappings

Namespace | Name | Mixin selector
---|---|---
named | `setupServer` | `Lnet/minecraft/server/MinecraftServer;setupServer()Z`
intermediary | `method_3823` | `Lnet/minecraft/server/MinecraftServer;method_3823()Z`
official | `e` | `Lnet/minecraft/server/MinecraftServer;e()Z`
```

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

### Get Start Vec3d from RaycastContext

Source: https://maven.fabricmc.net/docs/yarn-1.21.8%2Bbuild.1/net/minecraft/util/math/class-use/Vec3d.html

Retrieves the start Vec3d from a RaycastContext.

```java
RaycastContext.getStart()
```

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

### setupSpawn

Source: https://maven.fabricmc.net/docs/yarn-1.21.8%2Bbuild.1/net/minecraft/server/MinecraftServer.html

Sets up the spawn point for a new world.

```APIDOC
## POST /api/worlds/spawn

### Description
Sets up the spawn point for a new world.

### Method
POST

### Endpoint
/api/worlds/spawn

### Parameters
#### Request Body
- **world** (ServerWorld) - Required - The server world object.
- **worldProperties** (ServerWorldProperties) - Required - Properties of the world.
- **bonusChest** (boolean) - Optional - Whether to enable the bonus chest.
- **debugWorld** (boolean) - Optional - Whether to set up as a debug world.
```

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

### Get Start Vec3d from BlockStateRaycastContext

Source: https://maven.fabricmc.net/docs/yarn-1.21.8%2Bbuild.1/net/minecraft/util/math/class-use/Vec3d.html

Retrieves the start Vec3d from a BlockStateRaycastContext.

```java
BlockStateRaycastContext.getStart()
```

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

### Get Examples API

Source: https://maven.fabricmc.net/docs/yarn-1.21.8%2Bbuild.1/net/minecraft/command/argument/Vec2ArgumentType.html

Provides a method to retrieve examples for an argument type.

```APIDOC
## GET /getExamples

### Description
Retrieves a collection of example strings for the argument type.

### Method
GET

### Endpoint
/getExamples

### Response
#### Success Response (200)
- **examples** (Collection<String>) - A collection of example strings.
```

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

### NetherFortressGenerator.Start Method Summary

Source: https://maven.fabricmc.net/docs/yarn-1.21.8%2Bbuild.1/net/minecraft/structure/NetherFortressGenerator.Start.html

Summary of methods available in the NetherFortressGenerator.Start class, including inherited methods.

```APIDOC
### Method Summary

### Methods inherited from class net.minecraft.structure.NetherFortressGenerator.BridgeCrossing
`create, fillOpenings, generate`
### Methods inherited from class net.minecraft.structure.NetherFortressGenerator.Piece
`fillForwardOpening, fillNWOpening, fillSEOpening, isInBounds, writeNbt`
### Methods inherited from class net.minecraft.structure.StructurePiece
`addBlock, addBlockWithRandomThreshold, addChest, addChest, addDispenser, applyXTransform, applyYTransform, applyZTransform, boundingBox, canAddBlock, canReplace, createBox, fill, fillDownwards, fillHalfEllipsoid, fillWithOutline, fillWithOutline, fillWithOutline, fillWithOutline, fillWithOutlineUnderSeaLevel, firstIntersecting, getBlockAt, getBoundingBox, getCenter, getChainLength, getFacing, getMirror, getRandomHorizontalDirection, getRotation, getType, intersectsChunk, isUnderSeaLevel, offsetPos, orientateChest, setChainLength, setOrientation, toNbt, translate`
### Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`
```

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

### RegistryEntryPredicateArgumentType Get Examples API

Source: https://maven.fabricmc.net/docs/yarn-1.21.8%2Bbuild.1/net/minecraft/command/argument/RegistryEntryPredicateArgumentType.html

This endpoint retrieves example strings for the RegistryEntryPredicateArgumentType.

```APIDOC
## GET /websites/maven_fabricmc_net_yarn-1_21_8_build_1/getExamples

### Description
Retrieves a collection of example strings for the RegistryEntryPredicateArgumentType.

### Method
GET

### Endpoint
/websites/maven_fabricmc_net_yarn-1_21_8_build_1/getExamples

### Response
#### Success Response (200)
- **Collection<String>** (Collection<String>) - A collection of example strings.

#### Response Example
```json
{
  "examples": [
    "example1",
    "example2"
  ]
}
```
```

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

### POST /api/server/setup

Source: https://maven.fabricmc.net/docs/yarn-1.21.8%2Bbuild.1/net/minecraft/server/dedicated/MinecraftDedicatedServer.html

Sets up a Minecraft server to be ready for players to connect. This method performs several crucial initialization steps.

```APIDOC
## POST /api/server/setup

### Description
Setups a Minecraft server to be ready for players to connect. This method does several things including loading server properties and loading worlds.

### Method
POST

### Endpoint
/api/server/setup

### Parameters
None

### Request Body
None

### Response
#### Success Response (200)
- **boolean** (boolean) - true if the Minecraft server was successfully setup, false if the server failed to be setup.

#### Response Example
```json
{
  "success": true
}
```

### Throws
- **IOException** - Thrown if an I/O error occurs during server setup.
```

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

### Argument Type Examples

Source: https://maven.fabricmc.net/docs/yarn-1.21.8%2Bbuild.1/net/minecraft/command/argument/RegistryEntryArgumentType.html

Provides a method to get examples for an argument type.

```APIDOC
## GET /examples

### Description
Retrieves a collection of example strings for a given argument type.

### Method
GET

### Endpoint
/examples

### Parameters
This method does not take any parameters.

### Response
#### Success Response (200)
- **examples** (Collection<String>) - A collection of example strings.

### Response Example
```json
{
  "examples": ["example1", "example2"]
}
```
```

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

### getExamples

Source: https://maven.fabricmc.net/docs/yarn-1.21.8%2Bbuild.1/net/minecraft/command/argument/RegistryPredicateArgumentType.html

Retrieves a collection of example strings.

```APIDOC
## GET /api/examples

### Description
Returns a collection of example strings as defined by the ArgumentType interface.

### Method
GET

### Endpoint
/api/examples

### Response
#### Success Response (200)
- **examples** (Collection<String>) - A collection of example strings.
```

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

### getExamples Method

Source: https://maven.fabricmc.net/docs/yarn-1.21.8%2Bbuild.1/net/minecraft/command/argument/TextArgumentType.html

Retrieves a collection of example strings.

```APIDOC
## getExamples

### Description
Retrieves a collection of example strings.

### Method
public

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **Collection<String>** - A collection of example strings.

#### Response Example
```json
["example1", "example2"]
```
```

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

### Argument Type Examples API

Source: https://maven.fabricmc.net/docs/yarn-1.21.8%2Bbuild.1/net/minecraft/command/argument/RegistryKeyArgumentType.html

Provides functionality to get examples for an argument type.

```APIDOC
## GET /api/argumentType/examples

### Description
Retrieves examples for an argument type.

### Method
GET

### Endpoint
/api/argumentType/examples

### Response
#### Success Response (200)
- **Collection<String>** - A collection of example strings.

#### Response Example
```json
{
  "examples": [
    "minecraft:plains",
    "minecraft:forest"
  ]
}
```
```

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

### NetherFortressGenerator.Start Constructor Summary

Source: https://maven.fabricmc.net/docs/yarn-1.21.8%2Bbuild.1/net/minecraft/structure/NetherFortressGenerator.Start.html

Summary of constructors for the NetherFortressGenerator.Start class.

```APIDOC
### Constructor Summary

Constructors

Constructor
Description
`Start(NbtCompound nbt)`
`Start(Random random, int x, int z)`
```

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

### Create SetStewEffectLootFunction Builder

Source: https://maven.fabricmc.net/docs/yarn-1.21.8%2Bbuild.1/net/minecraft/loot/function/class-use/SetStewEffectLootFunction.Builder.html

Use this static method to start building a SetStewEffectLootFunction. Requires no setup.

```java
SetStewEffectLootFunction.builder()
```

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

### Get Bytes (ByteBuffer)

Source: https://maven.fabricmc.net/docs/yarn-1.21.8%2Bbuild.1/net/minecraft/network/PacketByteBuf.html

Copies bytes from the buffer to a destination ByteBuffer starting at the specified index.

```APIDOC
## POST /api/bytebuf/getBytes/bytebuffer

### Description
Copies bytes from the buffer to a destination ByteBuffer starting at the specified index.

### Method
POST

### Endpoint
/api/bytebuf/getBytes/bytebuffer

#### Query Parameters
- **index** (int) - Required - The starting index in the source buffer.

#### Request Body
- **destination** (ByteBuffer) - Required - The destination ByteBuffer to copy bytes into.

### Response
#### Success Response (200)
- **bytesCopied** (int) - The number of bytes copied.

#### Response Example
```json
{
  "bytesCopied": 16
}
```
```

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

### Get Bytes (ByteBuf)

Source: https://maven.fabricmc.net/docs/yarn-1.21.8%2Bbuild.1/net/minecraft/network/PacketByteBuf.html

Copies bytes from the buffer to a destination ByteBuf starting at the specified index.

```APIDOC
## POST /api/bytebuf/getBytes/bytebuf

### Description
Copies bytes from the buffer to a destination ByteBuf starting at the specified index.

### Method
POST

### Endpoint
/api/bytebuf/getBytes/bytebuf

#### Query Parameters
- **index** (int) - Required - The starting index in the source buffer.

#### Request Body
- **destination** (ByteBuf) - Required - The destination ByteBuf to copy bytes into.

### Response
#### Success Response (200)
- **bytesCopied** (int) - The number of bytes copied.

#### Response Example
```json
{
  "bytesCopied": 16
}
```
```

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

### StructureStart.place Method

Source: https://maven.fabricmc.net/docs/yarn-1.21.8%2Bbuild.1/net/minecraft/world/class-use/StructureWorldAccess.html

Documentation for the 'place' method in StructureStart.

```APIDOC
## StructureStart.place

### Description
Places a structure start.

### Method
void

### Endpoint
N/A (Method Signature)

### Parameters
- **world** (StructureWorldAccess) - Description not provided
- **structureAccessor** (StructureAccessor) - Description not provided
- **chunkGenerator** (ChunkGenerator) - Description not provided
- **random** (Random) - Description not provided
- **chunkBox** (BlockBox) - Description not provided
- **chunkPos** (ChunkPos) - Description not provided

### Response
#### Success Response (void)
No specific return value.

```

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

### getStart API

Source: https://maven.fabricmc.net/docs/yarn-1.21.8%2Bbuild.1/net/minecraft/structure/pool/SinglePoolElement.html

Gets the starting position of a structure template with a given rotation. This method is specified by the StructurePoolElement class.

```APIDOC
## GET /api/getStart

### Description
Gets the starting position of a structure template with a given rotation. This method is specified by the StructurePoolElement class.

### Method
GET

### Endpoint
/api/getStart

### Parameters
#### Query Parameters
- **structureTemplateManager** (StructureTemplateManager) - Required - Manages structure templates.
- **rotation** (BlockRotation) - Required - The rotation to apply.
- **namespace** (string) - Optional - The namespace for the mapping (e.g., 'named', 'intermediary', 'official').

### Response
#### Success Response (200)
- **startPosition** (Vec3i) - The starting position of the structure.

### Response Example
```json
{
  "startPosition": {
    "x": 0,
    "y": 0,
    "z": 0
  }
}
```
```

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

### Get Bytes (OutputStream)

Source: https://maven.fabricmc.net/docs/yarn-1.21.8%2Bbuild.1/net/minecraft/network/PacketByteBuf.html

Copies a specified number of bytes from the buffer to a destination OutputStream starting at the specified index.

```APIDOC
## POST /api/bytebuf/getBytes/outputstream

### Description
Copies a specified number of bytes from the buffer to a destination OutputStream starting at the specified index.

### Method
POST

### Endpoint
/api/bytebuf/getBytes/outputstream

#### Query Parameters
- **index** (int) - Required - The starting index in the source buffer.
- **length** (int) - Required - The number of bytes to copy.

#### Request Body
- **destination** (OutputStream) - Required - The destination OutputStream to write bytes to.

### Response
#### Success Response (200)
- **bytesWritten** (int) - The number of bytes written to the output stream.

#### Response Example
```json
{
  "bytesWritten": 8
}
```

#### Throws
- **IOException** - If an I/O error occurs while writing to the output stream.
```

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

### NetherFortressGenerator.Start Class Overview

Source: https://maven.fabricmc.net/docs/yarn-1.21.8%2Bbuild.1/net/minecraft/structure/NetherFortressGenerator.Start.html

Overview of the NetherFortressGenerator.Start class, its inheritance, and nested class summary.

```APIDOC
## Class NetherFortressGenerator.Start

`public static class NetherFortressGenerator.Start extends NetherFortressGenerator.BridgeCrossing`

### Nested Class Summary

Nested classes/interfaces inherited from class net.minecraft.structure.StructurePiece
`StructurePiece.BlockRandomizer`
```

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

### Get Bytes (byte array)

Source: https://maven.fabricmc.net/docs/yarn-1.21.8%2Bbuild.1/net/minecraft/network/PacketByteBuf.html

Copies bytes from the buffer to a destination byte array starting at the specified index.

```APIDOC
## POST /api/bytebuf/getBytes/bytearray

### Description
Copies bytes from the buffer to a destination byte array starting at the specified index.

### Method
POST

### Endpoint
/api/bytebuf/getBytes/bytearray

#### Query Parameters
- **index** (int) - Required - The starting index in the source buffer.

#### Request Body
- **destination** (byte[]) - Required - The destination byte array to copy bytes into.

### Response
#### Success Response (200)
- **bytesCopied** (int) - The number of bytes copied.

#### Response Example
```json
{
  "bytesCopied": 16
}
```
```

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

### getExamples

Source: https://maven.fabricmc.net/docs/yarn-1.21.8%2Bbuild.1/net/minecraft/command/argument/TimeArgumentType.html

Retrieves examples for the argument type.

```APIDOC
## GET /getExamples

### Description
Retrieves a collection of example strings for the argument type.

### Method
GET

### Endpoint
/getExamples

### Response
#### Success Response (200)
- **Collection<String>** - A collection of example strings.
```

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

### Get Bytes (ByteBuf with length)

Source: https://maven.fabricmc.net/docs/yarn-1.21.8%2Bbuild.1/net/minecraft/network/PacketByteBuf.html

Copies a specified number of bytes from the buffer to a destination ByteBuf starting at the specified index.

```APIDOC
## POST /api/bytebuf/getBytes/bytebuf/length

### Description
Copies a specified number of bytes from the buffer to a destination ByteBuf starting at the specified index.

### Method
POST

### Endpoint
/api/bytebuf/getBytes/bytebuf/length

#### Query Parameters
- **index** (int) - Required - The starting index in the source buffer.
- **length** (int) - Required - The number of bytes to copy.

#### Request Body
- **destination** (ByteBuf) - Required - The destination ByteBuf to copy bytes into.

### Response
#### Success Response (200)
- **bytesCopied** (int) - The number of bytes copied.

#### Response Example
```json
{
  "bytesCopied": 8
}
```
```

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

### Spawn Helper Setup

Source: https://maven.fabricmc.net/docs/yarn-1.21.8%2Bbuild.1/net/minecraft/entity/class-use/Entity.html

Method for setting up spawn conditions.

```APIDOC
## SpawnHelper.setupSpawn(int spawningChunkCount, Iterable<Entity> entities, SpawnHelper.ChunkSource chunkSource, SpawnDensityCapper densityCapper)

### Description
Sets up spawn conditions based on chunk count, entities, chunk source, and density capping.

### Method
static SpawnHelper.Info

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

### 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 Bytes (ByteBuf with offset and length)

Source: https://maven.fabricmc.net/docs/yarn-1.21.8%2Bbuild.1/net/minecraft/network/PacketByteBuf.html

Copies a specified number of bytes from the buffer to a destination ByteBuf starting at the specified index and offset.

```APIDOC
## POST /api/bytebuf/getBytes/bytebuf/offset/length

### Description
Copies a specified number of bytes from the buffer to a destination ByteBuf starting at the specified index and offset.

### Method
POST

### Endpoint
/api/bytebuf/getBytes/bytebuf/offset/length

#### Query Parameters
- **index** (int) - Required - The starting index in the source buffer.
- **offset** (int) - Required - The starting offset in the destination buffer.
- **length** (int) - Required - The number of bytes to copy.

#### Request Body
- **destination** (ByteBuf) - Required - The destination ByteBuf to copy bytes into.

### Response
#### Success Response (200)
- **bytesCopied** (int) - The number of bytes copied.

#### Response Example
```json
{
  "bytesCopied": 4
}
```
```

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

### NetherFortressGenerator.Start Constructor Details

Source: https://maven.fabricmc.net/docs/yarn-1.21.8%2Bbuild.1/net/minecraft/structure/NetherFortressGenerator.Start.html

Detailed information about the constructors for the NetherFortressGenerator.Start class, including mappings.

```APIDOC
### Constructor Details

* ### Start
public Start(Random random, int x, int z)

Mappings:

Namespace | Name | Mixin selector
---|---|---
named | `<init>` | `Lnet/minecraft/structure/NetherFortressGenerator$Start;<init>(Lnet/minecraft/util/math/random/Random;II)V`
intermediary | `<init>` | `Lnet/minecraft/class_3390$class_3407;<init>(Lnet/minecraft/class_5819;II)V`
official | `<init>` | `Lexe$q;<init>(Lbck;II)V`

* ### Start
public Start(NbtCompound nbt)

Mappings:

Namespace | Name | Mixin selector
---|---|---
named | `<init>` | `Lnet/minecraft/structure/NetherFortressGenerator$BridgeCrossing;<init>(Lnet/minecraft/nbt/NbtCompound;)V`
intermediary | `<init>` | `Lnet/minecraft/class_3390$class_3391;<init>(Lnet/minecraft/class_2487;)V`
official | `<init>` | `Lexe$a;<init>(Lui;)V`
```

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

### Get Bytes (byte array with offset and length)

Source: https://maven.fabricmc.net/docs/yarn-1.21.8%2Bbuild.1/net/minecraft/network/PacketByteBuf.html

Copies a specified number of bytes from the buffer to a destination byte array starting at the specified index and offset.

```APIDOC
## POST /api/bytebuf/getBytes/bytearray/offset/length

### Description
Copies a specified number of bytes from the buffer to a destination byte array starting at the specified index and offset.

### Method
POST

### Endpoint
/api/bytebuf/getBytes/bytearray/offset/length

#### Query Parameters
- **index** (int) - Required - The starting index in the source buffer.
- **offset** (int) - Required - The starting offset in the destination byte array.
- **length** (int) - Required - The number of bytes to copy.

#### Request Body
- **destination** (byte[]) - Required - The destination byte array to copy bytes into.

### Response
#### Success Response (200)
- **bytesCopied** (int) - The number of bytes copied.

#### Response Example
```json
{
  "bytesCopied": 8
}
```
```

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

### startClient Method

Source: https://maven.fabricmc.net/docs/yarn-1.21.8%2Bbuild.1/net/minecraft/server/command/ChaseCommand.html

Documentation for the `startClient` method, including its signature and mappings in various namespaces.

```APIDOC
## startClient

### Description
This method is used to start a client. It takes a ServerCommandSource, an IP address string, and a port integer as arguments.

### Method
private static int

### Endpoint
N/A (This is a method signature, not a REST endpoint)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
Returns an integer representing the result of the operation.

#### Response Example
None

### Mappings

Namespace | Name | Mixin selector
---|---|---
named | `startClient` | `Lnet/minecraft/server/command/ChaseCommand;startClient(Lnet/minecraft/server/command/ServerCommandSource;Ljava/lang/String;I)I`
intermediary | `method_38776` | `Lnet/minecraft/class_6634;method_38776(Lnet/minecraft/class_2168;Ljava/lang/String;I)I`
official | `b` | `Lans;b(Lek;Ljava/lang/String;I)I`
```

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

### VoxelSet Axis and Size Information API

Source: https://maven.fabricmc.net/docs/yarn-1.21.8%2Bbuild.1/net/minecraft/util/shape/VoxelSet.html

Provides methods to get the size of a VoxelSet along a specific axis and to retrieve the starting and ending coordinates along an axis.

```APIDOC
## GET /api/voxelset/axis/{axis}/size

### Description
Retrieves the size of the VoxelSet along the specified axis.

### Method
GET

### Endpoint
/api/voxelset/axis/{axis}/size

### Parameters
#### Path Parameters
- **axis** (Direction.Axis) - Required - The axis for which to retrieve the size (e.g., X, Y, Z).

### Response
#### Success Response (200)
- **size** (int) - The size of the VoxelSet along the specified axis.

#### Response Example
```json
{
  "size": 16
}
```

## GET /api/voxelset/axis/{axis}/start

### Description
Retrieves the starting coordinate of the VoxelSet along the specified axis within a given range.

### Method
GET

### Endpoint
/api/voxelset/axis/{axis}/start

### Parameters
#### Path Parameters
- **axis** (Direction.Axis) - Required - The axis for which to retrieve the starting coordinate.
- **from** (int) - Required - The starting point of the range.
- **to** (int) - Required - The ending point of the range.

### Response
#### Success Response (200)
- **startingCoord** (int) - The starting coordinate along the specified axis.

#### Response Example
```json
{
  "startingCoord": 0
}
```

## GET /api/voxelset/axis/{axis}/end

### Description
Retrieves the ending coordinate of the VoxelSet along the specified axis within a given range.

### Method
GET

### Endpoint
/api/voxelset/axis/{axis}/end

### Parameters
#### Path Parameters
- **axis** (Direction.Axis) - Required - The axis for which to retrieve the ending coordinate.
- **from** (int) - Required - The starting point of the range.
- **to** (int) - Required - The ending point of the range.

### Response
#### Success Response (200)
- **endingCoord** (int) - The ending coordinate along the specified axis.

#### Response Example
```json
{
  "endingCoord": 15
}
```
```

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

### Structure Management API

Source: https://maven.fabricmc.net/docs/yarn-1.21.8%2Bbuild.1/net/minecraft/world/chunk/WrapperProtoChunk.html

This section details the methods related to managing structures within the game's chunk system, including getting and setting structure starts and references.

```APIDOC
## GET /api/structure/start

### Description
Retrieves the structure start for a given structure.

### Method
GET

### Endpoint
/api/structure/start

### Query Parameters
- **structure** (Structure) - Required - The structure to get the start for.

### Response
#### Success Response (200)
- **structureStart** (StructureStart) - The structure start.

#### Response Example
```json
{
  "structureStart": { ... }
}
```
```

```APIDOC
## POST /api/structure/start

### Description
Sets the structure start for a given structure.

### Method
POST

### Endpoint
/api/structure/start

### Request Body
- **structure** (Structure) - Required - The structure to set.
- **start** (StructureStart) - Required - The structure start to set.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "Structure start set successfully."
}
```
```

```APIDOC
## GET /api/structure/starts

### Description
Retrieves all structure starts.

### Method
GET

### Endpoint
/api/structure/starts

### Response
#### Success Response (200)
- **structureStarts** (Map<Structure, StructureStart>) - A map of structures to their starts.

#### Response Example
```json
{
  "structureStarts": {
    "structure1": { ... },
    "structure2": { ... }
  }
}
```
```

```APIDOC
## PUT /api/structure/starts

### Description
Sets all structure starts.

### Method
PUT

### Endpoint
/api/structure/starts

### Request Body
- **structureStarts** (Map<Structure, StructureStart>) - Required - The map of structures to their starts.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "Structure starts set successfully."
}
```
```

```APIDOC
## GET /api/structure/references

### Description
Retrieves the structure references for a given structure.

### Method
GET

### Endpoint
/api/structure/references

### Query Parameters
- **structure** (Structure) - Required - The structure to get references for.

### Response
#### Success Response (200)
- **structureReferences** (LongSet) - A set of references for the structure.

#### Response Example
```json
{
  "structureReferences": [1234567890, 9876543210]
}
```
```

```APIDOC
## POST /api/structure/reference

### Description
Adds a structure reference.

### Method
POST

### Endpoint
/api/structure/reference

### Request Body
- **structure** (Structure) - Required - The structure to add a reference to.
- **reference** (long) - Required - The reference to add.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "Structure reference added successfully."
}
```
```

```APIDOC
## GET /api/structure/allReferences

### Description
Retrieves all structure references.

### Method
GET

### Endpoint
/api/structure/allReferences

### Response
#### Success Response (200)
- **structureReferences** (Map<Structure, LongSet>) - A map of structures to their references.

#### Response Example
```json
{
  "structureReferences": {
    "structure1": [1234567890, 9876543210],
    "structure2": [1122334455, 5544332211]
  }
}
```
```

```APIDOC
## PUT /api/structure/allReferences

### Description
Sets all structure references.

### Method
PUT

### Endpoint
/api/structure/allReferences

### Request Body
- **structureReferences** (Map<Structure, LongSet>) - Required - The map of structures to their references.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "Structure references set successfully."
}
```
```

```APIDOC
## POST /api/chunk/save

### Description
Marks the chunk for saving.

### Method
POST

### Endpoint
/api/chunk/save

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "Chunk marked for saving."
}
```
```

```APIDOC
## GET /api/chunk/serializable

### Description
Checks if the chunk is serializable.

### Method
GET

### Endpoint
/api/chunk/serializable

### Response
#### Success Response (200)
- **isSerializable** (boolean) - True if the chunk is serializable, false otherwise.

#### Response Example
```json
{
  "isSerializable": true
}
```
```

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

### getExamples

Source: https://maven.fabricmc.net/docs/yarn-1.21.8%2Bbuild.1/net/minecraft/command/argument/RegistryEntryReferenceArgumentType.html

Retrieves a collection of example strings for the argument type.

```APIDOC
## GET /examples

### Description
Retrieves a collection of example strings for the argument type.

### Method
GET

### Endpoint
/examples

### Response
#### Success Response (200)
- **Collection<String>** - A collection of example strings.

#### Response Example
```json
{
  "examples": [
    "example1",
    "example2"
  ]
}
```
```

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

### StrongholdGenerator.Start Method Details

Source: https://maven.fabricmc.net/docs/yarn-1.21.8%2Bbuild.1/net/minecraft/structure/StrongholdGenerator.Start.html

Details about the methods within the StrongholdGenerator.Start class.

```APIDOC
## Method Details

### getCenter
`public BlockPos getCenter()`

Overrides:
    `getCenter` in class `StructurePiece`

Mappings:

Namespace | Name | Mixin selector
---|---|---
named | `getCenter` | `Lnet/minecraft/structure/StructurePiece;getCenter()Lnet/minecraft/util/math/BlockPos;`
intermediary | `method_35458` | `Lnet/minecraft/class_3443;method_35458()Lnet/minecraft/class_2338;`
official | `h` | `Levc;h()Ljb;`
```

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

### SectorMap.allocate(int start, int size)

Source: https://maven.fabricmc.net/docs/yarn-1.21.8%2Bbuild.1/net/minecraft/world/storage/SectorMap.html

Allocates a contiguous block of sectors of the specified size, starting from the given start index.

```APIDOC
## allocate(int start, int size)

### Description
Allocates a contiguous block of sectors of the specified size, starting from the given start index.

### Method
GET

### Endpoint
N/A

### Parameters
#### Query Parameters
- **start** (int) - Required - The starting index from which to allocate sectors.
- **size** (int) - Required - The number of sectors to allocate.

### Request Example
```json
{
  "example": "sectorMap.allocate(10, 5);"
}
```

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

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

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

### StrongholdGenerator.Start Constructor Details

Source: https://maven.fabricmc.net/docs/yarn-1.21.8%2Bbuild.1/net/minecraft/structure/StrongholdGenerator.Start.html

Details about the constructors for the StrongholdGenerator.Start class.

```APIDOC
## Constructor Details

### Start
`public Start(Random random, int int2, int int3)`

Mappings:

Namespace | Name | Mixin selector
---|---|---
named | `<init>` | `Lnet/minecraft/structure/StrongholdGenerator$Start;<init>(Lnet/minecraft/util/math/random/Random;II)V`
intermediary | `<init>` | `Lnet/minecraft/class_3421$class_3434;<init>(Lnet/minecraft/class_5819;II)V`
official | `<init>` | `Lexq$m;<init>(Lbck;II)V`

### Start
`public Start(NbtCompound nbt)`

Mappings:

Namespace | Name | Mixin selector
---|---|---
named | `<init>` | `Lnet/minecraft/structure/StrongholdGenerator$SpiralStaircase;<init>(Lnet/minecraft/nbt/NbtCompound;)V`
intermediary | `<init>` | `Lnet/minecraft/class_3421$class_3433;<init>(Lnet/minecraft/class_2487;)V`
official | `<init>` | `Lexq$l;<init>(Lui;)V`
```

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

### Void Start Platform Block Position

Source: https://maven.fabricmc.net/docs/yarn-1.21.8%2Bbuild.1/net/minecraft/util/math/class-use/BlockPos.html

Specifies the starting BlockPos for the Void Start Platform feature. This is a static final BlockPos constant.

```java
`private static final BlockPos`
VoidStartPlatformFeature.`START_BLOCK`
```

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

### SpawnHelper.setupSpawn Method

Source: https://maven.fabricmc.net/docs/yarn-1.21.8%2Bbuild.1/net/minecraft/world/class-use/SpawnHelper.ChunkSource.html

Details the setupSpawn method in SpawnHelper, which accepts a SpawnHelper.ChunkSource as a parameter.

```APIDOC
## SpawnHelper.setupSpawn

### Description
Sets up the spawning process for entities within a given chunk count, considering existing entities, chunk source, and density capping.

### Method
`static SpawnHelper.Info`

### Endpoint
N/A (This is a method signature, not an API endpoint)

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

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
N/A (Method returns SpawnHelper.Info)

#### Response Example
N/A

### Parameters in Detail
- **spawningChunkCount** (int) - The number of chunks to consider for spawning.
- **entities** (Iterable<Entity>) - An iterable collection of entities already present.
- **chunkSource** (SpawnHelper.ChunkSource) - The source of chunk information.
- **densityCapper** (SpawnDensityCapper) - An object to cap spawn density.
```

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

### StructureStart Methods

Source: https://maven.fabricmc.net/docs/yarn-1.21.8%2Bbuild.1/net/minecraft/structure/StructureStart.html

Lists and describes the available methods for interacting with StructureStart objects.

```APIDOC
## StructureStart Methods

### Static Methods

- **`static @Nullable StructureStart fromNbt(StructureContext context, NbtCompound nbt, long seed)`**
  - Description: Creates a `StructureStart` from NBT data.
  - Parameters:
    - `context` (StructureContext) - The structure context.
    - `nbt` (NbtCompound) - The NBT compound to load from.
    - `seed` (long) - The world seed.

### Instance Methods

- **`BlockBox getBoundingBox()`**
  - Description: Gets the bounding box of the structure.

- **`List<StructurePiece> getChildren()`**
  - Description: Gets the list of structure pieces.

- **`protected int getMinReferencedStructureReferenceCount()`**
  - Description: Gets the minimum referenced structure reference count.

- **`ChunkPos getPos()`**
  - Description: Gets the position of the structure's origin chunk.

- **`int getReferences()`**
  - Description: Gets the number of references to this structure.

- **`Structure getStructure()`**
  - Description: Gets the structure definition.

- **`boolean hasChildren()`**
  - Description: Checks if the structure has any pieces.

- **`void incrementReferences()`**
  - Description: Increments the reference count for this structure.

- **`boolean isNeverReferenced()`**
  - Description: Checks if this structure is never referenced.

- **`void place(StructureWorldAccess world, StructureAccessor structureAccessor, ChunkGenerator chunkGenerator, Random random, BlockBox chunkBox, ChunkPos chunkPos)`**
  - Description: Places the structure in the world.
  - Parameters:
    - `world` (StructureWorldAccess) - The world access.
    - `structureAccessor` (StructureAccessor) - The structure accessor.
    - `chunkGenerator` (ChunkGenerator) - The chunk generator.
    - `random` (Random) - The random number generator.
    - `chunkBox` (BlockBox) - The bounding box for the chunk.
    - `chunkPos` (ChunkPos) - The position of the chunk.

- **`NbtCompound toNbt(StructureContext context, ChunkPos chunkPos)`**
  - Description: Converts the `StructureStart` to NBT data.
  - Parameters:
    - `context` (StructureContext) - The structure context.
    - `chunkPos` (ChunkPos) - The position of the chunk.
```

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

### SectorMap.free(int start, int size)

Source: https://maven.fabricmc.net/docs/yarn-1.21.8%2Bbuild.1/net/minecraft/world/storage/SectorMap.html

Frees a contiguous block of sectors, starting from the given start index and spanning the specified size.

```APIDOC
## free(int start, int size)

### Description
Frees a contiguous block of sectors, starting from the given start index and spanning the specified size.

### Method
GET

### Endpoint
N/A

### Parameters
#### Query Parameters
- **start** (int) - Required - The starting index of the block to free.
- **size** (int) - Required - The number of sectors to free.

### Request Example
```json
{
  "example": "sectorMap.free(5, 10);"
}
```

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

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

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

### Find Position From Start (No Penalty)

Source: https://maven.fabricmc.net/docs/yarn-1.21.8%2Bbuild.1/net/minecraft/util/math/class-use/Vec3d.html

Paths to a position leading away from a given starting point. Requires entity, ranges, and start position.

```java
static @Nullable Vec3d
NoPenaltyTargeting.findFrom(PathAwareEntity entity,  int horizontalRange,  int verticalRange,  Vec3d start)
```

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

### getExamples Method

Source: https://maven.fabricmc.net/docs/yarn-1.21.8%2Bbuild.1/net/minecraft/command/argument/NbtPathArgumentType.html

Retrieves examples for the NbtPathArgumentType.

```APIDOC
## GET /api/nbtpath/examples

### Description
Returns a collection of example strings for the NbtPathArgumentType.

### Method
GET

### Endpoint
/api/nbtpath/examples

### Response
#### Success Response (200)
- **examples** (Collection<String>) - A collection of example strings.

#### Response Example
{
  "examples": ["example1", "example2"]
}
```

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

### setupTransforms Method

Source: https://maven.fabricmc.net/docs/yarn-1.21.8%2Bbuild.1/net/minecraft/client/render/entity/ShulkerEntityRenderer.html

Documentation for the setupTransforms method, used in ShulkerEntityRenderer.

```APIDOC
## POST /api/setupTransforms

### Description
Sets up transformations for the Shulker entity renderer, overriding the base class method.

### Method
POST

### Endpoint
/api/setupTransforms

### Parameters
#### Request Body
- **shulkerEntityRenderState** (ShulkerEntityRenderState) - Required - The render state of the Shulker entity.
- **matrixStack** (Lnet/minecraft/client/util/math/MatrixStack;) - Required - The matrix stack for transformations.
- **float2** (float) - Required - A float value for transformation.
- **float3** (float) - Required - Another float value for transformation.

### Response
#### Success Response (200)
This endpoint does not return a specific value upon success, indicating completion of the transformation setup.

#### Response Example
(No specific response body for success)
```

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

### Raid Start

Source: https://maven.fabricmc.net/docs/yarn-1.21.8%2Bbuild.1/net/minecraft/server/network/class-use/ServerPlayerEntity.html

Starts a raid for a given player.

```APIDOC
## Raid Start

### Description
Starts a raid for a given player.

### Method
`boolean`

### Endpoint
`Raid.start(ServerPlayerEntity player)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **boolean** - True if the raid was started successfully, false otherwise.

#### Response Example
None
```

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

### getExamples API

Source: https://maven.fabricmc.net/docs/yarn-1.21.8%2Bbuild.1/net/minecraft/command/argument/CommandFunctionArgumentType.html

Retrieves a collection of example strings for the command function argument type.

```APIDOC
## GET /command/examples

### Description
Retrieves a collection of example strings for the command function argument type.

### Method
GET

### Endpoint
/command/examples

### Response
#### Success Response (200)
- **examples** (Collection<String>) - A collection of example strings.

#### Response Example
{
  "examples": [
    "minecraft:function_name",
    "#minecraft:tag_name"
  ]
}
```

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

### startBody Method

Source: https://maven.fabricmc.net/docs/yarn-1.21.8%2Bbuild.1/net/minecraft/util/CsvWriter.Header.html

Demonstrates how to start the CSV body.

```APIDOC
## POST /api/csvwriter/header/startBody

### Description
Starts the body of the CSV file.

### Method
POST

### Endpoint
/api/csvwriter/header/startBody

### Parameters
#### Request Body
- **writer** (Writer) - Required - The writer object to use for the CSV body.

### Request Example
```json
{
  "writer": "<writer_object>"
}
```

### Response
#### Success Response (200)
- **CsvWriter** (CsvWriter) - The CsvWriter object ready to write the body.

#### Response Example
```json
{
  "message": "CSV body started successfully"
}
```

### Error Handling
- **IOException**: Thrown if an error occurs during the process.
```
Tokens:
Raw