com.hypixel.hytale.builtin.buildertools
Package: com.hypixel.hytale.builtin.buildertools
Built-in builder tools module providing WorldEdit-like block editing, prefab editing, scripted brushes, OBJ/image import, and clipboard/undo-redo infrastructure for creative-mode world building. None of the types in this package are part of the public API surface.
Plugin Entry Point
Section titled “Plugin Entry Point”| Type | Kind | Description |
|---|---|---|
| BuilderToolsPlugin | class | Main plugin class; singleton entry point for all builder tool functionality. |
ECS Components and Systems
Section titled “ECS Components and Systems”| Type | Kind | Description |
|---|---|---|
| BuilderToolsUserData | class | Per-player EntityStore component tracking selection history preference. |
| BuilderToolsUserDataSystem | class | HolderSystem ensuring BuilderToolsUserData on player entities. |
| BuilderToolsSystems | class | Container for builder tools ECS systems. |
| BuilderToolsSystems.EnsureBuilderTools | class | HolderSystem populating player tool inventories on join. |
Networking
Section titled “Networking”| Type | Kind | Description |
|---|---|---|
| BuilderToolsPacketHandler | class | Handles all client-server builder tool packets (20+ handlers). |
Editing Infrastructure
Section titled “Editing Infrastructure”| Type | Kind | Description |
|---|---|---|
| EditOperation | class | Tracks before/after block state for brush operations. |
| CopyCutSettings | class | Bitflag constants for copy/cut clipboard operations. |
Color Matching
Section titled “Color Matching”| Type | Kind | Description |
|---|---|---|
| BlockColorIndex | class | Maps block types to CIE Lab colors for image import. |
| BlockColorIndex.BlockColorEntry | record | Per-block color data record. |
Per-Player Settings
Section titled “Per-Player Settings”| Type | Kind | Description |
|---|---|---|
| PrototypePlayerBuilderToolSettings | class | Per-player brush, transform, and clipboard settings. |
| PrototypePlayerBuilderToolSettings.EntityChange | record | Entity position and holder for clipboard transform. |
| PrototypePlayerBuilderToolSettings.FluidChange | record | Fluid position and state for clipboard transform. |
Undo/Redo System
Section titled “Undo/Redo System”| Type | Kind | Description |
|---|---|---|
| BuilderToolsPlugin.Action | enum | Action types for undo/redo entries. |
| BuilderToolsPlugin.ActionEntry | class | Pairs an action with its snapshots for undo/redo. |
Builder State
Section titled “Builder State”| Type | Kind | Description |
|---|---|---|
| BuilderToolsPlugin.BuilderState | class | Per-player selection, clipboard, undo/redo, and task queue. |
| BuilderToolsPlugin.BuilderState.BlocksSampleData | class | Sampling data for block majority calculations. |
| BuilderToolsPlugin.BuilderState.SmoothSampleData | class | Sampling data for smooth operations. |
Configuration
Section titled “Configuration”| Type | Kind | Description |
|---|---|---|
| BuilderToolsPlugin.BuilderToolsConfig | class | Plugin configuration (history count, tool expire time). |
Internal Infrastructure
Section titled “Internal Infrastructure”| Type | Kind | Description |
|---|---|---|
| BuilderToolsPlugin.CachedAccessor | class | Thread-local cached chunk section accessor. |
| BuilderToolsPlugin.PrefabPasteEventSystem | class | ECS system handling prefab paste events. |
| BuilderToolsPlugin.QueuedTask | class | Wrapper for queued async builder operations. |
Exceptions
Section titled “Exceptions”| Type | Kind | Description |
|---|---|---|
| PrefabCopyException | class | Thrown when a prefab copy operation fails. |
Sub-packages
Section titled “Sub-packages”This package has extensive sub-packages not covered here:
commands/— 38+ slash commands for selection, editing, clipboard, and historyscriptedbrushes/— Data-driven brush operation system with 50+ operation typesprefabeditor/— Prefab editing session management with isolated worldstooloperations/— Real-time brush tool operations (Paint, Sculpt, Flood, etc.)snapshot/— Undo/redo snapshot types (block, clipboard, entity)imageimport/— Image-to-blocks import via color matchingobjimport/— OBJ 3D model voxelization importinteractions/— Custom block interactions (pickup, prefab selection)utils/— Material value type and fluid helpers
Hydex is an independent community resource. Hytale is a trademark of Hypixel Studios. Hydex is not affiliated with or endorsed by Hypixel Studios.