Minecraft Mappings 1.20.4

https://mappings.dev/1.20.4
Admin
Minecraft Mappings is a deobfuscation mapping project that provides human-readable names for...
Tokens:4,018,090
Snippets:18,448
Trust Score:5.2
Update:10 months ago
Show doc for...
Tokens:
Raw
### QuickPlay - Start Multiplayer

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

Starts a multiplayer session by joining a server.

```APIDOC
## private static void startMultiplayer(MinecraftClient client, String serverAddress)

### Description
This method initiates a multiplayer session by attempting to join the specified server address.

### Method
POST

### Endpoint
/quickplay/multiplayer/start

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **client** (MinecraftClient) - Required - The Minecraft client instance.
- **serverAddress** (String) - Required - The network address of the multiplayer server.

### Request Example
```json
{
  "client": "<MinecraftClient object>",
  "serverAddress": "mc.hypixel.net"
}
```

### Response
#### Success Response (200)
This method returns void upon successful initiation.

#### Response Example
None (void return type)
```

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

### QuickPlay - Start Singleplayer

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

Starts a singleplayer world session.

```APIDOC
## private static void startSingleplayer(MinecraftClient client, String levelName)

### Description
This method initiates a singleplayer world session with the specified client and level name.

### Method
POST

### Endpoint
/quickplay/singleplayer/start

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **client** (MinecraftClient) - Required - The Minecraft client instance.
- **levelName** (String) - Required - The name of the singleplayer world to start.

### Request Example
```json
{
  "client": "<MinecraftClient object>",
  "levelName": "MySingleplayerWorld"
}
```

### Response
#### Success Response (200)
This method returns void upon successful initiation.

#### Response Example
None (void return type)
```

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

### QuickPlay - Start Realms

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

Starts a session by joining a specific Realm.

```APIDOC
## private static void startRealms(MinecraftClient client, RealmsClient realmsClient, String realmId)

### Description
This method initiates a session by joining a specific Realm, identified by its ID.

### Method
POST

### Endpoint
/quickplay/realms/start

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **client** (MinecraftClient) - Required - The Minecraft client instance.
- **realmsClient** (RealmsClient) - Required - The client for interacting with Realms.
- **realmId** (String) - Required - The unique identifier for the Realm to join.

### Request Example
```json
{
  "client": "<MinecraftClient object>",
  "realmsClient": "<RealmsClient object>",
  "realmId": "your-realm-id-123"
}
```

### Response
#### Success Response (200)
This method returns void upon successful initiation.

#### Response Example
None (void return type)
```

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

### Start Profiling

Source: https://mappings.dev/1.20.4/net/minecraft/server/commands/PerfCommand

Starts a server profiling session. This command begins collecting performance data from the server.

```APIDOC
## POST /perf/start

### Description
Starts a server profiling session. This command begins collecting performance data from the server.

### Method
POST

### Endpoint
/perf/start

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

### Request Example
```json
{
  "source": "<command_source_object>"
}
```

### Response
#### Success Response (200)
- **message** (string) - Indicates that profiling has started.

#### Response Example
```json
{
  "message": "Profiling started."
}
```
```

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

### Start Integrated Server

Source: https://mappings.dev/1.20.4/net/minecraft/client/Minecraft

Starts a new integrated server for single-player or local multiplayer.

```APIDOC
## POST /websites/mappings_dev_1_20_4/startIntegratedServer

### Description
Launches a local server instance, often used for single-player gameplay.

### Method
POST

### Endpoint
/websites/mappings_dev_1_20_4/startIntegratedServer

#### Parameters
##### Request Body
- **session** (LevelStorage$Session) - Required - The storage session for the world.
- **dataPackManager** (PackRepository) - Required - Manages data packs.
- **saveLoader** (SaveLoader) - Required - Handles world saving and loading.
- **newWorld** (boolean) - Required - Indicates if a new world should be created.
```

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

### Get Examples

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

Retrieves a collection of example mappings. This can be used to demonstrate valid mapping formats.

```APIDOC
## GET /websites/mappings/examples

### Description
Retrieves a collection of example mappings. This can be used to demonstrate valid mapping formats.

### Method
GET

### Endpoint
`/websites/mappings_dev_1_20_4/examples`

### Parameters
None

### Request Example
```
(No request body for GET requests)
```

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

#### Response Example
```json
{
  "examples": [
    "example_mapping_1",
    "example_mapping_2"
  ]
}
```
```

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

### Setup Methods

Source: https://mappings.dev/1.20.4/net/minecraft/client/Camera

Methods for setting up the initial state of the website mappings, including configuration of getters, entities, and camera properties.

```APIDOC
## POST /websites/mappings_dev_1_20_4/setup

### Description
Initializes the website mapping with the specified configuration. This method sets up the block getter, entity, and camera properties.

### Method
POST

### Endpoint
/websites/mappings_dev_1_20_4/setup

### Parameters
#### Request Body
- **blockGetter** (BlockGetter) - Required - The block getter to use.
- **entity** (Entity) - Required - The entity to associate with the mapping.
- **thirdPerson** (boolean) - Required - Initial third-person perspective setting.
- **inverseView** (boolean) - Required - Initial inverse view setting.
- **tickDelta** (float) - Required - The initial tick delta.

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the setup operation.

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

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

### Get Starting Axis Coordinate (Java)

Source: https://mappings.dev/1.20.4/net/minecraft/world/phys/shapes/DiscreteVoxelShape

Finds the starting coordinate for a given range along a specific axis. This method is equivalent to 'firstFull' with range parameters.

```Java
public int getStartingAxisCoord(Direction$Axis axis, int from, int to)
```

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

### Server Initialization and Setup

Source: https://mappings.dev/1.20.4/net/minecraft/client/server/IntegratedServer

Methods related to initializing and setting up the server environment.

```APIDOC
## Server Initialization and Setup API

### Description
This group of endpoints handles the initial setup and configuration of the game server.

### Endpoints

- **POST /api/server/init**
  Initializes the server.

- **POST /api/server/setup**
  Configures server settings.
```

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

### QuickPlay - Start Quick Play Session

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

Initiates a quick play session with the provided game configuration.

```APIDOC
## public static void startQuickPlay(MinecraftClient client, RunArgs$QuickPlay quickPlay, RealmsClient realmsClient)

### Description
This method starts a quick play session using the provided Minecraft client, quick play data, and Realms client.

### Method
POST

### Endpoint
/quickplay/start

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **client** (MinecraftClient) - Required - The Minecraft client instance.
- **quickPlay** (RunArgs$QuickPlay) - Required - Data related to the quick play session.
- **realmsClient** (RealmsClient) - Required - The client for interacting with Realms.

### Request Example
```json
{
  "client": "<MinecraftClient object>",
  "quickPlay": {
    "<QuickPlayData fields>"
  },
  "realmsClient": "<RealmsClient object>"
}
```

### Response
#### Success Response (200)
This method returns void upon successful initiation.

#### Response Example
None (void return type)
```

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

### Get Mountain Start Biome

Source: https://mappings.dev/1.20.4/net/minecraft/world/level/biome/OverworldBiomeBuilder

Determines the starting biome for mountain regions based on temperature and humidity. It utilizes MultiNoiseUtil$ParameterRange for environmental context.

```Java
getMountainStartBiome(int temperature, int humidity, MultiNoiseUtil$ParameterRange weirdness)
```

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

### StyleArgument: Get Examples (Java)

Source: https://mappings.dev/1.20.4/net/minecraft/commands/arguments/StyleArgument

Returns a collection of example strings demonstrating valid inputs for the StyleArgument. This is useful for command suggestions and user guidance.

```java
public Collection<String> getExamples() {
    // Implementation details for returning example style strings
    return java.util.Collections.emptyList(); // Placeholder
}
```

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

### Initialization and Configuration Methods

Source: https://mappings.dev/1.20.4/com/mojang/realmsclient/gui/screens/RealmsSlotOptionsScreen

Details methods related to initializing components and confirming actions, particularly for dangerous options.

```APIDOC
## Initialization and Configuration Methods

### Description
This section covers methods for initializing various components and handling user confirmations for potentially dangerous operations.

### Methods

#### `init()`
- **Description**: Initializes a component or system.
- **Method**: `POST` (conceptual)
- **Endpoint**: `/websites/mappings_dev_1_20_4/init`
- **Parameters**:
  - None

#### `confirmDangerousOption(Component component, Consumer<Boolean> valueSetter)`
- **Description**: Presents a confirmation dialog for a dangerous option and sets the provided consumer based on the user's choice.
- **Method**: `POST` (conceptual)
- **Endpoint**: `/websites/mappings_dev_1_20_4/confirmDangerousOption`
- **Parameters**:
  - **Request Body**:
    - `component` (Component) - Required - The component associated with the option.
    - `valueSetter` (Consumer<Boolean>) - Required - A consumer to handle the boolean result of the confirmation.

#### `getSpawnToggleButtonCallback(Text text, Consumer<Boolean> valueSetter)`
- **Description**: Returns a callback for a spawn toggle button, used to manage boolean state changes.
- **Method**: `GET` (conceptual)
- **Endpoint**: `/websites/mappings_dev_1_20_4/getSpawnToggleButtonCallback`
- **Parameters**:
  - **Query Parameters**:
    - `text` (Text) - Required - The text to display for the toggle button.
    - `valueSetter` (Consumer<Boolean>) - Required - The consumer to process the toggle's boolean value.

### Request Example (Conceptual for `confirmDangerousOption`)
```json
{
  "component": {"id": "confirmButton"},
  "valueSetter": "(newValue) => console.log(newValue)"
}
```

### Response Example (Conceptual for `confirmDangerousOption`)
```json
{
  "confirmationStatus": "confirmed"
}
```
```

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

### Server Initialization and Startup

Source: https://mappings.dev/1.20.4/net/minecraft/server/MinecraftServer

Methods related to starting and initializing the Minecraft server.

```APIDOC
## Server Initialization and Startup

### Description
Methods for starting, initializing, and setting up the Minecraft server environment.

### POST /server/start
#### Method
POST

#### Endpoint
`/server/start`

#### Parameters
##### Request Body
- **serverFactory** (Function<Thread, S>) - Required - A function to create and configure the server instance.

### Response
#### Success Response (200)
- **server** (MinecraftServer) - The initialized server instance.

#### Response Example
```json
{
  "server": "[Server Instance Object]"
}
```

## initServer()

### Description
Initializes the server components.

### Method
protected abstract boolean

### Endpoint
`initServer()`

## setupServer()

### Description
Sets up the server environment.

### Method
protected abstract boolean

### Endpoint
`setupServer()`

## createLevels(ChunkProgressListener)

### Description
Creates game levels or worlds with a progress listener.

### Method
protected void

### Endpoint
`createLevels(ChunkProgressListener arg0)`

## createWorlds(WorldGenerationProgressListener)

### Description
Creates worlds for the server, often used during initial setup.

### Method
protected void

### Endpoint
`createWorlds(WorldGenerationProgressListener worldGenerationProgressListener)`

## prepareLevels(ChunkProgressListener)

### Description
Prepares game levels before they are actively used.

### Method
private void

### Endpoint
`prepareLevels(ChunkProgressListener arg0)`

## runServer()

### Description
Starts the main server loop.

### Method
protected void

### Endpoint
`runServer()`

## waitUntilNextTick()

### Description
Waits until the next server tick to ensure synchronized operations.

### Method
protected void

### Endpoint
`waitUntilNextTick()`

## wrapRunnable(Runnable)

### Description
Wraps a Runnable task to be executed within the server's task system.

### Method
protected TickTask

### Endpoint
`wrapRunnable(Runnable arg0)`

## shouldRun(ServerTask)

### Description
Determines if a given server task should be executed.

### Method
protected boolean

### Endpoint
`shouldRun(ServerTask arg0)`

## pollTask()

### Description
Polls for and retrieves the next available task to execute.

### Method
public boolean

### Endpoint
`pollTask()`
```

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

### NbtPathArgument: Get Examples (Java)

Source: https://mappings.dev/1.20.4/net/minecraft/commands/arguments/NbtPathArgument

This public method returns a collection of example NBT paths. These examples are useful for command suggestions and providing users with guidance on how to format NBT paths correctly. They demonstrate valid syntax and common usage patterns.

```Java
public Collection<String> getExamples() {
    // Implementation details for returning example NBT paths
    return Collections.emptyList(); // Placeholder
}
```

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

### PrepareRamNearestTarget Start Method

Source: https://mappings.dev/1.20.4/net/minecraft/world/entity/ai/behavior/PrepareRamNearestTarget

The start method is called when the behavior begins execution. It is responsible for initiating the ramming sequence, likely involving the selection of a target and the initial setup for the ram.

```java
protected void a(and arg0, bmu arg1, long arg2)
| start(ServerLevel arg0, PathfinderMob arg1, long arg2)
| method_36260(class_3218 arg0, class_1314 arg1, long arg2)
```

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

### Tutorial Class Constructor

Source: https://mappings.dev/1.20.4/net/minecraft/client/tutorial/Tutorial

This constructor initializes a new instance of the Tutorial class. It requires the Minecraft client and options objects to be passed as arguments, setting up the tutorial system for the game.

```Java
public Tutorial(Minecraft client, Options options)
```

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

### ObjectiveArgument: Get Examples

Source: https://mappings.dev/1.20.4/net/minecraft/commands/arguments/ObjectiveArgument

Returns a collection of example objective names that can be used with this argument type. This is useful for explaining command usage and providing hints to players.

```java
public Collection<String> getExamples() {
    // Return predefined examples
    return ObjectiveArgument.EXAMPLES;
}
```

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

### Tutorial Class Methods - State Management

Source: https://mappings.dev/1.20.4/net/minecraft/client/tutorial/Tutorial

This snippet covers methods for managing the state of the tutorial. It includes starting and stopping the tutorial, creating and destroying handlers, and setting the current tutorial step.

```Java
public void stop()
public void createHandler()
public void start()
public void setStep(TutorialStep step)
```

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

### StructureStart Class Documentation

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

Provides details about the StructureStart class, including its fields, constructors, and methods.

```APIDOC
## Class: StructureStart

### Description
Represents the starting point of a structure in the world generation process. It manages the pieces that make up the structure and its bounding box.

### Fields
- **INVALID_START_ID** (String) - A constant representing an invalid structure start ID.
- **INVALID_START** (StructureStart) - A constant representing an invalid structure start.
- **LOGGER** (org.slf4j.Logger) - The logger instance for this class.
- **structure** (Structure) - The structure this start belongs to.
- **pieceContainer** (PiecesContainer) - The container holding all the pieces of the structure.
- **chunkPos** (ChunkPos) - The chunk coordinates where the structure starts.
- **references** (int) - The number of references to this structure start.
- **cachedBoundingBox** (BoundingBox) - The cached bounding box of the structure.

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

### Methods
- **fromNbt(StructureContext context, NbtCompound nbt, long seed)** (static)
  - Loads a StructureStart from NBT data.
- **getBoundingBox()**
  - Returns the bounding box of the structure.
- **place(StructureWorldAccess world, StructureAccessor structureAccessor, ChunkGenerator chunkGenerator, Random random, BlockBox chunkBox, ChunkPos chunkPos)**
  - Places the structure in the world.
- **toNbt(StructureContext context, ChunkPos chunkPos)**
  - Saves the StructureStart to NBT data.
- **isValid()**
  - Checks if the structure start is valid.
- **getChunkPos()**
  - Returns the chunk position of the structure start.
- **canBeReferenced()**
  - Checks if the structure can be referenced by other structures.
- **addReference()**
  - Increments the reference count for this structure start.
- **getReferences()**
  - Returns the number of references to this structure start.
- **getMaxReferences()**
  - Returns the maximum number of references allowed for this structure.
- **getStructure()**
  - Returns the Structure object this start belongs to.
- **getPieces()**
  - Returns a list of all structure pieces in this start.
```

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

### Get Dimension Examples (Java)

Source: https://mappings.dev/1.20.4/net/minecraft/commands/arguments/DimensionArgument

Retrieves a collection of example dimension names that can be used with the dimension argument. This is helpful for users trying to understand the expected input format.

```java
public Collection<String> getExamples()
```

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

### CreateFlatWorldScreen Methods

Source: https://mappings.dev/1.20.4/net/minecraft/client/gui/screens/CreateFlatWorldScreen

Provides documentation for various methods within the CreateFlatWorldScreen class, including configuration retrieval, updates, and rendering.

```APIDOC
## CreateFlatWorldScreen Methods

### Description
This section details the available methods for interacting with the `CreateFlatWorldScreen`, such as retrieving settings, updating UI elements, and rendering the screen.

### Method: settings()
#### Description
Returns the current flat level generator settings.

#### Method
`public FlatLevelGeneratorSettings`

#### Endpoint
N/A (Method call)

### Method: setConfig(FlatLevelGeneratorSettings arg0)
#### Description
Sets the flat level generator configuration.

#### Method
`public void`

#### Endpoint
N/A (Method call)

### Method: init()
#### Description
Initializes the screen's UI elements and components.

#### Method
`protected void`

#### Endpoint
N/A (Method call)

### Method: updateButtonValidity()
#### Description
Updates the validity state of buttons within the screen, likely related to layer manipulation.

#### Method
`void`

#### Endpoint
N/A (Method call)

### Method: hasValidSelection()
#### Description
Checks if the current selection within the screen is valid, possibly for layer editing.

#### Method
`private boolean`

#### Endpoint
N/A (Method call)

### Method: onClose()
#### Description
Handles the logic when the screen is closed.

#### Method
`public void`

#### Endpoint
N/A (Method call)

### Method: render(GuiGraphics arg0, int arg1, int arg2, float arg3)
#### Description
Renders the screen's graphical interface.

#### Method
`public void`

#### Endpoint
N/A (Method call)

### Request Example
```json
{
  "example": "// Example of calling methods within the game's context:
FlatLevelGeneratorSettings currentSettings = screen.settings();
screen.setConfig(newConfig);
screen.init();
boolean isValid = screen.hasValidSelection();
screen.render(guiGraphics, mouseX, mouseY, partialTicks);"
}
```

### Response
#### Success Response (N/A)
These are method calls and do not have traditional API responses.

#### Response Example
None
```

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

### GET /examples

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

Retrieves a collection of example commands or arguments that can be used.

```APIDOC
## GET /examples

### Description
Retrieves a collection of example commands or arguments that can be used.

### Method
GET

### Endpoint
/examples

### Parameters
None

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

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

#### Response Example
```json
{
  "examples": [
    "example_command arg1 arg2",
    "another_example --option"
  ]
}
```
```

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

### ColorArgument: Get Command Examples

Source: https://mappings.dev/1.20.4/net/minecraft/commands/arguments/ColorArgument

Retrieves a collection of example strings that can be used with the ColorArgument. This is helpful for command creators and users to understand valid inputs. It returns a Collection<String>.

```java
public Collection<String> getExamples()
{
  // Implementation details for returning examples
  return null;
}
```

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

### CraftPlanksTutorialStep Class Documentation

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

Detailed documentation for the CraftPlanksTutorialStep class, including its fields, constructor, and methods.

```APIDOC
## Class: CraftPlanksTutorialStep

### Description
Represents a tutorial step in Minecraft for crafting planks. It manages the logic and UI elements associated with this specific tutorial objective.

### Package
net.minecraft.client.tutorial

### Fields
#### Field Summary
- **a** (private static final int) - Represents a hint delay.
- **HINT_DELAY** (private static final int) - Alias for 'a'.
- **field_33027** (private static final int) - Internal field name for hint delay.
- **DELAY** (private static final int) - Alias for hint delay.
- **f_175011_** (private static final int) - Mapped field name.
- **b** (private static final Component) - Represents the crafting title component.
- **CRAFT_TITLE** (private static final Component) - Alias for 'b'.
- **TITLE** (private static final Component) - Alias for crafting title.
- **field_5611** (private static final Component) - Internal field name for crafting title.
- **f_120460_** (private static final Component) - Mapped field name.
- **c** (private static final Component) - Represents the crafting description component.
- **CRAFT_DESCRIPTION** (private static final Component) - Alias for 'c'.
- **DESCRIPTION** (private static final Component) - Alias for crafting description.
- **field_5612** (private static final Component) - Internal field name for crafting description.
- **f_120461_** (private static final Component) - Mapped field name.
- **d** (private final Tutorial) - The tutorial manager instance.
- **tutorial** (private final Tutorial) - Alias for 'd'.
- **manager** (private final Tutorial) - Alias for the tutorial manager.
- **field_5608** (private final Tutorial) - Internal field name for tutorial manager.
- **f_120462_** (private final Tutorial) - Mapped field name.
- **e** (private TutorialToast) - The tutorial toast instance.
- **toast** (private TutorialToast) - Alias for 'e'.
- **field_5610** (private TutorialToast) - Internal field name for toast.
- **f_120463_** (private TutorialToast) - Mapped field name.
- **f** (private int) - Counter for waiting time in ticks.
- **timeWaiting** (private int) - Alias for 'f'.
- **ticks** (private int) - Alias for waiting time.
- **field_5609** (private int) - Internal field name for waiting ticks.
- **f_120464_** (private int) - Mapped field name.

### Constructor
#### Public Constructor
- **CraftPlanksTutorialStep(Tutorial manager)**: Initializes a new instance of the CraftPlanksTutorialStep class with the provided tutorial manager.

### Methods
#### Method Summary
- **tick()** (public void): Called every tick to update the tutorial step's state. Handles timing and progression.
- **clear()** (public void): Cleans up resources and resets the state of the tutorial step.
- **destroy()** (public void): Alias for clear().
- **onGetItem(ItemStack arg0)** (public void): Handles the event when an item is obtained by the player. (Mapped as `method_4897` and `onSlotUpdate`)
- **hasCraftedPlanksPreviously(LocalPlayer arg0, TagKey<Item> arg1)** (public static boolean): Checks if the player has previously crafted planks tagged with the given tag.
- **hasCrafted(ClientPlayerEntity player, TagKey<Item> tag)** (public static boolean): Alias for `hasCraftedPlanksPreviously`.
```

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

### BundleTutorial Class Documentation

Source: https://mappings.dev/1.20.4/net/minecraft/client/tutorial/BundleTutorial

Details about the BundleTutorial class, its fields, constructors, and methods.

```APIDOC
## BundleTutorial Class

### Description
Manages tutorial steps, including displaying and clearing tutorial toasts, and handling player interactions with inventory items during tutorials.

### Class
`net.minecraft.client.tutorial.BundleTutorial`

### Fields
- **`a`** (`Tutorial`) - The tutorial manager.
- **`b`** (`Options`) - The game options.
- **`c`** (`TutorialToast`) - The current tutorial toast.

### Constructor Summary
- **`public BundleTutorial(Tutorial manager, Options options)`** - Initializes a new instance of the BundleTutorial class.

### Method Summary
- **`private void showToast()`** - Displays the tutorial toast.
- **`private void clearToast()`** - Clears the current tutorial toast.
- **`public void onInventoryAction(ItemStack arg0, ItemStack arg1, ClickAction arg2)`** - Handles an inventory action performed by the player. This method is invoked when the player interacts with items in their inventory or crafting grid.
- **`public void onPickupSlotClick(ItemStack cursorStack, ItemStack slotStack, ClickType clickType)`** - Handles a click event on a pickup slot, typically when the player is picking up or moving items. This is crucial for tutorial steps that involve item manipulation.
```

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

### Minecraft MessageArgument: Get Examples

Source: https://mappings.dev/1.20.4/net/minecraft/commands/arguments/MessageArgument

Retrieves a collection of example strings for the MessageArgument. This method is helpful for command suggestion systems and for developers understanding how to format messages correctly when using this argument type.

```java
public Collection<String> getExamples() {
  // Implementation details for providing examples
  return null;
}
```

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

### Get GameMode Examples - Java

Source: https://mappings.dev/1.20.4/net/minecraft/commands/arguments/GameModeArgument

Retrieves a collection of example strings for valid game mode arguments. This method is useful for command help or documentation to show players how to correctly use the game mode argument.

```java
public Collection<String> getExamples()
{
    // Implementation details for returning example strings
    return null; // Placeholder
}
```

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

### Initialize UI Components

Source: https://mappings.dev/1.20.4/com/mojang/realmsclient/gui/screens/RealmsResetWorldScreen

Methods for initializing user interface components. These methods typically return void and are used for setup processes.

```Java
public void init()
public void method_25426()
public void init()
public void m_7856_()
```

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

### Shader Fog Manipulation

Source: https://mappings.dev/1.20.4/com/mojang/blaze3d/systems/RenderSystem

Functions to set and get shader fog properties, including start, end, color, and shape.

```APIDOC
## Shader Fog Manipulation

### Description
Provides methods to configure and retrieve fog settings for shaders.

### Methods

#### `setShaderFogStart(float shaderFogStart)`
Sets the starting distance for the fog effect.

- **Method**: `public static void`
- **Parameters**:
  - `shaderFogStart` (float) - The fog start distance.

#### `getShaderFogStart()`
Retrieves the current fog start distance.

- **Method**: `public static float`
- **Returns**: The fog start distance.

#### `setShaderFogEnd(float shaderFogEnd)`
Sets the ending distance for the fog effect.

- **Method**: `public static void`
- **Parameters**:
  - `shaderFogEnd` (float) - The fog end distance.

#### `getShaderFogEnd()`
Retrieves the current fog end distance.

- **Method**: `public static float`
- **Returns**: The fog end distance.

#### `setShaderFogColor(float red, float green, float blue, float alpha)`
Sets the fog color using RGBA values.

- **Method**: `public static void`
- **Parameters**:
  - `red` (float) - Red component of the fog color (0.0 to 1.0).
  - `green` (float) - Green component of the fog color (0.0 to 1.0).
  - `blue` (float) - Blue component of the fog color (0.0 to 1.0).
  - `alpha` (float) - Alpha component of the fog color (0.0 to 1.0).

#### `setShaderFogColor(float red, float green, float blue)`
Sets the fog color using RGB values (alpha defaults to 1.0).

- **Method**: `public static void`
- **Parameters**:
  - `red` (float) - Red component of the fog color (0.0 to 1.0).
  - `green` (float) - Green component of the fog color (0.0 to 1.0).
  - `blue` (float) - Blue component of the fog color (0.0 to 1.0).

#### `getShaderFogColor()`
Retrieves the current fog color as an array of floats [R, G, B, A].

- **Method**: `public static float[]`
- **Returns**: An array containing the RGBA values of the fog color.

#### `setShaderFogShape(FogShape shaderFogShape)`
Sets the shape of the fog effect.

- **Method**: `public static void`
- **Parameters**:
  - `shaderFogShape` (FogShape) - The desired fog shape.

#### `getShaderFogShape()`
Retrieves the current fog shape.

- **Method**: `public static FogShape`
- **Returns**: The current fog shape.

#### `clearStencil(int stencil)`
Clears the stencil buffer.

- **Method**: `public static void`
- **Parameters**:
  - `stencil` (int) - The stencil value to clear.

#### `clear(int mask, boolean getError)`
Clears specified buffers with optional error retrieval.

- **Method**: `public static void`
- **Parameters**:
  - `mask` (int) - A mask indicating which buffers to clear.
  - `getError` (boolean) - If true, errors will be retrieved.

```

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

### Get Structure Origin Block Position

Source: https://mappings.dev/1.20.4/net/minecraft/gametest/framework/StructureUtils

Fetches the BlockPos representing the origin or starting point of a structure. This is crucial for positioning and referencing the structure in the world.

```java
public static BlockPos getStructureOrigin(StructureBlockEntity structureBlockEntity)
public static BlockPos method_54849(class_2633 structureBlockEntity)
public static BlockPos getStructureBlockPos(StructureBlockBlockEntity structureBlockEntity)
public static BlockPos m_304927_(C_2029_ structureBlockEntity)
```

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

### ProfiledReloadInstance Overview

Source: https://mappings.dev/1.20.4/net/minecraft/server/packs/resources/ProfiledReloadInstance

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

```APIDOC
## ProfiledReloadInstance Class

### Description
Manages profiled resource reloading, allowing for detailed performance analysis of resource loading stages.

### Class Definition
`public class ProfiledReloadInstance extends SimpleReloadInstance<ProfiledReloadInstance$State>`

### Mapped Superinterfaces
- `ReloadInstance`
- `net.minecraft.server.packs.resources.ProfiledReloadInstance`
- `net.minecraft.class_4010`
- `net.minecraft.resource.ProfiledResourceReload`
- `net.minecraft.src.C_71_`
- `net.minecraft.server.packs.resources.ReloadableProfiled`

### Field Summary
- `private static final org.slf4j.Logger LOGGER` (aliased as `field_17918`, `LOGGER`, `f_10645_`)
- `private final com.google.common.base.Stopwatch total` (aliased as `field_17919`, `reloadTimer`, `f_10646_`)

### Constructor Summary
- `public ProfiledReloadInstance(ResourceManager manager, List<PreparableReloadListener> reloaders, Executor prepareExecutor, Executor applyExecutor, CompletableFuture<Unit> initialStage)`

### Method Summary
- `private List<ProfiledReloadInstance$State> finish(List<ProfiledReloadInstance$State> arg0)` (aliased as `a(List<aqd$a> arg0)`)
- `private List<ProfiledResourceReload$Summary> finish(List<ProfiledResourceReload$Summary> summaries)` (aliased as `method_18238(List<class_4010$class_4046> arg0)`, `m_215483_(List<C_71_$C_73_> arg0)`)
```

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

### Get Offset from Sector Data

Source: https://mappings.dev/1.20.4/net/minecraft/world/level/chunk/storage/RegionFile

Retrieves the offset value from packed sector data. This complements `getSize` by providing the starting position of the data.

```Java
private static int getOffset(int sectorData)

```

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

### Structure Manager Methods

Source: https://mappings.dev/1.20.4/net/minecraft/world/level/StructureManager

This section details various methods for interacting with structures, such as retrieving structure starts, checking for structure presence, and getting structure information at specific locations.

```APIDOC
## Structure Manager API Endpoints

### Get Structure Starts

This endpoint retrieves a list of `StructureStart` objects for a given structure and position.

#### Method
GET

#### Endpoint
`/api/structures/starts

#### Query Parameters
- **pos** (ChunkPos) - Required - The chunk position to query.
- **predicate** (Predicate<Structure>) - Required - A predicate to filter structures.

#### Response
##### Success Response (200)
- **structures** (List<StructureStart>) - A list of structure starts.

##### Response Example
```json
{
  "structures": [
    {
      "structure": "minecraft:village",
      "chunkPos": { "x": 0, "z": 0 },
      "children": []
    }
  ]
}
```

### Get Structure Start

Retrieves a specific `StructureStart` for a given structure and position.

#### Method
GET

#### Endpoint
`/api/structures/start

#### Query Parameters
- **pos** (SectionPos) - Required - The section position to query.
- **structure** (Structure) - Required - The structure to find.

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

##### Response Example
```json
{
  "structureStart": {
    "structure": "minecraft:mineshaft",
    "chunkPos": { "x": 1, "z": 1 },
    "children": []
  }
}
```

### Check Structure Presence

Checks if a structure is present at a given chunk position.

#### Method
GET

#### Endpoint
`/api/structures/check_presence

#### Query Parameters
- **pos** (ChunkPos) - Required - The chunk position to check.
- **structure** (Structure) - Required - The structure to check for.
- **randomTick** (boolean) - Required - Whether to consider random ticks.

#### Response
##### Success Response (200)
- **result** (StructureCheckResult) - The result of the structure presence check.

##### Response Example
```json
{
  "result": "START_EXISTS"
}
```

### Should Generate Structures

Determines if structures should be generated in the world.

#### Method
GET

#### Endpoint
`/api/structures/should_generate

#### Response
##### Success Response (200)
- **generate** (boolean) - True if structures should generate, false otherwise.

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

### Get Structure At

Retrieves a `StructureStart` at a given block position for a specific structure.

#### Method
GET

#### Endpoint
`/api/structures/at_block

#### Query Parameters
- **pos** (BlockPos) - Required - The block position to query.
- **structure** (Structure) - Required - The structure to find.

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

##### Response Example
```json
{
  "structureStart": {
    "structure": "minecraft:stronghold",
    "chunkPos": { "x": 10, "z": -5 },
    "children": []
  }
}
```

### Get Structure Containing (ResourceKey)

Retrieves a `StructureStart` containing a structure identified by a `ResourceKey`.

#### Method
GET

#### Endpoint
`/api/structures/containing_resource

#### Query Parameters
- **pos** (BlockPos) - Required - The block position to query.
- **structureKey** (RegistryKey<Structure>) - Required - The resource key of the structure.

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

##### Response Example
```json
{
  "structureStart": {
    "structure": "minecraft:pillager_outpost",
    "chunkPos": { "x": -20, "z": 30 },
    "children": []
  }
}
```

### Get Structure Containing (TagKey)

Retrieves a `StructureStart` containing a structure identified by a `TagKey`.

#### Method
GET

#### Endpoint
`/api/structures/containing_tag

#### Query Parameters
- **pos** (BlockPos) - Required - The block position to query.
- **structureTag** (TagKey<Structure>) - Required - The tag key of the structures.

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

##### Response Example
```json
{
  "structureStart": {
    "structure": "minecraft:woodland_mansion",
    "chunkPos": { "x": 100, "z": 100 },
    "children": []
  }
}
```

### Get Structure Containing (Structure)

Retrieves a `StructureStart` containing a structure identified by a `Structure` object.

#### Method
GET

#### Endpoint
`/api/structures/containing_structure

#### Query Parameters
- **pos** (BlockPos) - Required - The block position to query.
- **structure** (Structure) - Required - The structure object.

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

##### Response Example
```json
{
  "structureStart": {
    "structure": "minecraft:desert_pyramid",
    "chunkPos": { "x": 5, "z": 5 },
    "children": []
  }
}
```

### Structure Has Piece At

Checks if a `StructureStart` has a piece at the given block position.

#### Method
GET

#### Endpoint
`/api/structures/has_piece_at

#### Query Parameters
- **pos** (BlockPos) - Required - The block position to query.
- **structureStart** (StructureStart) - Required - The structure start to check.

#### Response
##### Success Response (200)
- **hasPiece** (boolean) - True if a piece exists, false otherwise.

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

### Has Any Structure At

Checks if any structure pieces exist at the given block position.

#### Method
GET

#### Endpoint
`/api/structures/has_any_at

#### Query Parameters
- **pos** (BlockPos) - Required - The block position to query.

#### Response
##### Success Response (200)
- **hasStructure** (boolean) - True if any structure exists, false otherwise.

##### Response Example
```json
{
  "hasStructure": false
}
```

### Get All Structures At

Retrieves all structures and their references at the given block position.

#### Method
GET

#### Endpoint
`/api/structures/all_at

#### Query Parameters
- **pos** (BlockPos) - Required - The block position to query.

#### Response
##### Success Response (200)
- **structures** (Map<Structure, LongSet>) - A map of structures and their associated long sets (references).

##### Response Example
```json
{
  "structures": {
    "minecraft:village": [1234567890123456789],
    "minecraft:pillager_outpost": [9876543210987654321]
  }
}
```
```

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

### CreateFlatWorldScreen$DetailsList$Entry API

Source: https://mappings.dev/1.20.4/net/minecraft/client/gui/screens/CreateFlatWorldScreen%24DetailsList%24Entry

This section details the constructor and various methods of the CreateFlatWorldScreen$DetailsList$Entry class, including rendering, item creation, and mouse interaction.

```APIDOC
## CreateFlatWorldScreen$DetailsList$Entry

### Description
Represents an entry within the details list for creating a flat world. It handles rendering and interaction for individual elements in the list.

### Class Hierarchy
- **Superclass:** `ObjectSelectionList.Entry<CreateFlatWorldScreen.DetailsList.Entry>`
- **Interfaces:** `GuiEventListener`, `TabOrderedElement`, `NarrationSupplier`

### Constructor

#### `CreateFlatWorldScreen$DetailsList$Entry(CreateFlatWorldScreen$DetailsList arg0)`
- **Description:** Constructs a new `DetailsList$Entry` instance.
- **Parameters:**
  - `arg0` (CreateFlatWorldScreen$DetailsList) - The parent details list.

### Methods

#### `render(GuiGraphics arg0, int arg1, int arg2, int arg3, int arg4, int arg5, int arg6, int arg7, boolean arg8, float arg9)`
- **Description:** Renders the entry with specified graphics and layout information.
- **Method:** `public void`

#### `createItemStackFor(BlockState state)`
- **Description:** Creates an `ItemStack` representation for a given `BlockState`.
- **Method:** `private ItemStack`
- **Parameters:**
  - `state` (BlockState) - The block state to create an item stack for.

#### `getNarration()`
- **Description:** Retrieves the narration for accessibility purposes.
- **Method:** `public Component`

#### `mouseClicked(double arg0, double arg1, int arg2)`
- **Description:** Handles mouse click events within the entry's bounds.
- **Method:** `public boolean`
- **Parameters:**
  - `arg0` (double) - The x-coordinate of the mouse click.
  - `arg1` (double) - The y-coordinate of the mouse click.
  - `arg2` (int) - The mouse button pressed.

#### `blitSlot(GuiGraphics arg0, int arg1, int arg2, ItemStack arg3)`
- **Description:** Blits (draws) a slot with the given item stack using `GuiGraphics`.
- **Method:** `private void`
- **Parameters:**
  - `arg0` (GuiGraphics) - The graphics context.
  - `arg1` (int) - The x-coordinate for the slot.
  - `arg2` (int) - The y-coordinate for the slot.
  - `arg3` (ItemStack) - The item stack to display in the slot.

#### `blitSlotBg(GuiGraphics arg0, int arg1, int arg2)`
- **Description:** Blits the background texture for a slot using `GuiGraphics`.
- **Method:** `private void`
- **Parameters:**
  - `arg0` (GuiGraphics) - The graphics context.
  - `arg1` (int) - The x-coordinate for the background.
  - `arg2` (int) - The y-coordinate for the background.

```

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

### GameTestServer Initialization Method

Source: https://mappings.dev/1.20.4/net/minecraft/gametest/framework/GameTestServer

The initServer method is responsible for initializing the game server. This method performs setup operations necessary for the server to start and run game tests.

```java
public boolean initServer()
// Other method names like method_3823(), setupServer(), m_7038_() may also refer to this functionality.
```
Tokens:
Raw