API Reference on Hytale Documentation

Entity and Player System

Mon, 01 Jan 0001 00:00:00 +0000

Entity and Player System Entity Class Hierarchy Entity (abstract) ├── LivingEntity (abstract) │ └── Player └── BlockEntity Entity Base class for all entities. Implements Component<EntityStore>. Fields: networkId - Unique network identifier legacyUuid - UUID for persistence world - Parent world reference reference - Ref<EntityStore> reference wasRemoved - AtomicBoolean removal flag Key Methods: remove() - Removes entity from world loadIntoWorld(World) - Adds entity to world unloadFromWorld() - Removes from world without events setReference(Ref) - Sets ECS reference toHolder() - Converts to component holder isCollidable() - Collision check LivingEntity Entities that can have inventory, take damage, and fall.

Event and Interaction System

Mon, 01 Jan 0001 00:00:00 +0000

Event and Interaction System Event System Architecture Core Interfaces Interface Description IBaseEvent<KeyType> Root interface for all events IEvent<KeyType> Synchronous events IAsyncEvent<KeyType> Asynchronous events ICancellable Cancellation support IEventDispatcher<EventType, ReturnType> Event dispatching ICancellable Interface interface ICancellable { boolean isCancelled(); void setCancelled(boolean cancelled); } Event Priorities enum EventPriority { FIRST(-21844), // Highest priority - validation EARLY(-10922), // Setup/preparation NORMAL(0), // Default processing LATE(10922), // Post-processing LAST(21844); // Lowest priority - cleanup/logging } Execution order: FIRST → EARLY → NORMAL → LATE → LAST

GUI and Window System

Mon, 01 Jan 0001 00:00:00 +0000

GUI and Window System Window Class Hierarchy Window (abstract) ├── ContainerWindow (implements ItemContainerWindow) ├── BlockWindow (abstract, implements ValidatedWindow) │ └── ContainerBlockWindow (implements ItemContainerWindow) └── ItemStackContainerWindow (implements ItemContainerWindow) Window Base Class Abstract base for all windows. Abstract Methods: getData() - Returns JsonObject with window configuration onOpen0() - Called when opening (return false to cancel) onClose0() - Called when closing Key Features: Window ID management (assigned by WindowManager) Window type classification Dirty state tracking for updates Close event registration with priority support Action handling via handleAction(Ref, Store, WindowAction) Static registry: CLIENT_REQUESTABLE_WINDOW_TYPES Window Implementations Class Description ContainerWindow Basic container with ItemContainer BlockWindow Abstract, tied to world blocks, validates distance ContainerBlockWindow Block-based container (chests), handles sorting ItemStackContainerWindow Container for item stacks, auto-closes on invalid WindowManager Manages all open windows for a player.

Hytale Server API Documentation

Mon, 01 Jan 0001 00:00:00 +0000

Hytale Server API Documentation Technical reference for the Hytale server API. Getting Started New to mod development? Start with the Mod Development Guide for a complete example with best practices. Documentation Index Guides Document Description Mod Development Guide Complete example mod with clean code, security, API isolation JSON Systems Item/Block JSON, localization, particles API Reference Document Description Asset Loading AssetStore, AssetRegistry, AssetMap types, loading pipeline Items & Blocks ItemBase, BlockType, specializations, enums Events & Interactions EventBus, InteractionType, RootInteraction, InteractionChain GUI & Windows Window hierarchy, WindowManager, WindowAction types Networking & Packets Packet protocol, framing, VarInt, compression Plugin System PluginBase, JavaPlugin, lifecycle, registries Entity & Player ECS architecture, Entity hierarchy, Inventory World & Chunks World, ChunkStore, coordinate systems Quick Reference Creating a Plugin public class MyPlugin extends JavaPlugin { public MyPlugin(JavaPluginInit init) { super(init); } @Override protected void setup() { getEventRegistry().

Item and Block System

Mon, 01 Jan 0001 00:00:00 +0000

Hytale Server API - Item and Block System Item System ItemBase The protocol class for all items. Location: com/hypixel/hytale/protocol/ItemBase.java Identity & Display Fields: Field Type Description id String Unique identifier name String Display name model String Model reference texture String Texture reference icon String Icon reference iconProperties AssetIconProperties Icon display properties translationProperties ItemTranslationProperties Localization config scale float Item scale multiplier Stack & Durability Fields: Field Type Description maxStack int Maximum stack size durability double Item durability value consumable boolean Whether item is consumable variant boolean Whether item is a variant Item Level & Quality:

Networking and Packet System

Mon, 01 Jan 0001 00:00:00 +0000

Hytale Server API - Networking & Packet System Packet Interface Location: com/hypixel/hytale/protocol/Packet.java public interface Packet { int getId(); void serialize(@Nonnull ByteBuf byteBuf); int computeSize(); } Frame Format [4 bytes: LE payload length] [4 bytes: LE packet ID] [N bytes: payload (compressed or uncompressed)] Constants: Frame header: 8 bytes minimum Maximum payload size: 1,677,721,600 bytes (1.6 GB) All integers: Little-Endian byte order PacketRegistry Location: com/hypixel/hytale/protocol/PacketRegistry.java PacketInfo Structure public static final class PacketInfo extends Record { int id; String name; Class<?

Plugin System

Mon, 01 Jan 0001 00:00:00 +0000

Hytale Server API - Plugin System PluginBase Location: com/hypixel/hytale/server/core/plugin/PluginBase.java Fields: Field Type Description logger HytaleLogger Plugin logger identifier PluginIdentifier Unique identifier (group:name) manifest PluginManifest Plugin manifest dataDirectory Path Data directory path configs List<Config> Configuration files state PluginState Current lifecycle state shutdownTasks CopyOnWriteArrayList Shutdown callbacks basePermission String Base permission node Registries: Field Type Description clientFeatureRegistry ClientFeatureRegistry Client features commandRegistry CommandRegistry Commands eventRegistry EventRegistry Event listeners blockStateRegistry BlockStateRegistry Block states entityRegistry EntityRegistry Entity types taskRegistry TaskRegistry Scheduled tasks entityStoreRegistry ComponentRegistryProxy Entity components chunkStoreRegistry ComponentRegistryProxy Chunk components assetRegistry AssetRegistry Asset stores codecMapRegistries Map<Codec

World and Chunk System

Mon, 01 Jan 0001 00:00:00 +0000

Hytale Server API - World and Chunk System World Location: com/hypixel/hytale/server/core/universe/world/World.java public class World extends TickingThread implements Executor, ChunkAccessor<WorldChunk>, IWorldChunks, IMessageReceiver Fields: Field Type Description name String World identifier savePath Path Disk storage path worldConfig WorldConfig World configuration chunkStore ChunkStore Chunk storage manager entityStore EntityStore Entity storage manager chunkLighting ChunkLightingManager Lighting system worldMapManager WorldMapManager World map manager worldPathConfig WorldPathConfig Path configuration taskQueue Deque Task execution queue alive AtomicBoolean World alive state eventRegistry EventRegistry Event system isTicking boolean Whether world updates isPaused boolean Whether world is paused tick long Current tick counter random Random Random generator entitySeed AtomicInteger Entity RNG seed players Map<UUID, PlayerRef> Connected players Constants: