Package net.neoforged.neoforge.network.payload

Record Class AdvancedOpenScreenPayload

java.lang.Object

java.lang.Record

net.neoforged.neoforge.network.payload.AdvancedOpenScreenPayload

Record Components:

windowId - The window ID to use for the screen.

menuType - The menu type to open.

name - The name of the screen.

additionalData - The additional data to pass to the screen.

All Implemented Interfaces:

CustomPacketPayload

@Internal
public record AdvancedOpenScreenPayload(int windowId, MenuType<?> menuType, Component name, byte[] additionalData)
extends Record
implements CustomPacketPayload

A custom payload that allows for opening screens with additional data.

Nested Class Summary

Nested classes/interfaces inherited from interface net.minecraft.network.protocol.common.custom.CustomPacketPayload

CustomPacketPayload.FallbackProvider<B extends FriendlyByteBuf>, CustomPacketPayload.Type<T extends CustomPacketPayload>, CustomPacketPayload.TypeAndCodec<B extends FriendlyByteBuf,T extends CustomPacketPayload>

Field Summary

Fields

Modifier and Type	Field	Description
private final byte[]	additionalData	The field for the additionalData record component.
private final MenuType<?>	menuType	The field for the menuType record component.
private final Component	name	The field for the name record component.
static final StreamCodec<RegistryFriendlyByteBuf,AdvancedOpenScreenPayload>	STREAM_CODEC
static final CustomPacketPayload.Type<AdvancedOpenScreenPayload>	TYPE
private final int	windowId	The field for the windowId record component.

Constructor Summary

Constructors

Constructor	Description
AdvancedOpenScreenPayload(int windowId, MenuType<?> menuType, Component name, byte[] additionalData)	Creates an instance of a AdvancedOpenScreenPayload record class.

Method Summary

Modifier and Type	Method	Description
byte[]	additionalData()	Returns the value of the additionalData record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
MenuType<?>	menuType()	Returns the value of the menuType record component.
Component	name()	Returns the value of the name record component.
final String	toString()	Returns a string representation of this record class.
CustomPacketPayload.Type<AdvancedOpenScreenPayload>	type()
int	windowId()	Returns the value of the windowId record component.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

windowId

private final int windowId

The field for the windowId record component.

menuType

private final MenuType<?> menuType

The field for the menuType record component.

name

private final Component name

The field for the name record component.

additionalData

private final byte[] additionalData

The field for the additionalData record component.

TYPE

public static final CustomPacketPayload.Type<AdvancedOpenScreenPayload> TYPE

STREAM_CODEC

public static final StreamCodec<RegistryFriendlyByteBuf,AdvancedOpenScreenPayload> STREAM_CODEC

Constructor Details

AdvancedOpenScreenPayload

public AdvancedOpenScreenPayload(int windowId,
 MenuType<?> menuType,
 Component name,
 byte[] additionalData)

Creates an instance of a AdvancedOpenScreenPayload record class.

Parameters:

windowId - the value for the windowId record component

menuType - the value for the menuType record component

name - the value for the name record component

additionalData - the value for the additionalData record component

Method Details

type

public CustomPacketPayload.Type<AdvancedOpenScreenPayload> type()

Specified by:

type in interface CustomPacketPayload

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

windowId

public int windowId()

Returns the value of the windowId record component.

Returns:

the value of the windowId record component

menuType

public MenuType<?> menuType()

Returns the value of the menuType record component.

Returns:

the value of the menuType record component

name

public Component name()

Returns the value of the name record component.

Returns:

the value of the name record component

additionalData

public byte[] additionalData()

Returns the value of the additionalData record component.

Returns:

the value of the additionalData record component