Minestom

https://javadoc.minestom.net
Admin
Minestom is an open-source, high-performance Minecraft server implementation, offering a robust API...
Tokens:4,831,199
Snippets:41,400
Trust Score:6.7
Update:18 hours ago
Show doc for...
Tokens:
Raw
### void start()

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/network/socket/Server.html

Starts the server.

```APIDOC
## Method: start()

### Description
Starts the server.

### Signature
`public void start()`

### Parameters
None.

### Returns
void
```

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

### start()

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/entity/ai/goal/RandomLookAroundGoal.html

Starts the goal.

```APIDOC
## Method: start()

### Description
Starts this GoalSelector. This method is called when the goal is activated and should begin its behavior.

### Returns
- void

### Example
```java
goal.start();
```
```

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

### start()

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/entity/ai/goal/RangedAttackGoal.html

Starts this GoalSelector.

```APIDOC
## start()

### Description
Starts this GoalSelector.

### Method
start

### Signature
public void start()

```

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

### void start()

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/entity/ai/goal/RandomStrollGoal.html

Starts this GoalSelector.

```APIDOC
## Method: start

### Description
Starts this GoalSelector.

### Signature
`public void start()`

### Return Type
void
```

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

### void start()

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/entity/ai/goal/FollowTargetGoal.html

Starts this GoalSelector, initiating the follow behavior.

```APIDOC
## Method: void start()

### Description
Starts this GoalSelector, initiating the follow behavior.

### Return Type
void

```

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

### start()

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/entity/ai/goal/FollowTargetGoal.html

Starts this GoalSelector.

```APIDOC
## start()

### Description
Starts this GoalSelector.

### Method
`public void start()`

```

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

### start()

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/entity/ai/goal/MeleeAttackGoal.html

Starts the goal execution.

```APIDOC
## Method: start

### Description
Initiates the goal's behavior. This is an implementation of the GoalSelector method.

### Signature
`public void start()`

### Returns
- `void` - No return value.
```

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

### start()

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/entity/ai/goal/DoNothingGoal.html

Starts this GoalSelector.

```APIDOC
## start()

### Description
Starts this GoalSelector.

### Method
`public void start()`

### Overrides
- Specified by: `start` in class `GoalSelector`
```

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

### start()

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/entity/ai/GoalSelector.html

Starts this GoalSelector.

```APIDOC
## start()

### Description
Starts this GoalSelector.

### Method
`public abstract void start()`

```

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

### start

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/entity/ai/goal/CombinedAttackGoal.html

Starts this GoalSelector.

```APIDOC
## start

### Description
Starts this GoalSelector.

### Method
public void start()
```

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

### start

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/entity/ai/goal/RandomStrollGoal.html

Starts this GoalSelector.

```APIDOC
## start

### Description
Starts this GoalSelector.

### Method
`public void start()`
```

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

### start(String address, int port)

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/MinecraftServer.html

Starts the server on the given address and port.

```APIDOC
## start(String address, int port)

### Description
Starts the server on the given address and port.

### Method
instance

### Signature
`void start(String address, int port)`

### Parameters
- `address` (String) - Required - The address to bind to.
- `port` (int) - Required - The port to bind to.
```

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

### Method: start()

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/entity/ai/goal/DoNothingGoal.html

Starts this GoalSelector, beginning the goal's execution.

```APIDOC
## Method: start()

### Description
Starts this GoalSelector, beginning the goal's execution.

### Method
void start()

### Return Type
void

```

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

### start()

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/entity/ai/goal/RandomLookAroundGoal.html

Starts this GoalSelector. Called when the goal begins.

```APIDOC
## start()

### Description
Starts this GoalSelector.

### Method
start

### Signature
`public void start()`

### Parameters
None.
```

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

### start(String address, int port)

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/MinecraftServer.html

Starts the server on the given host address and port.

```APIDOC
## start(String address, int port)

### Description
Starts the server on the given host address and port.

### Method
public void start(String address, int port)

### Parameters
- **address** (String) - Required - The host address.
- **port** (int) - Required - The port number.

```

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

### shouldStart()

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/entity/ai/goal/RandomLookAroundGoal.html

Determines whether the goal should start. Returns true to start.

```APIDOC
## shouldStart()

### Description
Determines whether the goal should start.

### Method
shouldStart

### Signature
`public boolean shouldStart()`

### Returns
- **boolean** - `true` to start the goal.
```

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

### start()

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/coordinate/Area.Line.html

Returns the start block of the line.

```APIDOC
## start()

### Description
Returns the start block of the line.

### Method
`BlockVec start()`

### Returns
- `BlockVec` - the start block
```

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

### start()

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/entity/ai/goal/MeleeAttackGoal.html

Starts this GoalSelector. This method is specified by the GoalSelector class.

```APIDOC
## start()

### Description
Starts this GoalSelector.

### Method
start

### Signature
public void start()

### Parameters
None

### Returns
void
```

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

### start()

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/thread/ThreadDispatcher.html

Starts all the tick threads.

```APIDOC
## start()

### Description
Starts all the tick threads.

### Method
void start()

### Parameters
None.

### Returns
- **void** - This method does not return a value.

```

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

### start(SocketAddress address)

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/MinecraftServer.html

Starts the server on the given socket address.

```APIDOC
## start(SocketAddress address)

### Description
Starts the server on the given socket address.

### Method
instance

### Signature
`void start(SocketAddress address)`

### Parameters
- `address` (SocketAddress) - Required - The socket address to bind to.
```

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

### shouldStart

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/entity/ai/goal/RandomStrollGoal.html

Determines whether this goal should start. Returns true if the goal should start.

```APIDOC
## shouldStart

### Description
Whether this GoalSelector should start.

### Method
`public boolean shouldStart()`

### Returns
- **boolean** - true to start
```

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

### start()

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/dialog/DialogInput.NumberRange.html

Returns the value of the `start` record component.

```APIDOC
## float start()

### Description
Returns the value of the `start` record component.

### Returns
- **float** - The start value.
```

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

### start(SocketAddress address)

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/MinecraftServer.html

Starts the server on the given socket address. Should be called after init() and any custom initialization code.

```APIDOC
## start(SocketAddress address)

### Description
Starts the server on the given socket address. Should be called after init() and any custom initialization code.

### Method
public void start(SocketAddress address)

### Parameters
- **address** (SocketAddress) - Required - The server address.

### Throws
- **IllegalStateException** - If called before init() or if the server is already running.

```

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

### void setStart(int start)

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/command/builder/suggestion/Suggestion.html

Sets the start index of this Suggestion.

```APIDOC
## void setStart(int start)

### Description
Sets the start index of this Suggestion.

### Parameters
- **start** (int) - Required - The new start index.

### Example
```java
suggestion.setStart(2);
```
```

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

### start()

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/item/crossbow/CrossbowChargingSounds.html

Returns the value of the 'start' record component, which is a nullable SoundEvent.

```APIDOC
## start()

### Description
Returns the value of the `start` record component.

### Method
`@Nullable public @Nullable SoundEvent start()`

### Returns
- `@Nullable SoundEvent` - the value of the `start` record component

```

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

### start()

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/entity/ai/goal/CombinedAttackGoal.html

Starts this GoalSelector. This method is part of the public API for AI goal selection.

```APIDOC
## start()

### Description
Starts this GoalSelector.

### Method
`void start()`

### Parameters
None.

### Returns
`void`

```

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

### shouldStart()

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/entity/ai/goal/RangedAttackGoal.html

Determines whether this GoalSelector should start. Returns true to start.

```APIDOC
## shouldStart()

### Description
Determines whether this GoalSelector should start. Returns true to start.

### Method
shouldStart

### Signature
public boolean shouldStart()

### Returns
- **boolean** - true to start.

```

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

### shouldStart()

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/entity/ai/goal/FollowTargetGoal.html

Determines whether this GoalSelector should start. Returns true to start.

```APIDOC
## shouldStart()

### Description
Whether this GoalSelector should start.

### Method
`public boolean shouldStart()`

### Returns
- **boolean** - true to start

```

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

### start(SocketAddress)

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/ServerProcess.html

Starts the server process with the given socket address.

```APIDOC
## start(SocketAddress)

### Description
Starts the server process with the given socket address.

### Method
start(SocketAddress socketAddress)

### Parameters
- **socketAddress** (SocketAddress) - Required - The socket address to bind to.

### Returns
void
```

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

### shouldStart

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/entity/ai/goal/CombinedAttackGoal.html

Determines whether this GoalSelector should start. Returns true to start.

```APIDOC
## shouldStart

### Description
Determines whether this GoalSelector should start. Returns true to start.

### Method
public boolean shouldStart()

### Returns
- **boolean** - true to start
```

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

### start(SocketAddress)

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/ServerProcess.html

Starts the server process bound to the given socket address.

```APIDOC
## start(SocketAddress)

### Description
Starts the server process bound to the given socket address.

### Method
`start(SocketAddress socketAddress)`

### Parameters
- **socketAddress** (SocketAddress) - Required - The address to bind the server to.

### Example
```java
serverProcess.start(new InetSocketAddress("localhost", 25565));
```
```

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

### getPlayer()

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/event/player/PlayerStartDiggingEvent.html

Gets the player who started digging.

```APIDOC
## Method: getPlayer()

### Description
Gets the player who started digging.

### Return Type
`Player`
```

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

### Constructor Suggestion(String input, int start, int length)

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/command/builder/suggestion/Suggestion.html

Creates a new Suggestion instance with the given input string, start index, and length.

```APIDOC
## Constructor Suggestion(String input, int start, int length)

### Description
Creates a new Suggestion instance with the given input string, start index, and length.

### Parameters
- **input** (String) - Required - The input string for the suggestion.
- **start** (int) - Required - The start index of the suggestion.
- **length** (int) - Required - The length of the suggestion.

### Example
```java
Suggestion suggestion = new Suggestion("example", 0, 7);
```
```

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

### Player getPlayer()

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/event/player/PlayerStartFlyingWithElytraEvent.html

Gets the player who started flying with elytra.

```APIDOC
## Method: getPlayer()

### Description
Returns the player associated with this event.

### Returns
- **Player** - The player who started flying with elytra.

```

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

### getCurrentItemUseTime()

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/entity/Player.html

Gets the amount of ticks which have passed since the player started using an item.

```APIDOC
## getCurrentItemUseTime()

### Description
Gets the amount of ticks which have passed since the player started using an item.

### Method
GET

### Endpoint
Player#getCurrentItemUseTime()

### Returns
- **long** - The number of ticks since item use started.
```

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

### start()

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/thread/ThreadDispatcher.html

Starts all the tick threads. Throws IllegalThreadStateException if the threads have already been started.

```APIDOC
## start()

### Description
Starts all the tick threads. This will throw an IllegalThreadStateException if the threads have already been started.

### Method
void start()

### Parameters
None

### Returns
void

### Exceptions
- **IllegalThreadStateException** - if the threads have already been started
```

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

### Server()

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/network/socket/Server.html

Constructs a new Server instance with default settings.

```APIDOC
## Constructor: Server()

### Description
Creates a new Server instance.

### Signature
`public Server()`

### Parameters
None.

### Returns
A new Server object.
```

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

### init()

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/MinecraftServer.html

Initializes the Minecraft server.

```APIDOC
## init()

### Description
Initializes the Minecraft server.

### Method
static

### Signature
`static MinecraftServer init()`

### Returns
- `MinecraftServer` - The initialized server instance.
```

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

### MinecraftServer.start(String, int)

Source: https://javadoc.minestom.net/index-all.html

Starts the Minecraft server with the given address and port.

```APIDOC
## MinecraftServer.start(String, int)

### Description
Starts the Minecraft server with the specified address and port.

### Method
start

### Parameters
- **address** (String) - The address to bind to.
- **port** (int) - The port to bind to.

### Returns
void
```

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

### shouldStart()

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/entity/ai/goal/RandomLookAroundGoal.html

Determines whether the goal should start.

```APIDOC
## Method: shouldStart()

### Description
Returns whether this GoalSelector should start. This is typically called by the AI system to decide if the goal should be activated.

### Returns
- **boolean** - true if the goal should start, false otherwise.

### Example
```java
boolean shouldStart = goal.shouldStart();
```
```

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

### shouldStart()

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/entity/ai/goal/MeleeAttackGoal.html

Determines whether this goal should start executing.

```APIDOC
## Method: shouldStart

### Description
Checks if the goal should start. This is an implementation of the GoalSelector method.

### Signature
`public boolean shouldStart()`

### Returns
- `boolean` - `true` if the goal should start, otherwise `false`.
```

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

### cipher(Cipher cipher, long start, long length)

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/network/NetworkBuffer.html

Encrypts or decrypts `length` bytes starting at `start` in place with the given cipher.

```APIDOC
## cipher(Cipher cipher, long start, long length)

### Description
Encrypts or decrypts `length` bytes starting at `start` in place with the given cipher.

### Method
cipher

### Parameters
- **cipher** (Cipher) - Required - The cipher to use for encryption/decryption.
- **start** (long) - Required - The starting index.
- **length** (long) - Required - The number of bytes to process.

### Returns
- **void**
```

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

### startConfigurationPhase()

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/entity/Player.html

Moves the player to the configuration state at the end of the current tick.

```APIDOC
## startConfigurationPhase()

### Description
Moves the player to the configuration state at the end of the current tick.

### Method
void

### Parameters
None

### Returns
void
```

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

### setStart(int start)

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/command/builder/suggestion/Suggestion.html

Sets the start index of this suggestion.

```APIDOC
## setStart(int start)

### Description
Sets the start index of this suggestion to the given value.

### Signature
`public void setStart(int start)`

### Parameters
- `start` (int) - The new start index.
```

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

### init()

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/MinecraftServer.html

Initializes the Minecraft server. This method is called to start the server process.

```APIDOC
## init()

### Description
Initializes the Minecraft server.

### Method
init()

### Signature
public static MinecraftServer init()

### Returns
- **MinecraftServer** - The initialized server instance.
```

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

### get(Pointer)

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/command/ConsoleSender.html

Inherited from Pointered. Gets a value from the pointer.

```APIDOC
## get(Pointer)

### Description
Gets a value from the pointer.

### Method
get

### Parameters
- **pointer** (Pointer) - Required - The pointer to get the value from.

### Return Value
The value associated with the pointer.
```

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

### void init(SocketAddress address)

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/network/socket/Server.html

Initializes the server with the given socket address.

```APIDOC
## Method: init(SocketAddress address)

### Description
Initializes the server with the specified socket address.

### Signature
`public void init(SocketAddress address)`

### Parameters
- **address** (SocketAddress) - Required - The socket address to bind the server to.

### Returns
void
```

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

### int getStart()

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/command/builder/suggestion/Suggestion.html

Returns the start index of this Suggestion.

```APIDOC
## int getStart()

### Description
Returns the start index of this Suggestion.

### Returns
- **int** - The start index.

### Example
```java
int start = suggestion.getStart();
```
```

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

### StartConfigurationPacket()

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/network/packet/server/play/StartConfigurationPacket.html

Creates an instance of a StartConfigurationPacket record class.

```APIDOC
## StartConfigurationPacket()

### Description
Creates an instance of a `StartConfigurationPacket` record class.

### Constructor
`public StartConfigurationPacket()`

### Parameters
None.

### Returns
A new `StartConfigurationPacket` instance.
```

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

### StartConfigurationPacket()

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/network/packet/server/play/StartConfigurationPacket.html

Creates an instance of the StartConfigurationPacket record class.

```APIDOC
## StartConfigurationPacket()

### Description
Creates an instance of the `StartConfigurationPacket` record class.

### Constructor
`StartConfigurationPacket()`

### Parameters
None.

### Returns
A new `StartConfigurationPacket` instance.

### Example
```java
StartConfigurationPacket packet = new StartConfigurationPacket();
```
```

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

### build()

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/entity/metadata/animal/tameable/WolfSoundVariant.WolfSoundSet.Builder.html

Builds and returns the WolfSoundSet instance with the configured sound events.

```APIDOC
## build()

### Description
Builds and returns the WolfSoundSet instance with the configured sound events.

### Method
build

### Returns
- **WolfSoundVariant.WolfSoundSet** - The constructed WolfSoundSet instance.

```

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

### get(DataComponent, T)

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/entity/Player.html

Gets the value of a data component, or a default if not present.

```APIDOC
## get(DataComponent, T)

### Description
Gets the value of a data component, or a default if not present.

### Method
get

### Parameters
- **component** (DataComponent) - Required - The data component.
- **defaultValue** (T) - Required - The default value if component is not present.

### Return Type
T
```

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

### MinecraftServer.start(SocketAddress)

Source: https://javadoc.minestom.net/index-all.html

Starts the server using the provided socket address.

```APIDOC
## MinecraftServer.start(SocketAddress)

### Description
Starts the server.

### Method
start

### Parameters
- **address** (SocketAddress) - The socket address to bind to.

### Returns
void
```

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

### getServer()

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/MinecraftServer.html

Returns the server instance.

```APIDOC
## getServer()

### Description
Returns the server instance.

### Method
public static Server getServer()

### Returns
- **Server** - The server instance.

```

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

### compress(long start, long length, NetworkBuffer output)

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/network/NetworkBuffer.html

Compresses `length` bytes starting at `start` with a Deflater into `output` at its write index, and advances the write index of `output`.

```APIDOC
## compress(long start, long length, NetworkBuffer output)

### Description
Compresses `length` bytes starting at `start` with a Deflater into `output` at its write index, and advances the write index of `output`.

### Method
compress

### Parameters
- **start** (long) - Required - The starting index.
- **length** (long) - Required - The number of bytes to compress.
- **output** (NetworkBuffer) - Required - The buffer to write the compressed data to.

### Returns
- **long** - The number of bytes written to the output buffer.
```

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

### long decompress(long start, long length, NetworkBuffer output)

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/network/NetworkBuffer.html

Decompresses length bytes starting at start with an Inflater into output at its write index, and advances the write index of output.

```APIDOC
## long decompress(long start, long length, NetworkBuffer output)

### Description
Decompresses `length` bytes starting at `start` with an `Inflater` into `output` at its write index, and advances the write index of `output`.

### Method
decompress

### Parameters
- **start** (long) - Required - The starting index in the source buffer.
- **length** (long) - Required - The number of bytes to decompress.
- **output** (NetworkBuffer) - Required - The destination buffer.

### Returns
long - The number of bytes written to the output buffer.
```

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

### createRecipeBookResetPacket(Player player)

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/recipe/RecipeManager.html

Creates a RecipeBookAddPacket that replaces the recipe book with the currently unlocked recipes for the player.

```APIDOC
## createRecipeBookResetPacket(Player player)

### Description
Creates a RecipeBookAddPacket which replaces the recipe book with the currently unlocked recipes for this player.

### Method
createRecipeBookResetPacket

### Parameters
- **player** (Player) - Required - The player for whom to create the packet.

### Returns
RecipeBookAddPacket
```

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

### Method: shouldStart()

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/entity/ai/goal/DoNothingGoal.html

Determines whether this GoalSelector should start.

```APIDOC
## Method: shouldStart()

### Description
Determines whether this GoalSelector should start.

### Method
boolean shouldStart()

### Return Type
boolean

```

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

### begin()

Source: https://javadoc.minestom.net/index-all.html

Method in interface EventsJFR.EventMarker. Begins the event marker.

```APIDOC
## begin()

### Description
Begins the event marker.

### Method
begin()
```

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

### get()

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/property/ServerProperty.html

Gets the current value of the property. This method is specified by the Supplier interface.

```APIDOC
## get()

### Description
Gets the current value of the property. This method is specified by the Supplier interface.

### Method
get()

### Returns
- **T** - the current value

```

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

### get(DataComponentMap prototype, DataComponent<T> component)

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/component/DataComponentMap.html

Does a 'patch'ed get against the given prototype.

```APIDOC
## get(DataComponentMap prototype, DataComponent<T> component)

### Description
Does a 'patch'ed get against the given prototype.

### Method
instance

### Parameters
- **prototype** (DataComponentMap) - The prototype component map.
- **component** (DataComponent<T>) - The component to get.

### Returns
T - The value of the component.
```

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

### RecipeBookAddPacket.Entry Constructor

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/network/packet/server/play/RecipeBookAddPacket.Entry.html

Creates an instance of the Entry record class with the specified display ID, display, group, category, crafting requirements, and flags.

```APIDOC
## RecipeBookAddPacket.Entry Constructor

### Description
Creates an instance of the `Entry` record class.

### Constructor Signature
`Entry(int displayId, RecipeDisplay display, @Nullable Integer group, RecipeBookCategory category, @Nullable List<Ingredient> craftingRequirements, byte flags)`

### Parameters
- `displayId` (int) - Required - The display ID.
- `display` (RecipeDisplay) - Required - The recipe display.
- `group` (@Nullable Integer) - Optional - The group identifier.
- `category` (RecipeBookCategory) - Required - The recipe book category.
- `craftingRequirements` (@Nullable List<Ingredient>) - Optional - The crafting requirements.
- `flags` (byte) - Required - The flags.

### Example
```java
Entry entry = new Entry(displayId, display, group, category, craftingRequirements, flags);
```
```

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

### get(Pointer)

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/command/CommandSender.html

Gets a value from a pointer. This method is inherited from the Pointered interface.

```APIDOC
## get(Pointer)

### Description
Gets a value from a pointer.

### Method
get

### Parameters
- `pointer` (Pointer) - The pointer to get the value from.

### Returns
- `T` - The value associated with the pointer.

### Source
Inherited from [Pointered](https://jd.papermc.io/adventure/5.2.0/net.kyori.adventure.api/net/kyori/adventure/pointer/Pointered.html#get(net.kyori.adventure.pointer.Pointer))
```

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

### ClientLoginStartPacket Constructor

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/network/packet/client/login/ClientLoginStartPacket.html

Creates an instance of the ClientLoginStartPacket record class with the specified username and profileId.

```APIDOC
## ClientLoginStartPacket(String username, UUID profileId)

### Description
Creates an instance of a `ClientLoginStartPacket` record class.

### Parameters
- **username** (String) - Required - The value for the `username` record component.
- **profileId** (UUID) - Required - The value for the `profileId` record component.

### Returns
A new `ClientLoginStartPacket` instance.
```

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

### Method: get(DataComponent<T>)

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/entity/metadata/animal/MooshroomMeta.html

Protected method to get a component value. Overrides EntityMeta.get.

```APIDOC
## Method: get

### Description
Protected method to retrieve a component value. Overrides EntityMeta.get.

### Signature
`@Nullable protected <T> T get(DataComponent<T> component)`

### Parameters
- **component** (DataComponent<T>) - The component to retrieve.

### Returns
- **T** - The value of the component, or null if not present.

```

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

### init(Auth auth)

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/MinecraftServer.html

Initializes the Minecraft server with an authentication provider.

```APIDOC
## init(Auth auth)

### Description
Initializes the Minecraft server with an authentication provider.

### Method
static

### Signature
`static MinecraftServer init(Auth auth)`

### Parameters
- `auth` (Auth) - Required - The authentication provider to use.

### Returns
- `MinecraftServer` - The initialized server instance.
```

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

### get(DataComponent<T>)

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/entity/metadata/animal/CowMeta.html

Protected method to get a data component value. Overrides EntityMeta.get.

```APIDOC
## get(DataComponent<T>)

### Description
Protected method to retrieve a data component value. Overrides EntityMeta.get.

### Method Signature
`@Nullable protected <T> T get(DataComponent<T> component)`

### Parameters
- **component** (DataComponent<T>) - The data component to retrieve.

### Return Value
- **T** - The value of the component, or null if not present.

### Usage Example
```java
// Typically called within subclass methods
DataComponent<String> component = ...;
String value = get(component);
```
```

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

### ClientLoginStartPacket Constructor

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/network/packet/client/login/ClientLoginStartPacket.html

Creates an instance of a ClientLoginStartPacket record class with the specified username and profileId.

```APIDOC
## ClientLoginStartPacket(String username, UUID profileId)

### Description
Creates an instance of a `ClientLoginStartPacket` record class.

### Constructor
`ClientLoginStartPacket(String username, UUID profileId)`

### Parameters
- **username** (String) - Required - The username for the login start packet.
- **profileId** (UUID) - Required - The profile ID for the login start packet.

### Example
```java
ClientLoginStartPacket packet = new ClientLoginStartPacket("Steve", UUID.randomUUID());
```
```

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

### shouldStart()

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/entity/ai/GoalSelector.html

Determines whether this GoalSelector should start.

```APIDOC
## shouldStart()

### Description
Determines whether this GoalSelector should start.

### Method
`public abstract boolean shouldStart()`

### Returns
- **boolean** - `true` to start, `false` otherwise.

```

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

### int get(int x, int y, int z)

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/instance/palette/Palette.html

Gets the value at the specified coordinates.

```APIDOC
## int get(int x, int y, int z)

### Description
Gets the value at the specified coordinates.

### Method
instance method

### Parameters
- **x** (int) - Required - The x coordinate.
- **y** (int) - Required - The y coordinate.
- **z** (int) - Required - The z coordinate.

### Returns
- **int** - The value at the specified coordinates.
```

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

### shouldStart()

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/entity/ai/goal/DoNothingGoal.html

Determines whether this GoalSelector should start.

```APIDOC
## shouldStart()

### Description
Whether this GoalSelector should start.

### Method
`public boolean shouldStart()`

### Returns
- **boolean** - true to start
```

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

### Method: get (protected)

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/entity/metadata/animal/ZombieNautilusMeta.html

Gets a data component value. This method is protected and overrides EntityMeta.get.

```APIDOC
## Method: get (protected)

### Description
Gets a data component value. This method is protected and overrides EntityMeta.get.

### Signature
`@Nullable protected <T> T get(DataComponent<T> component)`

### Parameters
- **component** (DataComponent<T>) - Required - The data component to get.

### Return Value
- **T** - Nullable - The value of the component, or null if not present.

### Overrides
Overrides `get` in class `EntityMeta`.

```

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

### shouldStart()

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/entity/ai/goal/RandomLookAroundGoal.html

Determines whether this GoalSelector should start.

```APIDOC
## shouldStart

### Description
Returns whether this GoalSelector should start. This method is specified by the GoalSelector class.

### Method
`public boolean shouldStart()`

### Returns
- **boolean** - Whether the goal should start.

```

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

### Protected Methods: get and set

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/entity/metadata/animal/PigMeta.html

Protected generic methods for getting and setting data components.

```APIDOC
## Protected Methods

### get(DataComponent<T> component)

#### Signature
`protected <T> T get(DataComponent<T> component)`

#### Description
Gets the value of the specified data component.

#### Parameters
- **component** (DataComponent<T>) - The data component to retrieve.

#### Returns
- **T** - The value of the component.

### set(DataComponent<T> component, T value)

#### Signature
`protected <T> void set(DataComponent<T> component, T value)`

#### Description
Sets the value of the specified data component.

#### Parameters
- **component** (DataComponent<T>) - The data component to set.
- **value** (T) - The new value for the component.
```

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

### open()

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/extras/lan/OpenToLAN.html

Opens the server to LAN with the default config. Returns true if it was opened successfully, false otherwise.

```APIDOC
## open()

### Description
Opens the server to LAN with the default config.

### Method
static boolean open()

### Returns
- `true` if it was opened successfully, `false` otherwise

```

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

### singleThread()

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/thread/ThreadDispatcher.html

Creates a single-threaded dispatcher with default thread names. The dispatcher must be started using start().

```APIDOC
## singleThread()

### Description
Creates a single-threaded dispatcher that uses default thread names. Remember to start the dispatcher using `start()`.

### Method
static <P, E extends Tickable> ThreadDispatcher<P,E> singleThread()

### Returns
A new ThreadDispatcher instance.

### Type Parameters
- `P` - the dispatcher partition type
- `E` - the element type, must extend Tickable
```

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

### ConnectionManager.transitionPlayToConfig(Player)

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/network/ConnectionManager.html

Transitions a player from play state to configuration state.

```APIDOC
## transitionPlayToConfig(Player)

### Description
Transitions a player from play state to configuration state.

### Method
`void transitionPlayToConfig(Player player)`

### Parameters
- **player** (Player) - Required - The player to transition.
```

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

### dispatcher(ThreadProvider, int)

Source: https://javadoc.minestom.net/net.minestom.server/net/minestom/server/thread/ThreadDispatcher.html

Creates a new ThreadDispatcher using default thread names (ex. Ms-Tick-n). Remember to start the dispatcher using start().

```APIDOC
## dispatcher(ThreadProvider, int)

### Description
Creates a new ThreadDispatcher using default thread names (ex. Ms-Tick-n). Remember to start the dispatcher using start().

### Method
static factory method

### Signature
`static <P, E extends Tickable> ThreadDispatcher<P,E> dispatcher(ThreadProvider<P> provider, int threadCount)`

### Parameters
- `provider` (ThreadProvider<P>) - Required - The ThreadProvider instance to be used for defining thread IDs.
- `threadCount` (int) - Required - The number of threads to create for this dispatcher.

### Returns
A new ThreadDispatcher instance.

### Type Parameters
- `P` - the dispatcher partition type
- `E` - extends Tickable

```
Tokens:
Raw