Interface Packet

All Known Subinterfaces:
ToClientPacket, ToServerPacket
All Known Implementing Classes:
AddOrUpdatePointDisplay, AddOrUpdateTriggerVolumeDisplay, AddToServerPlayerList, ApplyKnockback, ArgCacheInvalidation, ArgValuesRequest, ArgValuesResponse, AssetEditorActivateButton, AssetEditorAssetListSetup, AssetEditorAssetListUpdate, AssetEditorAssetPackSetup, AssetEditorAssetPackUpdated, AssetEditorAssetUpdated, AssetEditorAuthorization, AssetEditorCapabilities, AssetEditorCreateAsset, AssetEditorCreateAssetPack, AssetEditorCreateDirectory, AssetEditorDeleteAsset, AssetEditorDeleteAssetPack, AssetEditorDeleteDirectory, AssetEditorDiscardChanges, AssetEditorExportAssetFinalize, AssetEditorExportAssetInitialize, AssetEditorExportAssetPart, AssetEditorExportAssets, AssetEditorExportComplete, AssetEditorExportDeleteAssets, AssetEditorFetchAsset, AssetEditorFetchAssetReply, AssetEditorFetchAutoCompleteData, AssetEditorFetchAutoCompleteDataReply, AssetEditorFetchJsonAssetWithParents, AssetEditorFetchJsonAssetWithParentsReply, AssetEditorFetchLastModifiedAssets, AssetEditorInitialize, AssetEditorJsonAssetUpdated, AssetEditorLastModifiedAssets, AssetEditorModifiedAssetsCount, AssetEditorModsDirectories, AssetEditorPopupNotification, AssetEditorRedoChanges, AssetEditorRenameAsset, AssetEditorRenameDirectory, AssetEditorRequestAssetInheritance, AssetEditorRequestAssetInheritanceReply, AssetEditorRequestChildrenList, AssetEditorRequestChildrenListReply, AssetEditorRequestDataset, AssetEditorRequestDatasetReply, AssetEditorSelectAsset, AssetEditorSetGameTime, AssetEditorSetupAssetTypes, AssetEditorSetupSchemas, AssetEditorSubscribeModifiedAssetsChanges, AssetEditorUndoChanges, AssetEditorUndoRedoReply, AssetEditorUpdateAsset, AssetEditorUpdateAssetPackManifest, AssetEditorUpdateJsonAsset, AssetEditorUpdateModelPreview, AssetEditorUpdateSecondsPerGameDay, AssetEditorUpdateWeatherPreviewLock, AssetFinalize, AssetInitialize, AssetPart, AuthGrant, AuthToken, BuilderToolArgUpdate, BuilderToolColorAction, BuilderToolEntityAction, BuilderToolEntityTransformSessionEnd, BuilderToolExtrudeAction, BuilderToolGeneralAction, BuilderToolGMaskPreset, BuilderToolGMaskPresetLoadResponse, BuilderToolHideAnchors, BuilderToolLaserPointer, BuilderToolLineAction, BuilderToolOnUseInteraction, BuilderToolPasteClipboard, BuilderToolPrefabPreview, BuilderToolRandomizeClipboard, BuilderToolResetClipboardRotation, BuilderToolRotateClipboard, BuilderToolSelectionToolAskForClipboard, BuilderToolSelectionToolReplyWithClipboard, BuilderToolSelectionTransform, BuilderToolSelectionUpdate, BuilderToolsEnabledTools, BuilderToolSetEntityCollision, BuilderToolSetEntityLight, BuilderToolSetEntityPickupEnabled, BuilderToolSetEntityScale, BuilderToolSetEntityTransform, BuilderToolSetEntityType, BuilderToolSetNPCDebug, BuilderToolSetTransformationModeState, BuilderToolShowAnchor, BuilderToolsSetSoundSet, BuilderToolStackArea, CachedPacket, CameraSequenceComplete, CameraSequenceKeyframes, CameraShakeEffect, CancelInteractionChain, CancelParticleSystems, ChangeVelocity, ChapterRewardsPageResult, ChatMessage, ClearChunks, ClearDebugShapes, ClearEditorTimeOverride, ClearWorldMap, ClientDisconnect, ClientMovement, ClientOpenWindow, ClientReady, ClientReferral, ClientTeleport, CloseWindow, CommandTreeSync, ConfigureIcePeer, Connect, ConnectAccept, CreateUserMarker, CustomHud, CustomPage, CustomPageEvent, DamageInfo, DismissServersidePage, DismountNPC, DisplayDebug, DropCreativeItem, DropItemStack, EditorBlocksChange, EntityUpdates, ExecuteServersideHudCommand, ExecuteServersidePageCommand, FailureReply, HideEventTitle, HideTriggerVolumePastePrefabPreview, InitViewModelTypes, InsecurePlayerOptions, InventoryAction, JoinWorld, KillFeedMessage, LoadHotbar, MountMovement, MountNPC, MouseInteraction, MoveItemStack, NetworkTick, Notification, OpenChapterRewardsPage, OpenChatWithCommand, OpenPortalActivePage, OpenPortalErrorPage, OpenPortalSummonPage, OpenWindow, PasswordAccepted, PasswordRejected, PasswordResponse, Ping, PlayAnimation, PlayCameraSequence, PlayEmote, PlayInteractionFor, PlaySoundEvent2D, PlaySoundEvent3D, PlaySoundEventEntity, PlaySoundEventLocalPlayer, PointToolCreate, PointToolCreateResponse, PointToolDelete, PointToolDuplicate, PointToolEquip, PointToolMove, PointToolMultiMove, PointToolRotate, PointToolSelect, PointToolSelection, PointToolSetShape, Pong, PortalActivePageResult, PortalSummonPageResult, PostMusicEvent, PrefabSetAnchor, PrefabUnselectPrefab, RelayedVoiceData, RemoveAssets, RemoveFromServerPlayerList, RemoveMapMarker, RemovePointDisplay, RemoveRecurringWorldEvents, RemoveTriggerVolumeDisplay, RequestAssets, RequestCameraSequenceKeyframes, RequestCommonAssetsRebuild, RequestFlyCameraMode, RequestInsecurePlayerOptions, RequestMachinimaActorModel, RequestNoClip, RequestServerAccess, ResetUserInterfaceState, ReticleEvent, SaveHotbar, SelectionToolShowTriggerVolumes, SelfGrantEntitlement, SendWindowAction, ServerAuthToken, ServerDisconnect, ServerInfo, ServerMessage, ServerSetBlock, ServerSetBlocks, ServerSetFluid, ServerSetFluids, ServerSetHeight, ServerSetHeights, ServerSetPaused, ServerTags, SetAbsentChunks, SetActiveSlot, SetAudioState, SetBlockAnimationSpeeds, SetBlockMusicEmitter, SetBlockPlacementOverride, SetChunk, SetChunkEnvironments, SetChunkHeightmap, SetChunkTintmap, SetClientId, SetColumn, SetCreativeItem, SetEntitySeed, SetFluids, SetFlyCameraMode, SetGameMode, SetMachinimaActorModel, SetMovementStates, SetNoClip, SetPage, SetPaused, SetServerAccess, SetServerCamera, SetTimeDilation, SetUpdateRate, SetupFinalize, ShowEventTitle, ShowTriggerVolumePastePrefabPreview, SmartGiveCreativeItem, SmartMoveItemStack, SpawnBlockParticleSystem, SpawnModelParticles, SpawnParticleSystem, StreamOpen, StreamOpenResponse, SuccessReply, SwitchHotbarBlockSet, SyncInteractionChains, SyncPlayerPreferences, TeleportToWorldMapMarker, TeleportToWorldMapPosition, TrackOrUpdateObjective, TriggerVolumeToolCreate, TriggerVolumeToolCreateResponse, TriggerVolumeToolDelete, TriggerVolumeToolDuplicate, TriggerVolumeToolEquip, TriggerVolumeToolGroupCreate, TriggerVolumeToolGroupCreateResponse, TriggerVolumeToolGroupMove, TriggerVolumeToolMove, TriggerVolumeToolMultiMove, TriggerVolumeToolResize, TriggerVolumeToolRotate, TriggerVolumeToolSelect, TriggerVolumeToolSelection, TriggerVolumeToolSetActivationDelay, TriggerVolumeToolSetCancelDelayedOnExit, TriggerVolumeToolSetColor, TriggerVolumeToolSetConditionTiming, TriggerVolumeToolSetCooldown, TriggerVolumeToolSetKeepLoaded, TriggerVolumeToolSetName, TriggerVolumeToolSetTargetTypes, TriggerVolumeToolUngroup, UnloadChunk, UnloadChunks, UnloadSection, UntrackObjective, UpdateAbilityKeywords, UpdateAmbienceFX, UpdateAnchorUI, UpdateAudioCategories, UpdateAudioStates, UpdateBeamConfigs, UpdateBlockBreakingDecals, UpdateBlockDamage, UpdateBlockDamages, UpdateBlockGroups, UpdateBlockHitboxes, UpdateBlockParticleSets, UpdateBlockSets, UpdateBlockSoundSets, UpdateBlockTypes, UpdateBossBar, UpdateCameraShake, UpdateClientRuleVolumes, UpdateConnectedBlockRuleSets, UpdateEditorTimeOverride, UpdateEditorWeatherOverride, UpdateEmotes, UpdateEntityEffects, UpdateEntityStatTypes, UpdateEntityUIComponents, UpdateEnvironments, UpdateEqualizerEffects, UpdateFeatures, UpdateFieldcraftCategories, UpdateFluidFX, UpdateFluids, UpdateForcedMusic, UpdateHitboxCollisionConfig, UpdateInteractions, UpdateItemCategories, UpdateItemPlayerAnimations, UpdateItemQualities, UpdateItemReticles, UpdateItems, UpdateItemSoundSets, UpdateKnownRecipes, UpdateLanguage, UpdateLivesRemaining, UpdateMachinimaScene, UpdateMemoriesCount, UpdateMemoriesFeatureStatus, UpdateModelvfxs, UpdateMovementSettings, UpdateMusicContainers, UpdateMusicTransitions, UpdateObjectiveTask, UpdateParticleSpawners, UpdateParticleSystems, UpdatePhysicalMaterials, UpdatePlayerInventory, UpdatePointDisplay, UpdatePortal, UpdatePostFxSettings, UpdateProjectileConfigs, UpdateRecipes, UpdateRecurringWorldEvents, UpdateRepulsionConfig, UpdateResourceTypes, UpdateReverbEffects, UpdateRootInteractions, UpdateServerAccess, UpdateServerPlayerList, UpdateServerPlayerListPing, UpdateServersideHud, UpdateServersideUIPage, UpdateSleepState, UpdateSoundEvents, UpdateSoundSets, UpdateStingers, UpdateSunSettings, UpdateTagPatterns, UpdateTime, UpdateTimeSettings, UpdateTrails, UpdateTranslations, UpdateTriggerVolumeDisplay, UpdateUnarmedInteractions, UpdateViewBobbing, UpdateVisibleHudComponents, UpdateWeather, UpdateWeathers, UpdateWindow, UpdateWorldMap, UpdateWorldMapSettings, UpdateWorldMapVisible, ViewRadius, VoiceConfig, VoiceData, WorldGameplayConfig, WorldLoadFinished, WorldLoadProgress, WorldSavingStatus, WorldSettings
public interface Packet
Interface for all new protocol packets. Matches C# IPacket from Hytale.Protocol.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    computeSize()
    Compute the exact number of bytes needed to serialize this packet.
    NetworkChannel
    getChannel()
    Returns the channel this packet should be sent on.
    int
    getId()
    Returns the unique packet ID.
    int
    serialize(MemorySegment buffer, int offset)
    Writes this packet at offset and returns the number of bytes written, which callers rely on being exactly computeSize().

  • Method Details

    • getId

      int getId()
      Returns the unique packet ID.

    • getChannel

      NetworkChannel getChannel()
      Returns the channel this packet should be sent on.

    • serialize

      int serialize(@Nonnull MemorySegment buffer, int offset)
      Writes this packet at offset and returns the number of bytes written, which callers rely on being exactly computeSize(). The framed write path reserves and length-prefixes on that figure before serializing, so a shorter or longer write corrupts the frame rather than failing.

    • computeSize

      int computeSize()
      Compute the exact number of bytes needed to serialize this packet.