Code Patterns

Copy-paste examples for common plugin tasks. Commands, events, ECS, GUI, and more.

← Back to Patterns
gui

UI Common Components

Reference built-in Hytale UI components from Common.ui in your custom .ui files.

Example Code

java
// At the top of your .ui file, reference Common.ui:
$C = "../Common.ui";

// Available built-in components:

// Page container with background overlay
$C.@PageOverlay { ... }

// Decorated window container with title area
$C.@DecoratedContainer {
    Anchor: (Width: 400, Height: 200);

    #Title {
        Group {
            $C.@Title {
                @Text = "WINDOW TITLE";
            }
        }
    }

    #Content {
        // Your content here
    }
}

// Standard text button
$C.@TextButton #MyButton {
    Text: "Click Me";
}

// Button click sounds
Sounds: $C.@ButtonSounds

// Layout modes for Groups:
// LayoutMode: Top;          // Stack children from top
// LayoutMode: Left;         // Stack children from left
// LayoutMode: MiddleCenter; // Center children

Common Mistakes

Forgetting $C = "../Common.ui"; at top of file. Using wrong component names.