java.lang.Object

net.neoforged.neoforge.network.registration.ModdedPacketRegistrar

All Implemented Interfaces:: IPayloadRegistrar

class ModdedPacketRegistrar extends Object implements IPayloadRegistrar

The internal implementation of IPayloadRegistrar for modded packets.

Field Summary

Fields

Modifier and Type

Field

Description

private final Map<ResourceLocation,ConfigurationRegistration<?>>

configurationPayloads

private final String

modId

private boolean

optional

private final Map<ResourceLocation,PlayRegistration<?>>

playPayloads

private boolean

valid

private Optional<String>

version
Constructor Summary

Constructors

Modifier

Constructor

Description

ModdedPacketRegistrar(String modId)

private

ModdedPacketRegistrar(ModdedPacketRegistrar source)
Method Summary

Modifier and Type

Method

Description

<T extends CustomPacketPayload> IPayloadRegistrar

common(ResourceLocation id, FriendlyByteBuf.Reader<T> reader, Consumer<IDirectionAwarePayloadHandlerBuilder<T,IPayloadHandler<T>>> handler)

Registers a new payload type for all supported phases.

<T extends CustomPacketPayload> IPayloadRegistrar

configuration(ResourceLocation id, FriendlyByteBuf.Reader<T> reader, Consumer<IDirectionAwarePayloadHandlerBuilder<T,IConfigurationPayloadHandler<T>>> handler)

Registers a new payload type for the configuration phase.

<T extends CustomPacketPayload> IPayloadRegistrar

configuration(ResourceLocation id, FriendlyByteBuf.Reader<T> reader, IConfigurationPayloadHandler<T> handler)

Registers a new payload type for the configuration phase.

private void

configuration(ResourceLocation id, ConfigurationRegistration<?> registration)

Map<ResourceLocation,ConfigurationRegistration<?>>

getConfigurationRegistrations()

Map<ResourceLocation,PlayRegistration<?>>

getPlayRegistrations()

void

invalidate()

IPayloadRegistrar

optional()

Defines that the payloads registered by this registrar are optional.

<T extends CustomPacketPayload> IPayloadRegistrar

play(ResourceLocation id, FriendlyByteBuf.Reader<T> reader, Consumer<IDirectionAwarePayloadHandlerBuilder<T,IPlayPayloadHandler<T>>> handler)

Registers a new payload type for the play phase.

<T extends CustomPacketPayload> IPayloadRegistrar

play(ResourceLocation id, FriendlyByteBuf.Reader<T> reader, IPlayPayloadHandler<T> handler)

Registers a new payload type for the play phase.

private void

play(ResourceLocation id, PlayRegistration<?> registration)

private void

validatePayload(ResourceLocation id, Map<ResourceLocation,?> payloads)

IPayloadRegistrar

versioned(String version)

Defines that the payloads registered by this registrar have a specific version associated with them.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.neoforged.neoforge.network.registration.IPayloadRegistrar
common

Field Details
- modId
  
  private final String modId
- configurationPayloads
  
  private final Map<ResourceLocation,ConfigurationRegistration<?>> configurationPayloads
- playPayloads
  
  private final Map<ResourceLocation,PlayRegistration<?>> playPayloads
- version
  
  private Optional<String> version
- optional
  
  private boolean optional
- valid
  
  private boolean valid
Constructor Details
- ModdedPacketRegistrar
  
  public ModdedPacketRegistrar(String modId)
- ModdedPacketRegistrar
  
  private ModdedPacketRegistrar(ModdedPacketRegistrar source)
Method Details
- getConfigurationRegistrations
  
  public Map<ResourceLocation,ConfigurationRegistration<?>> getConfigurationRegistrations()
- getPlayRegistrations
  
  public Map<ResourceLocation,PlayRegistration<?>> getPlayRegistrations()
- play
  
  public <T extends CustomPacketPayload> IPayloadRegistrar play(ResourceLocation id, FriendlyByteBuf.Reader<T> reader, IPlayPayloadHandler<T> handler)
  
  Description copied from interface: IPayloadRegistrar
  
  Registers a new payload type for the play phase.
  
  Specified by:
  
  play in interface IPayloadRegistrar
  
  Type Parameters:
  
  T - The type of the payload.
  
  Parameters:
  
  id - The id of the payload.
  
  reader - The reader for the payload.
  
  handler - The handler for the payload.
  
  Returns:
  
  The registrar.
- configuration
  
  public <T extends CustomPacketPayload> IPayloadRegistrar configuration(ResourceLocation id, FriendlyByteBuf.Reader<T> reader, IConfigurationPayloadHandler<T> handler)
  
  Description copied from interface: IPayloadRegistrar
  
  Registers a new payload type for the configuration phase.
  
  Specified by:
  
  configuration in interface IPayloadRegistrar
  
  Type Parameters:
  
  T - The type of the payload.
  
  Parameters:
  
  id - The id of the payload.
  
  reader - The reader for the payload.
  
  handler - The handler for the payload.
  
  Returns:
  
  The registrar.
- play
  
  public <T extends CustomPacketPayload> IPayloadRegistrar play(ResourceLocation id, FriendlyByteBuf.Reader<T> reader, Consumer<IDirectionAwarePayloadHandlerBuilder<T,IPlayPayloadHandler<T>>> handler)
  
  Description copied from interface: IPayloadRegistrar
  
  Registers a new payload type for the play phase.
  This method allows different handlers to be registered for different packet-flows.
  In practice this means that you can register a different handler for clientbound and serverbound packets, which allows you to handle them differently on the client and server side.
  
  Specified by:
  
  play in interface IPayloadRegistrar
  
  Type Parameters:
  
  T - The type of the payload.
  
  Parameters:
  
  id - The id of the payload.
  
  reader - The reader for the payload.
  
  handler - The handler for the payload.
  
  Returns:
  
  The registrar.
- configuration
  
  public <T extends CustomPacketPayload> IPayloadRegistrar configuration(ResourceLocation id, FriendlyByteBuf.Reader<T> reader, Consumer<IDirectionAwarePayloadHandlerBuilder<T,IConfigurationPayloadHandler<T>>> handler)
  
  Description copied from interface: IPayloadRegistrar
  
  Registers a new payload type for the configuration phase.
  This method allows different handlers to be registered for different packet-flows.
  In practice this means that you can register a different handler for clientbound and serverbound packets, which allows you to handle them differently on the client and server side.
  
  Specified by:
  
  configuration in interface IPayloadRegistrar
  
  Type Parameters:
  
  T - The type of the payload.
  
  Parameters:
  
  id - The id of the payload.
  
  reader - The reader for the payload.
  
  handler - The handler for the payload.
  
  Returns:
  
  The registrar.
- common
  
  public <T extends CustomPacketPayload> IPayloadRegistrar common(ResourceLocation id, FriendlyByteBuf.Reader<T> reader, Consumer<IDirectionAwarePayloadHandlerBuilder<T,IPayloadHandler<T>>> handler)
  
  Description copied from interface: IPayloadRegistrar
  
  Registers a new payload type for all supported phases.
  This method allows different handlers to be registered for different packet-flows.
  In practice this means that you can register a different handler for clientbound and serverbound packets, which allows you to handle them differently on the client and server side.
  
  Specified by:
  
  common in interface IPayloadRegistrar
  
  Type Parameters:
  
  T - The type of the payload.
  
  Parameters:
  
  id - The id of the payload.
  
  reader - The reader for the payload.
  
  handler - The handler for the payload.
  
  Returns:
  
  The registrar.
- configuration
  
  private void configuration(ResourceLocation id, ConfigurationRegistration<?> registration)
- play
  
  private void play(ResourceLocation id, PlayRegistration<?> registration)
- validatePayload
  
  private void validatePayload(ResourceLocation id, Map<ResourceLocation,?> payloads)
- versioned
  
  public IPayloadRegistrar versioned(String version)
  
  Description copied from interface: IPayloadRegistrar
  
  Defines that the payloads registered by this registrar have a specific version associated with them. Clients connecting to a server with these payloads, will only be able to connect if they have the same version.
  
  Specified by:
  
  versioned in interface IPayloadRegistrar
  
  Parameters:
  
  version - The version to use.
  
  Returns:
  
  A new registrar, ready to configure payloads with that version.
- optional
  
  public IPayloadRegistrar optional()
  
  Description copied from interface: IPayloadRegistrar
  
  Defines that the payloads registered by this registrar are optional. Clients connecting to a server which do not have the payloads registered, will still be able to connect.
  If clients have also a version set, and a version mismatch occurs (so both client and server have the payloads registered, yet have different versions), the connection attempt will fail. In other words, marking a payload as optional does not exempt it from versioning, if it has that configured.
  
  Specified by:
  
  optional in interface IPayloadRegistrar
  
  Returns:
  
  A new registrar, ready to configure payloads as optional.
- invalidate
  
  public void invalidate()

Class ModdedPacketRegistrar

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface net.neoforged.neoforge.network.registration.IPayloadRegistrar

Field Details

modId

configurationPayloads

playPayloads

version

optional

valid

Constructor Details

ModdedPacketRegistrar

ModdedPacketRegistrar

Method Details

getConfigurationRegistrations

getPlayRegistrations

play

configuration

play

configuration

common

configuration

play

validatePayload

versioned

optional

invalidate