Class GamePacketHandler

java.lang.Object

com.hypixel.hytale.server.core.io.PacketHandler

com.hypixel.hytale.server.core.io.handlers.GenericPacketHandler

com.hypixel.hytale.server.core.io.handlers.game.GamePacketHandler

All Implemented Interfaces:

ConnectionHandler, IPacketHandler, IPacketReceiver

public class GamePacketHandler
extends GenericPacketHandler
implements IPacketHandler

Nested Class Summary

Nested classes/interfaces inherited from class PacketHandler

PacketHandler.DisconnectReason, PacketHandler.PingInfo

Field Summary

Fields inherited from class PacketHandler

DEFAULT_STREAM_PRIORITIES, MAX_PACKET_ID

Constructor Summary

Constructors

Constructor	Description
GamePacketHandler(ChannelConnection channel, ProtocolVersion protocolVersion, PlayerAuthentication auth)	Default Constructor for a GamePacketHandler instance

Method Summary

Modifier and Type	Method	Description
void	closed(NetworkChannel networkChannel)	Called when the affiliated network channel has been closed.
void	disconnect(FormattedMessage message)	Called to disconnect this connection for the given reason.
ProfileServiceClient.PublicGameProfile	getAccountProfile()	Returns the account to track for lookups, bans, and kicks.
String	getIdentifier()
Deque<SyncInteractionChain>	getInteractionPacketQueue()
PlayerRef	getPlayerRef()
void	handle(ClientDisconnect packet)	A callback to handle ClientDisconnect packets from the client.
void	handle(SyncInteractionChains packet)	A callback to handle SyncInteractionChain packets from the client.
void	handle(ArgValuesRequest packet)
void	handle(ChatMessage packet)	A callback to handle ChatMessage packets from the client.
void	handle(CustomPageEvent packet)	A callback to handle CustomPageEvent packets from the client.
void	handle(DismissServersidePage packet)	A callback to handle DismissServersidePage packets from the client.
void	handle(ExecuteServersideHudCommand packet)	A callback to handle ExecuteServersideHudCommand packets from the client.
void	handle(ExecuteServersidePageCommand packet)	A callback to handle ExecuteServersidePageCommand packets from the client.
void	handle(RequestMachinimaActorModel packet)	A callback to handle RequestMachinimaActorModel packets from the client.
void	handle(ClientMovement packet)	A callback to handle ClientMovement packets from the client.
void	handle(ClientReady packet)	A callback to handle ClientReady packets from the client.
void	handle(ConfigureIcePeer packet)	A callback to handle ConfigureIcePeer packets from the client.
void	handle(SetServerAccess packet)	A callback to handle SetServerAccess packets from the client.
void	handle(UpdateServerAccess packet)	A callback to handle UpdateServerAccess packets from the client.
void	handleChapterRewardsPageResult(ChapterRewardsPageResult packet, PlayerRef playerRef, Ref<EntityStore> ref, World world, Store<EntityStore> store)	A callback to handle ChapterRewardsPageResult packets from the client.
void	handleCloseWindow(CloseWindow packet, PlayerRef playerRef, Ref<EntityStore> ref, World world, Store<EntityStore> store)	A callback to handle CloseWindow packets from the client.
void	handleCreateUserMarker(CreateUserMarker packet, PlayerRef playerRef, Ref<EntityStore> ref, World world, Store<EntityStore> store)
void	handleMountMovement(MountMovement packet, PlayerRef playerRef, Ref<EntityStore> ref, World world, Store<EntityStore> store)	A callback to handle MountMovement packets from the client.
void	handleMouseInteraction(MouseInteraction packet, PlayerRef playerRef, Ref<EntityStore> ref, World world, Store<EntityStore> store)	A callback to handle MouseInteraction packets from the client.
void	handlePlayEmote(PlayEmote packet, PlayerRef playerRef, Ref<EntityStore> ref, World world, Store<EntityStore> store)	A callback to handle PlayEmote packets from the client.
void	handleRemoveMapMarker(RemoveMapMarker packet, PlayerRef playerRef, Ref<EntityStore> ref, World world, Store<EntityStore> store)	A callback to handle RemoveMapMarker packets from the client.
void	handleRequestFlyCameraMode(RequestFlyCameraMode packet, PlayerRef playerRef, Ref<EntityStore> ref, World world, Store<EntityStore> store)	A callback to handle RequestFlyCameraMode packets from the client.
void	handleRequestNoClip(RequestNoClip packet, PlayerRef playerRef, Ref<EntityStore> ref, World world, Store<EntityStore> store)	A callback to handle RequestNoClip packets from the client.
void	handleSendWindowAction(SendWindowAction packet, PlayerRef playerRef, Ref<EntityStore> ref, World world, Store<EntityStore> store)	A callback to handle SendWindowAction packets from the client.
void	handleSetPaused(SetPaused packet, PlayerRef playerRef, Ref<EntityStore> ref, World world, Store<EntityStore> store)	A callback to handle SetPaused packets from the client.
static void	handleSyncPlayerPreferences(SyncPlayerPreferences packet, PlayerRef playerRef, Ref<EntityStore> ref, World world, Store<EntityStore> store)	A callback to handle SyncPlayerPreferences packets from the client.
void	handleTeleportToWorldMapMarker(TeleportToWorldMapMarker packet, PlayerRef playerRef, Ref<EntityStore> ref, World world, Store<EntityStore> store)	A callback to handle TeleportToWorldMapMarker packets from the client.
void	handleTeleportToWorldMapPosition(TeleportToWorldMapPosition packet, PlayerRef playerRef, Ref<EntityStore> ref, World world, Store<EntityStore> store)	A callback to handle TeleportToWorldMapPosition packets from the client.
void	handleUpdateLanguage(UpdateLanguage packet, PlayerRef playerRef, Ref<EntityStore> ref, World world, Store<EntityStore> store)	A callback to handle UpdateLanguage packets from the client.
void	handleUpdateMachinimaScene(UpdateMachinimaScene packet, PlayerRef playerRef, Ref<EntityStore> ref, World world, Store<EntityStore> store)	A callback to handle UpdateMachinimaScene packets from the client.
void	handleUpdateWorldMapVisible(UpdateWorldMapVisible packet, PlayerRef playerRef, Ref<EntityStore> ref, World world, Store<EntityStore> store)	A callback to handle UpdateWorldMapVisible packets from the client.
void	handleViewRadius(ViewRadius packet, PlayerRef playerRef, Ref<EntityStore> ref, World world, Store<EntityStore> store)	A callback to handle ViewRadius packets from the client.
void	sendCommandTree()
void	setPlayerRef(PlayerRef playerRef)	Sets the player ref associated with this handler

Methods inherited from class GenericPacketHandler

accept, getSubPacketHandler, newHandlerArray, registerHandler, registerNoOpHandlers, registerSubPacketHandler

Methods inherited from class PacketHandler

checkStreamOpenRateLimit, compareAndSetChannel, disconnect, getAuth, getAuxiliaryChannelCount, getChannel, getChannel, getChannel, getClientReadyForChunksFuture, getDisconnectReason, getOperationTimeoutThreshold, getPacketStatsRecorder, getPingInfo, getProtocolVersion, getQueuedPacketsCount, getSniHostname, handle, handlePong, isLANConnection, isLocalConnection, logCloseMessage, logConnectionTimings, registered, sendPing, setChannel, setChannel, setClientReadyForChunksFuture, setQueuePackets, stillActive, tickPing, tryFlush, unregistered, write, write, write, writeNoCache, writePacket

Methods inherited from class Object

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

Methods inherited from interface IPacketHandler

registerHandler, registerNoOpHandlers

Constructor Details

GamePacketHandler

public GamePacketHandler(@Nonnull
 ChannelConnection channel,
 @Nonnull
 ProtocolVersion protocolVersion,
 @Nonnull
 PlayerAuthentication auth)

Default Constructor for a GamePacketHandler instance

Parameters:

channel - The network channel associated with this handler

protocolVersion - The network protocol version

auth - The authentication of the associated player

Method Details

getInteractionPacketQueue

@Nonnull
public Deque<SyncInteractionChain> getInteractionPacketQueue()

getPlayerRef

@Nonnull
public PlayerRef getPlayerRef()

Specified by:

getPlayerRef in interface IPacketHandler

Returns:

the PlayerRef of the connection associated with this handler.

setPlayerRef

public void setPlayerRef(@Nonnull
 PlayerRef playerRef)

Sets the player ref associated with this handler

Parameters:

playerRef - The player ref to set

getIdentifier

@Nonnull
public String getIdentifier()

Specified by:

getIdentifier in interface IPacketHandler

Specified by:

getIdentifier in class PacketHandler

Returns:

the unique identifier for this handler

getAccountProfile

@Nonnull
public ProfileServiceClient.PublicGameProfile getAccountProfile()

Description copied from class: PacketHandler

Returns the account to track for lookups, bans, and kicks.

Override this method for authenticated handlers. The profile must be available before registration and remain available through cleanup. The account UUID and whether this method returns null must remain stable for this handler's lifetime. Keep this method nonblocking and free of side effects. Registry membership does not perform access checks.

Overrides:

getAccountProfile in class PacketHandler

Returns:

the account to track, or null to exclude this handler

sendCommandTree

public void sendCommandTree()

closed

public void closed(@Nullable
 NetworkChannel networkChannel)

Description copied from interface: ConnectionHandler

Called when the affiliated network channel has been closed.

Specified by:

closed in interface ConnectionHandler

Overrides:

closed in class PacketHandler

Parameters:

networkChannel - The network channel that was closed, or null if unknown

disconnect

public void disconnect(@Nonnull
 FormattedMessage message)

Description copied from class: PacketHandler

Called to disconnect this connection for the given reason.

Overrides:

disconnect in class PacketHandler

Parameters:

message - The formatted reason in which the connection is being disconnected

handle

public void handle(@Nonnull
 ClientDisconnect packet)

A callback to handle ClientDisconnect packets from the client.

Parameters:

packet - The received ClientDisconnect packet.

handleMouseInteraction

public void handleMouseInteraction(@Nonnull
 MouseInteraction packet,
 @Nonnull
 PlayerRef playerRef,
 @Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 World world,
 @Nonnull
 Store<EntityStore> store)

A callback to handle MouseInteraction packets from the client.

Parameters:

packet - The received MouseInteraction packet.

handle

public void handle(@Nonnull
 ClientMovement packet)

A callback to handle ClientMovement packets from the client.

Parameters:

packet - The received ClientMovement packet.

handle

public void handle(@Nonnull
 ChatMessage packet)

A callback to handle ChatMessage packets from the client.

Parameters:

packet - The received ChatMessage packet.

handle

public void handle(@Nonnull
 ArgValuesRequest packet)

handle

public void handle(@Nonnull
 CustomPageEvent packet)

A callback to handle CustomPageEvent packets from the client.

Parameters:

packet - The received CustomPageEvent packet.

handle

public void handle(@Nonnull
 ExecuteServersidePageCommand packet)

A callback to handle ExecuteServersidePageCommand packets from the client.

Parameters:

packet - The received ExecuteServersidePageCommand packet.

handle

public void handle(@Nonnull
 DismissServersidePage packet)

A callback to handle DismissServersidePage packets from the client. Sent when the player closes a server-side page client-side so the server can run teardown and lifecycle hooks.

Parameters:

packet - The received DismissServersidePage packet.

handle

public void handle(@Nonnull
 ExecuteServersideHudCommand packet)

A callback to handle ExecuteServersideHudCommand packets from the client.

Parameters:

packet - The received ExecuteServersideHudCommand packet.

handleChapterRewardsPageResult

public void handleChapterRewardsPageResult(@Nonnull
 ChapterRewardsPageResult packet,
 @Nonnull
 PlayerRef playerRef,
 @Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 World world,
 @Nonnull
 Store<EntityStore> store)

A callback to handle ChapterRewardsPageResult packets from the client.

Parameters:

packet - The received ChapterRewardsPageResult packet.

handleViewRadius

public void handleViewRadius(@Nonnull
 ViewRadius packet,
 @Nonnull
 PlayerRef playerRef,
 @Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 World world,
 @Nonnull
 Store<EntityStore> store)

A callback to handle ViewRadius packets from the client.

Parameters:

packet - The received ViewRadius packet.

handleUpdateLanguage

public void handleUpdateLanguage(@Nonnull
 UpdateLanguage packet,
 @Nonnull
 PlayerRef playerRef,
 @Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 World world,
 @Nonnull
 Store<EntityStore> store)

A callback to handle UpdateLanguage packets from the client.

Parameters:

packet - The received UpdateLanguage packet.

handleSendWindowAction

public void handleSendWindowAction(@Nonnull
 SendWindowAction packet,
 @Nonnull
 PlayerRef playerRef,
 @Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 World world,
 @Nonnull
 Store<EntityStore> store)

A callback to handle SendWindowAction packets from the client.

Parameters:

packet - The received SendWindowAction packet.

handleSyncPlayerPreferences

public static void handleSyncPlayerPreferences(@Nonnull
 SyncPlayerPreferences packet,
 @Nonnull
 PlayerRef playerRef,
 @Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 World world,
 @Nonnull
 Store<EntityStore> store)

A callback to handle SyncPlayerPreferences packets from the client.

Parameters:

packet - The received SyncPlayerPreferences packet.

handleRemoveMapMarker

public void handleRemoveMapMarker(@Nonnull
 RemoveMapMarker packet,
 @Nonnull
 PlayerRef playerRef,
 @Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 World world,
 @Nonnull
 Store<EntityStore> store)

A callback to handle RemoveMapMarker packets from the client.

Parameters:

packet - The received RemoveMapMarker packet.

handleCloseWindow

public void handleCloseWindow(@Nonnull
 CloseWindow packet,
 @Nonnull
 PlayerRef playerRef,
 @Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 World world,
 @Nonnull
 Store<EntityStore> store)

A callback to handle CloseWindow packets from the client.

Parameters:

packet - The received CloseWindow packet.

handle

public void handle(@Nonnull
 UpdateServerAccess packet)

A callback to handle UpdateServerAccess packets from the client.

Parameters:

packet - The received UpdateServerAccess packet.

handle

public void handle(@Nonnull
 ConfigureIcePeer packet)

A callback to handle ConfigureIcePeer packets from the client.

Parameters:

packet - The received ConfigureIcePeer packet.

handle

public void handle(@Nonnull
 SetServerAccess packet)

A callback to handle SetServerAccess packets from the client.

Parameters:

packet - The received SetServerAccess packet.

handle

public void handle(@Nonnull
 RequestMachinimaActorModel packet)

A callback to handle RequestMachinimaActorModel packets from the client.

Parameters:

packet - The received RequestMachinimaActorModel packet.

handleUpdateMachinimaScene

public void handleUpdateMachinimaScene(@Nonnull
 UpdateMachinimaScene packet,
 @Nonnull
 PlayerRef playerRef,
 @Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 World world,
 @Nonnull
 Store<EntityStore> store)

A callback to handle UpdateMachinimaScene packets from the client.

Parameters:

packet - The received UpdateMachinimaScene packet.

handle

public void handle(@Nonnull
 ClientReady packet)

A callback to handle ClientReady packets from the client.

Parameters:

packet - The received ClientReady packet.

handleUpdateWorldMapVisible

public void handleUpdateWorldMapVisible(@Nonnull
 UpdateWorldMapVisible packet,
 @Nonnull
 PlayerRef playerRef,
 @Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 World world,
 @Nonnull
 Store<EntityStore> store)

A callback to handle UpdateWorldMapVisible packets from the client.

Parameters:

packet - The received UpdateWorldMapVisible packet.

handleTeleportToWorldMapMarker

public void handleTeleportToWorldMapMarker(@Nonnull
 TeleportToWorldMapMarker packet,
 @Nonnull
 PlayerRef playerRef,
 @Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 World world,
 @Nonnull
 Store<EntityStore> store)

A callback to handle TeleportToWorldMapMarker packets from the client.

Parameters:

packet - The received TeleportToWorldMapMarker packet.

handleTeleportToWorldMapPosition

public void handleTeleportToWorldMapPosition(@Nonnull
 TeleportToWorldMapPosition packet,
 @Nonnull
 PlayerRef playerRef,
 @Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 World world,
 @Nonnull
 Store<EntityStore> store)

A callback to handle TeleportToWorldMapPosition packets from the client.

Parameters:

packet - The received TeleportToWorldMapPosition packet.

handleCreateUserMarker

public void handleCreateUserMarker(@Nonnull
 CreateUserMarker packet,
 @Nonnull
 PlayerRef playerRef,
 @Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 World world,
 @Nonnull
 Store<EntityStore> store)

handle

public void handle(@Nonnull
 SyncInteractionChains packet)

A callback to handle SyncInteractionChain packets from the client.

Parameters:

packet - The received SyncInteractionChain packet.

handleMountMovement

public void handleMountMovement(@Nonnull
 MountMovement packet,
 @Nonnull
 PlayerRef playerRef,
 @Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 World world,
 @Nonnull
 Store<EntityStore> store)

A callback to handle MountMovement packets from the client.

Parameters:

packet - The received MountMovement packet.

handlePlayEmote

public void handlePlayEmote(@Nonnull
 PlayEmote packet,
 @Nonnull
 PlayerRef playerRef,
 @Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 World world,
 @Nonnull
 Store<EntityStore> store)

A callback to handle PlayEmote packets from the client. Replicates the emote to all players that can see this entity via AnimationUtils.

Parameters:

packet - The received PlayEmote packet.

handleSetPaused

public void handleSetPaused(@Nonnull
 SetPaused packet,
 @Nonnull
 PlayerRef playerRef,
 @Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 World world,
 @Nonnull
 Store<EntityStore> store)

A callback to handle SetPaused packets from the client.

Parameters:

packet - The received SetPaused packet.

handleRequestFlyCameraMode

public void handleRequestFlyCameraMode(@Nonnull
 RequestFlyCameraMode packet,
 @Nonnull
 PlayerRef playerRef,
 @Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 World world,
 @Nonnull
 Store<EntityStore> store)

A callback to handle RequestFlyCameraMode packets from the client.

Parameters:

packet - The received RequestFlyCameraMode packet.

handleRequestNoClip

public void handleRequestNoClip(@Nonnull
 RequestNoClip packet,
 @Nonnull
 PlayerRef playerRef,
 @Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 World world,
 @Nonnull
 Store<EntityStore> store)

A callback to handle RequestNoClip packets from the client. The server is authoritative for no-clip: it validates the permission and echoes the result back via SetNoClip.

Parameters:

packet - The received RequestNoClip packet.