Package net.neoforged.neoforge.event.entity.player

Class ClientInformationUpdatedEvent

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.event.entity.EntityEvent

net.neoforged.neoforge.event.entity.living.LivingEvent

net.neoforged.neoforge.event.entity.player.PlayerEvent

net.neoforged.neoforge.event.entity.player.ClientInformationUpdatedEvent

public class ClientInformationUpdatedEvent
extends PlayerEvent

ClientInformationUpdatedEvent is fired when a player changes server-synced client options, specifically those in ClientInformation.

This event is fired on the NeoForge.EVENT_BUS.

Nested Class Summary

Nested classes/interfaces inherited from class net.neoforged.neoforge.event.entity.player.PlayerEvent

PlayerEvent.BreakSpeed, PlayerEvent.Clone, PlayerEvent.HarvestCheck, PlayerEvent.ItemCraftedEvent, PlayerEvent.ItemSmeltedEvent, PlayerEvent.LoadFromFile, PlayerEvent.NameFormat, PlayerEvent.PlayerChangedDimensionEvent, PlayerEvent.PlayerChangeGameModeEvent, PlayerEvent.PlayerLoggedInEvent, PlayerEvent.PlayerLoggedOutEvent, PlayerEvent.PlayerRespawnEvent, PlayerEvent.SaveToFile, PlayerEvent.StartTracking, PlayerEvent.StopTracking, PlayerEvent.TabListNameFormat

Nested classes/interfaces inherited from class net.neoforged.neoforge.event.entity.living.LivingEvent

LivingEvent.LivingJumpEvent, LivingEvent.LivingVisibilityEvent

Nested classes/interfaces inherited from class net.neoforged.neoforge.event.entity.EntityEvent

EntityEvent.EnteringSection, EntityEvent.EntityConstructing, EntityEvent.Size

Field Summary

Fields

Modifier and Type	Field	Description
private final ClientInformation	oldInformation
private final ClientInformation	updatedInformation

Constructor Summary

Constructors

Constructor	Description
ClientInformationUpdatedEvent(ServerPlayer player, ClientInformation oldInfo, ClientInformation newInfo)

Method Summary

Modifier and Type	Method	Description
ServerPlayer	getEntity()
ClientInformation	getOldInformation()	Returns the existing client info from to the player.
ClientInformation	getUpdatedInformation()	Returns the new client info to be applied to the player.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

oldInformation

private final ClientInformation oldInformation

updatedInformation

private final ClientInformation updatedInformation

Constructor Details

ClientInformationUpdatedEvent

public ClientInformationUpdatedEvent(ServerPlayer player,
 ClientInformation oldInfo,
 ClientInformation newInfo)

Method Details

getEntity

public ServerPlayer getEntity()

Overrides:

getEntity in class PlayerEvent

getUpdatedInformation

public ClientInformation getUpdatedInformation()

Returns the new client info to be applied to the player. Sometimes the client resends unchanged options, so if that matters for your use case, check equality with getOldInformation().

Returns:

updated information

getOldInformation

public ClientInformation getOldInformation()

Returns the existing client info from to the player.

May be blank or defaulted initial data on first event call for a player instance.

Returns:

updated information