Minecraft Mappings

https://mappings.dev/1.21.8/
Admin
Minecraft Mappings is a documentation resource that provides deobfuscated package and namespace...
Tokens:6,240,638
Snippets:17,998
Trust Score:5.2
Update:4 months ago
Show doc for...
Tokens:
Raw
### Server Initialization and Startup

Source: https://mappings.dev/1.21.8/net/minecraft/server/MinecraftServer.html

Methods related to the initial setup and starting of the Minecraft server.

```APIDOC
## POST /api/server/start

### Description
Starts the Minecraft server with a given server factory.

### Method
POST

### Endpoint
/api/server/start

### Parameters
#### Request Body
- **serverFactory** (Function<Thread, S>) - Required - A function that creates and returns the server instance.

### Request Example
```json
{
  "serverFactory": "your_server_factory_function"
}
```

### Response
#### Success Response (200)
- **serverInstance** (S) - The started Minecraft server instance.

#### Response Example
```json
{
  "serverInstance": "minecraft_server_object"
}
```
```

```APIDOC
## POST /api/server/init

### Description
Initializes the server's scoreboard.

### Method
POST

### Endpoint
/api/server/init

### Parameters
#### Request Body
- **persistentStateManager** (PersistentStateManager) - Required - The state manager for persistent data.

### Response
#### Success Response (200)
- **status** (string) - Indicates successful initialization.

#### Response Example
```json
{
  "status": "Scoreboard initialized successfully"
}
```
```

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

### Description
Sets up the server environment, including world loading and initial configuration.

### Method
POST

### Endpoint
/api/server/setup

### Response
#### Success Response (200)
- **setupStatus** (string) - Confirmation of server setup completion.

#### Response Example
```json
{
  "setupStatus": "Server setup complete"
}
```
```

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

### General Input and Setup

Source: https://mappings.dev/1.21.8/net/minecraft/client/MouseHandler.html

Methods for general input handling, setup, and debugging.

```APIDOC
## General Input and Setup

### Description
Contains methods for setting up input handling, managing accumulated movement, and drawing debug information.

### Methods
- **setup**: Initializes input handling for a window.
- **handleAccumulatedMovement**: Processes accumulated movement data.
- **tick**: Updates input state per tick.
- **drawDebugMouseInfo**: Renders debug information related to mouse input.

### Parameters
- **window** (long) - The window identifier.
- **arg0** (q) - Argument of type q.
- **arg1** (fni) - Argument of type fni.
- **arg0** (CrashReportCategory) - Crash report category.
- **arg1** (Window) - Window object.
- **arg0** (TextRenderer) - Text renderer for drawing.
- **arg1** (DrawContext) - Context for drawing operations.
```

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

### Initialization and Setup Methods

Source: https://mappings.dev/1.21.8/net/minecraft/client/renderer/LevelRenderer.html

Methods related to initializing and setting up the rendering environment.

```APIDOC
## Initialization and Setup Methods

### Description
Provides methods for initializing and setting up various components of the rendering system.

### Methods

- **initOutline()**
  - Description: Initializes outline rendering.
  - Method: Public void

- **onResourceManagerReload(ResourceManager arg0)**
  - Description: Handles resource manager reloads.
  - Method: Public void

- **reload(ResourceManager arg0)**
  - Description: Reloads resources.
  - Method: Public void

- **setLevel(ClientLevel arg0)**
  - Description: Sets the client level.
  - Method: Public void

- **setWorld(ClientWorld world)**
  - Description: Sets the client world.
  - Method: Public void

- **setupRender(Camera arg0, Frustum arg1, boolean arg2, boolean arg3)**
  - Description: Sets up the rendering process with camera and frustum information.
  - Method: Private void

- **setupTerrain(Camera camera, Frustum frustum, boolean hasForcedFrustum, boolean spectator)**
  - Description: Sets up terrain rendering.
  - Method: Private void

- **prepareCullFrustum(Vec3 arg0, org.joml.Matrix4f arg1, org.joml.Matrix4f arg2)**
  - Description: Prepares the frustum for culling.
  - Method: Public void

- **setupFrustum(Vec3d pos, org.joml.Matrix4f positionMatrix, org.joml.Matrix4f projectionMatrix)**
  - Description: Sets up the frustum using position and projection matrices.
  - Method: Public void

- **renderLevel(GraphicsResourceAllocator arg0, DeltaTracker arg1, boolean arg2, Camera arg3, org.joml.Matrix4f arg4, org.joml.Matrix4f arg5, GpuBufferSlice arg6, org.joml.Vector4f arg7, boolean arg8)**
  - Description: Renders the level with various parameters.
  - Method: Public void

- **render(ObjectAllocator allocator, RenderTickCounter tickCounter, boolean renderBlockOutline, Camera camera, org.joml.Matrix4f positionMatrix, org.joml.Matrix4f projectionMatrix, GpuBufferSlice fog, org.joml.Vector4f fogColor, boolean shouldRenderSky)**
  - Description: Renders the scene with detailed parameters.
  - Method: Public void
```

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

### Advancement Examples

Source: https://mappings.dev/1.21.8/net/minecraft/commands/arguments/ResourceKeyArgument.html

Retrieves example names for advancements.

```APIDOC
## GET /api/advancements/examples

### Description
Retrieves a collection of example advancement names.

### Method
GET

### Endpoint
/api/advancements/examples

### Response
#### Success Response (200)
- **Collection<String>** (array) - A list of example advancement names.

#### Response Example
```json
{
  "examples": [
    "minecraft:story/root",
    "minecraft:story/iron_tools"
  ]
}
```
```

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

### Server Spawn Setup

Source: https://mappings.dev/1.21.8/net/minecraft/server/MinecraftServer.html

Methods for setting up the initial spawn point in the world.

```APIDOC
## POST /api/server/spawn/initial

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

### Method
POST

### Endpoint
/api/server/spawn/initial

### Parameters
#### Request Body
- **world** (ServerLevel) - Required - The server level.
- **worldProperties** (ServerLevelData) - Required - Properties of the server world.
- **bonusChest** (boolean) - Required - Whether to enable the bonus chest.
- **debugWorld** (boolean) - Required - Whether to enable debug world settings.

### Response
#### Success Response (200)
- **spawnStatus** (string) - Confirmation that the initial spawn has been set.

#### Response Example
```json
{
  "spawnStatus": "Initial spawn set"
}
```
```

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

### Description
Sets up the spawn point for the server world, including options for bonus chest and debug mode.

### Method
POST

### Endpoint
/api/server/spawn/setup

### Parameters
#### Request Body
- **world** (ServerWorld) - Required - The server world object.
- **worldProperties** (ServerWorldProperties) - Required - Properties for the server world.
- **bonusChest** (boolean) - Required - Whether to include a bonus chest.
- **debugWorld** (boolean) - Required - Whether to enable debug world features.

### Response
#### Success Response (200)
- **setupStatus** (string) - Confirmation that the spawn has been set up.

#### Response Example
```json
{
  "setupStatus": "Spawn setup complete"
}
```
```

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

### Command Examples

Source: https://mappings.dev/1.21.8/net/minecraft/commands/arguments/ResourceArgument.html

Retrieves a collection of example commands.

```APIDOC
## GET /examples

### Description
Retrieves a collection of example commands.

### Method
GET

### Endpoint
/examples

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

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

### Get Pick Radius

Source: https://mappings.dev/1.21.8/net/minecraft/world/entity/projectile/Projectile.html

Gets the pick radius of the projectile.

```APIDOC
## GET /api/projectiles/pickRadius

### Description
Gets the pick radius of the projectile.

### Method
GET

### Endpoint
/api/projectiles/pickRadius

### Response
#### Success Response (200)
- **float** (float) - The pick radius.

#### Response Example
```json
{
  "float": 1.0
}
```
```

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

### Main Class - createServerConfig Method

Source: https://mappings.dev/1.21.8/net/minecraft/server/Main.html

Handles the creation or loading of the server's initialization configuration, including world data and server properties.

```APIDOC
## private static WorldLoader$InitConfig createServerConfig(ServerPropertiesHandler serverPropertiesHandler, com.mojang.serialization.Dynamic<?> dynamic, boolean safeMode, ResourcePackManager dataPackManager)

### Description
Loads or creates the server's initialization configuration.

### Method
POST

### Endpoint
/server/config

### Parameters
#### Query Parameters
- **serverPropertiesHandler** (ServerPropertiesHandler) - Required - Handler for server properties.
- **dynamic** (com.mojang.serialization.Dynamic<?>) - Required - Dynamic configuration data.
- **safeMode** (boolean) - Required - Flag to enable safe mode.
- **dataPackManager** (ResourcePackManager) - Required - Manages resource packs.

### Request Example
```json
{
  "example": "{\"serverPropertiesHandler\": {}, \"dynamic\": {}, \"safeMode\": true, \"dataPackManager\": {}}"
}
```

### Response
#### Success Response (200)
- **WorldLoader$InitConfig** - The initialized server configuration object.

#### Response Example
```json
{
  "example": "WorldLoader$InitConfig object details"
}
```
```

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

### NbtCompound Get Methods

Source: https://mappings.dev/1.21.8/net/minecraft/nbt/CompoundTag.html

Methods for getting data from the NbtCompound using codecs.

```APIDOC
## GET /websites/mappings_dev_1_21_8/get

### Description
Retrieves a value from the NbtCompound using a key and Codec.

### Method
GET

### Endpoint
/websites/mappings_dev_1_21_8/get

### Parameters
#### Query Parameters
- **key** (String) - Required - The key of the value to retrieve.
- **codec** (com.mojang.serialization.Codec<T>) - Required - The codec to use for deserialization.

### Response
#### Success Response (200)
- **Optional<T>** - An Optional containing the retrieved value, or empty if not found.

## GET /websites/mappings_dev_1_21_8/read

### Description
Reads a value from the NbtCompound using a key and Codec.

### Method
GET

### Endpoint
/websites/mappings_dev_1_21_8/read

### Parameters
#### Query Parameters
- **arg0** (String) - Required - The key of the value to read.
- **arg1** (com.mojang.serialization.Codec<T>) - Required - The codec to use for deserialization.

### Response
#### Success Response (200)
- **Optional<T>** - An Optional containing the read value, or empty if not found.

## GET /websites/mappings_dev_1_21_8/method_67491

### Description
Internal method for reading a value with a key and Codec.

### Method
GET

### Endpoint
/websites/mappings_dev_1_21_8/method_67491

### Parameters
#### Query Parameters
- **arg0** (String) - Required - The key of the value to read.
- **arg1** (com.mojang.serialization.Codec<T>) - Required - The codec to use for deserialization.

### Response
#### Success Response (200)
- **Optional<T>** - An Optional containing the read value, or empty if not found.

## GET /websites/mappings_dev_1_21_8/get

### Description
Retrieves a value from the NbtCompound using a key and Codec.

### Method
GET

### Endpoint
/websites/mappings_dev_1_21_8/get

### Parameters
#### Query Parameters
- **key** (String) - Required - The key of the value to retrieve.
- **codec** (com.mojang.serialization.Codec<T>) - Required - The codec to use for deserialization.

### Response
#### Success Response (200)
- **Optional<T>** - An Optional containing the retrieved value, or empty if not found.

## GET /websites/mappings_dev_1_21_8/m_385169_

### Description
Internal method for getting a value with a key and Codec.

### Method
GET

### Endpoint
/websites/mappings_dev_1_21_8/m_385169_

### Parameters
#### Query Parameters
- **p_394504_** (String) - Required - The key of the value to retrieve.
- **arg1** (com.mojang.serialization.Codec<T>) - Required - The codec to use for deserialization.

### Response
#### Success Response (200)
- **Optional<T>** - An Optional containing the retrieved value, or empty if not found.
```

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

### QuickPlayLog Creation

Source: https://mappings.dev/1.21.8/net/minecraft/client/quickplay/QuickPlayLog.html

Demonstrates how to create an instance of QuickPlayLog using its static factory method.

```APIDOC
## POST /api/quickplay/log/create

### Description
Creates a new `QuickPlayLog` instance. This method is typically used to initialize the logging mechanism for quick play features.

### Method
POST

### Endpoint
`/api/quickplay/log/create`

### Parameters
#### Query Parameters
- **relativePath** (String) - Required - The relative path where the log data will be stored.

### Request Example
```json
{
  "relativePath": "quickplay_logs/session1"
}
```

### Response
#### Success Response (200)
- **QuickPlayLog** (object) - A newly created `QuickPlayLog` instance.

#### Response Example
```json
{
  "logInstance": "<QuickPlayLog object reference>"
}
```
```

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

### Recording Start Time API

Source: https://mappings.dev/1.21.8/net/minecraft/util/profiling/jfr/parse/JfrStatsResult.html

Retrieves the instant when the recording or monitoring started.

```APIDOC
## GET /websites/mappings_dev_1_21_8/recordingStarted

### Description
Gets the timestamp indicating when the recording or monitoring session began.

### Method
GET

### Endpoint
/websites/mappings_dev_1_21_8/recordingStarted

### Response
#### Success Response (200)
- **startTime** (Instant) - The start time of the recording.

#### Response Example
```json
"2023-10-27T10:00:00Z"
```
```

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

### Library Initialization and Configuration

Source: https://mappings.dev/1.21.8/com/mojang/blaze3d/audio/Library.html

Methods for initializing the audio library, setting up devices, and configuring audio parameters.

```APIDOC
## POST /audio/library/init

### Description
Initializes the audio library with a specified device and directional audio settings.

### Method
POST

### Endpoint
/audio/library/init

### Parameters
#### Request Body
- **deviceSpecifier** (String) - Required - The identifier for the audio device to use.
- **directionalAudio** (boolean) - Required - Whether to enable directional audio.

### Request Example
{
  "deviceSpecifier": "default",
  "directionalAudio": true
}

### Response
#### Success Response (200)
- **status** (string) - Indicates successful initialization.

#### Response Example
{
  "status": "initialized"
}
```

```APIDOC
## GET /audio/library/defaultDeviceName

### Description
Retrieves the name of the default audio device.

### Method
GET

### Endpoint
/audio/library/defaultDeviceName

### Response
#### Success Response (200)
- **deviceName** (String) - The name of the default audio device.

#### Response Example
{
  "deviceName": "Built-in Audio Analog Stereo"
}
```

```APIDOC
## GET /audio/library/currentDeviceName

### Description
Retrieves the name of the currently active audio device.

### Method
GET

### Endpoint
/audio/library/currentDeviceName

### Response
#### Success Response (200)
- **deviceName** (String) - The name of the current audio device.

#### Response Example
{
  "deviceName": "NVIDIA High Definition Audio"
}
```

```APIDOC
## GET /audio/library/availableDevices

### Description
Retrieves a list of all available sound devices on the system.

### Method
GET

### Endpoint
/audio/library/availableDevices

### Response
#### Success Response (200)
- **devices** (List<String>) - A list of strings, where each string is the identifier of an available sound device.

#### Response Example
{
  "devices": [
    "Built-in Audio Analog Stereo",
    "NVIDIA High Definition Audio",
    "Headphones (Realtek USB Audio)"
  ]
}
```

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

### CraftPlanksTutorialStep Class Overview

Source: https://mappings.dev/1.21.8/net/minecraft/client/tutorial/CraftPlanksTutorialStep.html

Provides an overview of the CraftPlanksTutorialStep class, its fields, constructor, and methods.

```APIDOC
## Class: CraftPlanksTutorialStep

### Description
Represents a tutorial step in Minecraft focused on crafting planks.

### Fields
- **HINT_DELAY** (int) - private static final - Delay for hints.
- **DELAY** (int) - private static final - General delay.
- **CRAFT_TITLE** (Component) - private static final - Title for the crafting tutorial step.
- **TITLE** (Component) - private static final - Alias for CRAFT_TITLE.
- **CRAFT_DESCRIPTION** (Component) - private static final - Description for the crafting tutorial step.
- **DESCRIPTION** (Component) - private static final - Alias for CRAFT_DESCRIPTION.
- **tutorial** (Tutorial) - private - The tutorial manager instance.
- **manager** (Tutorial) - private - Alias for tutorial.
- **toast** (TutorialToast) - private - The tutorial toast instance.
- **timeWaiting** (int) - private - Counter for waiting time.
- **ticks** (int) - private - Alias for timeWaiting.

### Constructor
- **public CraftPlanksTutorialStep(Tutorial manager)**
  Initializes the tutorial step with a given tutorial manager.

### Methods
- **public void tick()**
  Called every tick to update the tutorial step's state.

- **public void clear()**
  Clears the tutorial step, likely resetting its state or removing associated UI elements.

- **public void onGetItem(ItemStack arg0)**
  Handles the event when an item is obtained by the player.

- **public void onSlotUpdate(ItemStack arg0)**
  Handles the event when an item in a slot is updated.

- **public static boolean hasCraftedPlanksPreviously(LocalPlayer arg0, TagKey<Item> arg1)**
  Checks if the player has previously crafted planks.

- **public static boolean hasCrafted(ClientPlayerEntity player, TagKey<Item> tag)**
  Checks if the player has crafted items associated with the given tag.
```

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

### Substring Extraction (Start Index)

Source: https://mappings.dev/1.21.8/net/minecraft/server/commands/data/DataCommands.html

Methods for extracting substrings from a given start index.

```APIDOC
## Substring Extraction (Start Index)

### Description
Methods for extracting substrings from a given start index.

### Methods
- `substring(String arg0, int arg1)`
- `substring(String string, int startIndex)`
- `method_51825(String arg0, int arg1)`
- `m_287230_(String p_287744_, int p_287741_)

```

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

### Debug Command Execution - Start

Source: https://mappings.dev/1.21.8/net/minecraft/server/commands/DebugCommand.html

This snippet details the execution of the start command for debugging.

```APIDOC
## POST /debug/start

### Description
Starts the debugging process.

### Method
POST

### Endpoint
/debug/start

### Parameters
#### Query Parameters
- **source** (CommandSourceStack) - Required - The source of the command execution.

### Request Example
```json
{
  "source": "CommandSourceStack"
}
```

### Response
#### Success Response (200)
- **status** (int) - The status code indicating the result of the start operation.

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

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

### setupFog

Source: https://mappings.dev/1.21.8/net/minecraft/client/renderer/fog/environment/PowderedSnowFogEnvironment.html

Sets up the fog parameters for rendering, including start and end distances, based on the entity and environment.

```APIDOC
## setupFog(FogData arg0, Entity arg1, BlockPos arg2, ClientLevel arg3, float arg4, DeltaTracker arg5)

### Description
Configures the fog rendering properties such as density, start, and end distances. This method is called during the rendering process to apply specific fog effects.

### Method
public void

### Parameters
* **arg0** (hnl) - FogData object containing fog-related information.
* **arg1** (bzm) - The entity for which fog is being rendered.
* **arg2** (jb) - The block position.
* **arg3** (grk) - The client level.
* **arg4** (float) - A float representing partial ticks or interpolation factor.
* **arg5** (ftu) - DeltaTracker for frame timing.
```

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

### QuickPlay Class Methods

Source: https://mappings.dev/1.21.8/net/minecraft/client/quickplay/QuickPlay.html

This section outlines the various methods within the QuickPlay class for starting different types of game sessions.

```APIDOC
## QuickPlay Class Methods

### Description
Provides methods to start singleplayer, multiplayer, and Realms worlds.

### Methods

#### `startQuickPlay`

- **Description**: Initiates a quick play session.
- **Method**: `public static void`
- **Parameters**:
  - `client` (MinecraftClient) - The main Minecraft client instance.
  - `variant` (RunArgs$QuickPlayVariant) - The variant of the quick play session.
  - `realmsClient` (RealmsClient) - The client for interacting with Realms.

#### `getLatestSingleplayerWorld`

- **Description**: Retrieves the name of the latest singleplayer world.
- **Method**: `private static String`
- **Parameters**:
  - `storage` (LevelStorageSource) - The storage source for levels.
- **Returns**: The name of the latest singleplayer world.

#### `joinSingleplayerWorld`

- **Description**: Joins a specified singleplayer world.
- **Method**: `private static void`
- **Parameters**:
  - `client` (MinecraftClient) - The main Minecraft client instance.
  - `levelName` (String) - The name of the level to join.

#### `startSingleplayer`

- **Description**: Starts a singleplayer game session.
- **Method**: `private static void`
- **Parameters**:
  - `client` (MinecraftClient) - The main Minecraft client instance.
  - `levelName` (String) - The name of the level to start.

#### `joinMultiplayerWorld`

- **Description**: Joins a specified multiplayer world.
- **Method**: `private static void`
- **Parameters**:
  - `client` (MinecraftClient) - The main Minecraft client instance.
  - `serverAddress` (String) - The address of the multiplayer server.

#### `startMultiplayer`

- **Description**: Starts a multiplayer game session.
- **Method**: `private static void`
- **Parameters**:
  - `client` (MinecraftClient) - The main Minecraft client instance.
  - `serverAddress` (String) - The address of the multiplayer server.

#### `joinRealmsWorld`

- **Description**: Joins a specified Realms world.
- **Method**: `private static void`
- **Parameters**:
  - `client` (MinecraftClient) - The main Minecraft client instance.
  - `realmsClient` (RealmsClient) - The client for interacting with Realms.
  - `realmId` (String) - The ID of the Realms world to join.

#### `startRealms`

- **Description**: Starts a Realms game session.
- **Method**: `private static void`
- **Parameters**:
  - `client` (MinecraftClient) - The main Minecraft client instance.
  - `realmsClient` (RealmsClient) - The client for interacting with Realms.
  - `realmId` (String) - The ID of the Realms world to start.
```

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

### NbtCompound Get with DynamicOps

Source: https://mappings.dev/1.21.8/net/minecraft/nbt/CompoundTag.html

Methods for getting data from the NbtCompound using a Codec, DynamicOps, and a key.

```APIDOC
## GET /websites/mappings_dev_1_21_8/get

### Description
Retrieves a value from the NbtCompound using a key, Codec, and DynamicOps.

### Method
GET

### Endpoint
/websites/mappings_dev_1_21_8/get

### Parameters
#### Query Parameters
- **key** (String) - Required - The key of the value to retrieve.
- **codec** (com.mojang.serialization.Codec<T>) - Required - The codec to use for deserialization.
- **ops** (com.mojang.serialization.DynamicOps<NbtElement>) - Required - The DynamicOps to use.

### Response
#### Success Response (200)
- **Optional<T>** - An Optional containing the retrieved value, or empty if not found.

## GET /websites/mappings_dev_1_21_8/read

### Description
Reads a value from the NbtCompound using a key, Codec, and DynamicOps.

### Method
GET

### Endpoint
/websites/mappings_dev_1_21_8/read

### Parameters
#### Query Parameters
- **arg0** (String) - Required - The key of the value to read.
- **arg1** (com.mojang.serialization.Codec<T>) - Required - The codec to use for deserialization.
- **arg2** (com.mojang.serialization.DynamicOps<Tag>) - Required - The DynamicOps to use.

### Response
#### Success Response (200)
- **Optional<T>** - An Optional containing the read value, or empty if not found.

## GET /websites/mappings_dev_1_21_8/method_67492

### Description
Internal method for reading a value with a key, Codec, and DynamicOps.

### Method
GET

### Endpoint
/websites/mappings_dev_1_21_8/method_67492

### Parameters
#### Query Parameters
- **arg0** (String) - Required - The key of the value to read.
- **arg1** (com.mojang.serialization.Codec<T>) - Required - The codec to use for deserialization.
- **arg2** (com.mojang.serialization.DynamicOps<class_2520>) - Required - The DynamicOps to use.

### Response
#### Success Response (200)
- **Optional<T>** - An Optional containing the read value, or empty if not found.

## GET /websites/mappings_dev_1_21_8/get

### Description
Retrieves a value from the NbtCompound using a key, Codec, and DynamicOps.

### Method
GET

### Endpoint
/websites/mappings_dev_1_21_8/get

### Parameters
#### Query Parameters
- **key** (String) - Required - The key of the value to retrieve.
- **codec** (com.mojang.serialization.Codec<T>) - Required - The codec to use for deserialization.
- **ops** (com.mojang.serialization.DynamicOps<NbtElement>) - Required - The DynamicOps to use.

### Response
#### Success Response (200)
- **Optional<T>** - An Optional containing the retrieved value, or empty if not found.

## GET /websites/mappings_dev_1_21_8/m_387470_

### Description
Internal method for getting a value with a key, Codec, and DynamicOps.

### Method
GET

### Endpoint
/websites/mappings_dev_1_21_8/m_387470_

### Parameters
#### Query Parameters
- **p_397476_** (String) - Required - The key of the value to retrieve.
- **p_395097_** (com.mojang.serialization.Codec<T>) - Required - The codec to use for deserialization.
- **arg2** (com.mojang.serialization.DynamicOps<C_4950_>) - Required - The DynamicOps to use.

### Response
#### Success Response (200)
- **Optional<T>** - An Optional containing the retrieved value, or empty if not found.
```

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

### Get Sky Darken

Source: https://mappings.dev/1.21.8/net/minecraft/client/multiplayer/ClientLevel.html

Gets the current darkening value of the sky, which affects overall brightness.

```APIDOC
## GET /websites/mappings_dev_1_21_8/getSkyDarken

### Description
Gets the current darkening value of the sky, which affects overall brightness.

### Method
GET

### Endpoint
/websites/mappings_dev_1_21_8/getSkyDarken

### Parameters
#### Query Parameters
- **arg0** (float) - Required - The tick progress, typically between 0.0 and 1.0.

### Response
#### Success Response (200)
- **darkenValue** (float) - The sky darkening value.

#### Response Example
```json
{
  "darkenValue": 0.5
}
```
```

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

### TextureSetup Class Overview

Source: https://mappings.dev/1.21.8/net/minecraft/client/gui/render/TextureSetup.html

Provides an overview of the TextureSetup class, its fields, and constructors.

```APIDOC
## TextureSetup Class

### Description
Manages texture configurations for rendering, allowing for single, double, or no texture setups.

### Fields
- **a** (GpuTextureView) - Represents the first texture.
- **b** (GpuTextureView) - Represents the second texture.
- **c** (GpuTextureView) - Represents the third texture.
- **d** (TextureSetup) - A static field representing no texture setup.
- **e** (int) - A seed used for sorting textures.

### Constructors
- **public (GpuTextureView texure1, GpuTextureView texure2, GpuTextureView arg2)**: Constructs a TextureSetup with three GpuTextureView objects.
```

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

### Request$Get Class Overview

Source: https://mappings.dev/1.21.8/com/mojang/realmsclient/client/Request%24Get.html

Provides an overview of the Request$Get class, its constructors, and methods.

```APIDOC
## Request$Get Class

### Description
Represents a GET request in the Realms client.

### Constructor Summary
#### `public Request$Get(String p_87366_, int p_87367_, int arg2)`
- **p_87366_** (String) - Required - Description for p_87366_
- **p_87367_** (int) - Required - Description for p_87367_
- **arg2** (int) - Required - Description for arg2

### Method Summary
#### `public Request$Get f()`
- Description: Method f

#### `doConnect()`
- Description: Method doConnect

#### `method_21058()`
- Description: Method method_21058

#### `doConnect()`
- Description: Method doConnect (overloaded or duplicate entry)

#### `m_7218_()`
- Description: Method m_7218_
```

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

### StructureStart Class Overview

Source: https://mappings.dev/1.21.8/net/minecraft/world/level/levelgen/structure/StructureStart.html

Provides an overview of the StructureStart class, including its fields, constructor, and methods.

```APIDOC
## StructureStart Class

### Description
Represents the starting point of a structure in the world, managing its pieces and bounding box.

### Fields
- **INVALID_START_ID** (String) - Represents an invalid start ID.
- **INVALID_START** (StructureStart) - A static instance representing an invalid start.
- **LOGGER** (org.slf4j.Logger) - Logger for the StructureStart class.
- **structure** (Structure) - The structure this start belongs to.
- **pieceContainer** (PiecesContainer) - The container for the structure's pieces.
- **chunkPos** (ChunkPos) - The chunk position of this structure start.
- **references** (int) - The number of references to this structure start.
- **cachedBoundingBox** (BoundingBox) - The cached bounding box of the structure.

### Constructor
- **public StructureStart(Structure structure, ChunkPos pos, int references, PiecesContainer children)**
  Initializes a new StructureStart.

### Methods
- **public static StructureStart fromNbt(StructureContext context, NbtCompound nbt, long seed)**
  Loads a StructureStart from NBT data.
- **public BoundingBox getBoundingBox()**
  Gets the bounding box of the structure.
- **public void place(WorldGenLevel world, StructureAccessor structureAccessor, ChunkGenerator chunkGenerator, Random random, BlockBox chunkBox, ChunkPos chunkPos)**
  Places the structure in the world.
- **public CompoundTag toNbt(StructureContext context, ChunkPos chunkPos)**
  Saves the StructureStart to NBT data.
- **public boolean isValid()**
  Checks if the structure start is valid.
- **public ChunkPos getChunkPos()**
  Gets the chunk position of the structure start.
- **public boolean canBeReferenced()**
  Checks if this structure can be referenced by other structures.
- **public void addReference()**
  Increments the reference count for this structure start.
- **protected int getMaxReferences()**
  Gets the maximum number of references allowed.
- **public Structure getStructure()**
  Gets the Structure object associated with this start.
- **public List<StructurePiece> getPieces()**
  Gets the list of structure pieces in this start.
```

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

### StartAdmiringItemIfSeen Class

Source: https://mappings.dev/1.21.8/net/minecraft/world/entity/monster/piglin/StartAdmiringItemIfSeen.html

Details about the StartAdmiringItemIfSeen class, its constructor, and methods.

```APIDOC
## Class: StartAdmiringItemIfSeen

### Description
Represents the behavior for a piglin entity to start admiring an item it has seen.

### Constructor Summary
| Modifier | Constructor |
|---|---|
| public | () |

### Method Summary
| Modifier and Type | Method |
|---|---|
| public static BehaviorControl<LivingEntity> | a(int arg0) |
| | create(int arg0) |
| | method_47279(int arg0) |
| | create(int duration) |
| | m_257667_(int p_259418_) |

### Related Classes
- net.minecraft.world.entity.monster.piglin.StartAdmiringItemIfSeen
- net.minecraft.class_4823
- net.minecraft.entity.ai.brain.task.AdmireItemTask
- net.minecraft.src.C_1107_
- net.minecraft.world.entity.monster.piglin.BehaviorStartAdmiringItem
```

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

### StateDefinition Static Method Example

Source: https://mappings.dev/1.21.8/net/minecraft/world/level/block/state/StateDefinition.html

Example of a static method within StateDefinition for appending property codecs.

```APIDOC
## StateDefinition Static Methods

### Method Summary

- **`private static <S extends StateHolder<?, S>, T extends Comparable<T>> com.mojang.serialization.MapCodec<S> appendPropertyCodec(com.mojang.serialization.MapCodec<S> mapCodec, Supplier<S> defaultStateGetter, String key, Property<T> property)`**: Appends a property codec to a given map codec.
```

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

### RuinedPortalStructure$Setup Record

Source: https://mappings.dev/1.21.8/net/minecraft/world/level/levelgen/structure/structures/RuinedPortalStructure%24Setup.html

Details about the RuinedPortalStructure$Setup record, including its fields, constructor, and accessor methods.

```APIDOC
## RuinedPortalStructure$Setup Record

### Description
Represents the configuration settings for generating ruined portal structures, including parameters that influence their placement and appearance.

### Fields
- **placement** (RuinedPortalPiece$VerticalPlacement) - Represents the vertical placement of the ruined portal.
- **airPocketProbability** (float) - The probability of air pockets appearing within the structure.
- **mossiness** (float) - Controls the amount of moss covering the structure.
- **overgrown** (boolean) - Indicates if the structure is overgrown with vegetation.
- **vines** (boolean) - Determines if vines are present on the structure.
- **canBeCold** (boolean) - Specifies if the structure can be in a cold biome.
- **replaceWithBlackstone** (boolean) - If true, replaces certain blocks with blackstone.
- **weight** (float) - The generation weight of this setup.

### Constructor
- **public** (RuinedPortalPiece$VerticalPlacement airPocketProbability, float mossiness, float overgrown, boolean vines, boolean canBeCold, boolean replaceWithBlackstone, boolean weight, float arg7)
  - Initializes a new instance of the RuinedPortalStructure$Setup record with the specified parameters.

### Methods
- **placement()** (RuinedPortalPiece$VerticalPlacement)
  - Returns the vertical placement configuration.
- **airPocketProbability()** (float)
  - Returns the probability of air pockets.
- **mossiness()** (float)
  - Returns the mossiness value.
- **overgrown()** (boolean)
  - Returns whether the structure is overgrown.
- **vines()** (boolean)
  - Returns whether vines are present.
- **canBeCold()** (boolean)
  - Returns whether the structure can be in a cold biome.
- **replaceWithBlackstone()** (boolean)
  - Returns whether to replace blocks with blackstone.
- **weight()** (float)
  - Returns the generation weight.

### Static Fields
- **CODEC** (com.mojang.serialization.Codec<RuinedPortalStructure$Setup>)
  - A codec for serializing and deserializing RuinedPortalStructure$Setup objects.
```

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

### TutorialToast Class Overview

Source: https://mappings.dev/1.21.8/net/minecraft/client/gui/components/toasts/TutorialToast.html

Provides an overview of the TutorialToast class, including its fields, constructors, and methods.

```APIDOC
## Class: TutorialToast

### Description
Represents a toast message specifically for tutorials in the Minecraft client.

### Fields
- **BACKGROUND_SPRITE** (ResourceLocation) - Static final field for the background sprite.
- **TEXTURE** (ResourceLocation) - Static final field for the texture.
- **PROGRESS_BAR_WIDTH** (int) - Static final field for the progress bar width.
- **PROGRESS_BAR_HEIGHT** (int) - Static final field for the progress bar height.
- **PROGRESS_BAR_X** (int) - Static final field for the progress bar X coordinate.
- **PROGRESS_BAR_MARGIN_BOTTOM** (int) - Static final field for the margin at the bottom of the progress bar.
- **PADDING_TOP** (int) - Static final field for top padding.
- **PADDING_BOTTOM** (int) - Static final field for bottom padding.
- **LINE_SPACING** (int) - Static final field for line spacing.
- **TEXT_LEFT** (int) - Static final field for the left text offset.
- **TEXT_WIDTH** (int) - Static final field for the text width.
- **icon** (TutorialToast$Icons) - The icon associated with the toast.
- **lines** (List<FormattedCharSequence>) - The list of text lines to display.
- **visibility** (Toast$Visibility) - The current visibility state of the toast.
- **lastSmoothingTime** (long) - The timestamp of the last smoothing update.
- **smoothedProgress** (float) - The smoothed progress value.
- **progress** (float) - The current progress value.
- **progressable** (boolean) - Flag indicating if the toast has a progress bar.
- **timeToDisplayMs** (int) - The duration in milliseconds the toast should be displayed.

### Constructors
- **public TutorialToast(Font textRenderer, TutorialToast$Icons type, Component title, Component description, boolean hasProgressBar, int displayDuration)**: Constructor with all parameters.
- **public TutorialToast(Font textRenderer, TutorialToast$Icons type, Component title, Component description, boolean hasProgressBar)**: Constructor without display duration.

### Methods
- **public Toast$Visibility getWantedVisibility()**: Returns the desired visibility state of the toast.
- **public void update(ToastManager arg0, long arg1)**: Updates the toast's state.
- **public int height()**: Returns the height of the toast.
- **private int contentHeight()**: Calculates the content height of the toast.
- **public void render(GuiGraphics arg0, Font arg1, long arg2)**: Renders the toast.
- **public void hide()**: Hides the toast.
- **public void updateProgress(float arg0)**: Updates the progress of the toast.

```

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

### ConstantValue.getType

Source: https://mappings.dev/1.21.8/net/minecraft/world/level/storage/loot/providers/number/ConstantValue.html

Gets the LootNumberProviderType for this ConstantValue.

```APIDOC
## public LootNumberProviderType getType()

### Description
Returns the registered type of this NumberProvider.

### Returns
* (LootNumberProviderType) - The type of this provider.
```

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

### StrongholdPieces$StartPiece Class Overview

Source: https://mappings.dev/1.21.8/net/minecraft/world/level/levelgen/structure/structures/StrongholdPieces%24StartPiece.html

Provides an overview of the StrongholdPieces$StartPiece class, including its inheritance, fields, constructors, and methods.

```APIDOC
## Class: StrongholdPieces$StartPiece

### Description
Represents the starting piece of a stronghold in Minecraft's world generation.

### Inheritance
Extends `StrongholdPieces$StairsDown`.

### Fields
#### Field Summary
- `a` (StrongholdPieces$PieceWeight): Represents a piece weight.
- `previousPiece` (StrongholdPieces$PieceWeight): Alias for `a`.
- `field_15284` (StrongholdPieces$PieceWeight): Alias for `a`.
- `lastPiece` (StrongholdPieces$PieceWeight): Alias for `a`.
- `f_229797_` (StrongholdPieces$PieceWeight): Alias for `a`.
- `b` (StrongholdPieces$PortalRoom): Represents a portal room piece.
- `portalRoomPiece` (StrongholdPieces$PortalRoom): Alias for `b`.
- `field_15283` (StrongholdPieces$PortalRoom): Alias for `b`.
- `portalRoom` (StrongholdPieces$PortalRoom): Alias for `b`.
- `f_229798_` (StrongholdPieces$PortalRoom): Alias for `b`.
- `c` (List<StructurePiece>): A list of pending child pieces.
- `pendingChildren` (List<StructurePiece>): Alias for `c`.
- `field_15282` (List<StructurePiece>): Alias for `c`.
- `pieces` (List<StructurePiece>): Alias for `c`.
- `f_229799_` (List<StructurePiece>): Alias for `c`.

### Constructors
#### Constructor Summary
- `public (RandomSource random, int p_229803_, int arg2)`: Constructor for creating a new StartPiece.
- `public (CompoundTag arg0)`: Constructor for creating a StartPiece from a CompoundTag.

### Methods
#### Method Summary
- `h()` (BlockPos): Returns the locator position.
- `getLocatorPosition()` (BlockPos): Alias for `h()`.
- `method_35458()` (BlockPos): Alias for `h()`.
- `getCenter()` (BlockPos): Returns the center position of the piece.
- `m_142171_()` (BlockPos): Alias for `getCenter()`.
```

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

### TextureSetup Instance Methods

Source: https://mappings.dev/1.21.8/net/minecraft/client/gui/render/TextureSetup.html

Details the instance methods for accessing texture information and sort keys.

```APIDOC
## TextureSetup Instance Methods

### Description
Provides methods to retrieve texture views and the sort key from a TextureSetup instance.

### Methods

#### `getSortKey()`
- **Method**: `public int b()`
- **Description**: Returns the sort key for this texture setup.

#### `texure0()`
- **Method**: `public GpuTextureView d()`
- **Description**: Returns the first GpuTextureView.

#### `texure1()`
- **Method**: `public GpuTextureView e()`
- **Description**: Returns the second GpuTextureView.

#### `texure2()`
- **Method**: `public GpuTextureView f()`
- **Description**: Returns the third GpuTextureView.
```

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

### Get Entities

Source: https://mappings.dev/1.21.8/net/minecraft/world/level/chunk/storage/SerializableChunkData.html

Retrieves entity data.

```APIDOC
## GET /websites/mappings_dev_1_21_8/entities

### Description
Retrieves entity data.

### Method
GET

### Endpoint
/websites/mappings_dev_1_21_8/entities

### Response
#### Success Response (200)
- **entities** (List<CompoundTag>) - The entity data.
```

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

### Get Heightmaps

Source: https://mappings.dev/1.21.8/net/minecraft/world/level/chunk/storage/SerializableChunkData.html

Retrieves heightmap data.

```APIDOC
## GET /websites/mappings_dev_1_21_8/heightmaps

### Description
Retrieves heightmap data.

### Method
GET

### Endpoint
/websites/mappings_dev_1_21_8/heightmaps

### Response
#### Success Response (200)
- **heightmaps** (Map<Heightmap$Types, long[]>) - The heightmap data.
```

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

### RecipeDisplays Class Overview

Source: https://mappings.dev/1.21.8/net/minecraft/world/item/crafting/display/RecipeDisplays.html

Provides an overview of the RecipeDisplays class, its constructors, and methods.

```APIDOC
## Class: RecipeDisplays

### Description
Represents recipe display functionalities within the game.

### Constructor Summary
- **public ()**: Default constructor for RecipeDisplays.

### Method Summary
- **public static RecipeDisplay$Type<?> a(jy<dis$a<?>> arg0)**: A method that likely returns a recipe display type based on the provided argument.
- **bootstrap(Registry<RecipeDisplay$Type<?>> arg0)**: Initializes and registers recipe display types with the given registry.
- **method_64731(class_2378<class_10295$class_10296<?>> arg0)**: An internal method related to recipe display processing.
- **registerAndGetDefault(Registry<RecipeDisplay$Serializer<?>> registry)**: Registers recipe display serializers and returns the default one.
- **m_352791_(C_4705_<C_345908_$C_345592_<?>> p_368196_)**: An internal method with complex generic types.
```

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

### Get CharSequence

Source: https://mappings.dev/1.21.8/net/minecraft/network/FriendlyByteBuf.html

Reads a CharSequence from the ByteBuf.

```APIDOC
## GET /api/bytebuf/getCharSequence

### Description
Reads a CharSequence from the ByteBuf at a specified index and length, using a given charset.

### Method
GET

### Endpoint
/api/bytebuf/getCharSequence

### Parameters
#### Query Parameters
- **index** (int) - Required - The starting index in the ByteBuf.
- **length** (int) - Required - The length of the CharSequence to read.
- **charset** (Charset) - Required - The character set to use for decoding.

### Response
#### Success Response (200)
- **charSequence** (CharSequence) - The decoded CharSequence.
```

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

### setupFog

Source: https://mappings.dev/1.21.8/net/minecraft/client/renderer/fog/environment/DimensionOrBossFogEnvironment.html

Applies fog settings based on provided data, entity, position, world, and rendering parameters.

```APIDOC
## public void setupFog(FogData arg0, Entity arg1, BlockPos arg2, ClientLevel arg3, float arg4, DeltaTracker arg5)

### Description
Applies fog settings based on provided data, entity, position, world, and rendering parameters.

### Method
public void

### Parameters
- **arg0** (FogData) - Description not available
- **arg1** (Entity) - Description not available
- **arg2** (BlockPos) - Description not available
- **arg3** (ClientLevel) - Description not available
- **arg4** (float) - Description not available
- **arg5** (DeltaTracker) - Description not available
```
Tokens:
Raw