Player Component

The Player component contains player-specific data like inventory, game mode, and messaging.

API Reference

See full API: Player | PlayerRef | Inventory | ItemContainer

Overview

Property	Value
Class	com.hypixel.hytale.server.core.entity.entities.Player
Component Type	Player.getComponentType()

Getting the Component

// From Ref
Player player = (Player) commandBuffer.getComponent(ref, Player.getComponentType());

// From ArchetypeChunk
Player player = (Player) chunk.getComponent(index, Player.getComponentType());

Key Methods

Inventory[^1]

Inventory inventory = player.getInventory();

// Add items (use getCombinedHotbarFirst() for hotbar priority)
ItemContainer container = inventory.getCombinedHotbarFirst();
container.addItemStack(new ItemStack("Tool_Sword_Wood", 1));
container.addItemStack(new ItemStack("Consumable_Apple", 10));

// Or add directly to hotbar/storage
inventory.getHotbar().addItemStack(new ItemStack("Block_Torch", 16));
inventory.getStorage().addItemStack(new ItemStack("Resource_Stone", 64));

// Get specific slots
ItemStack inHand = inventory.getItemInHand();
byte activeSlot = inventory.getActiveHotbarSlot();

// Check for broken items
boolean hasBroken = inventory.containsBrokenItem();

// Clear inventory
inventory.clear();

// Drop all items
List<ItemStack> dropped = inventory.dropAllItemStacks();

Messaging

// Send a message to the player
player.sendMessage(Message.raw("Hello!"));
player.sendMessage(Message.translation("server.general.welcome"));

// With color
player.sendMessage(Message.raw("Error!").color("#ff5555"));

Game Mode

GameMode mode = player.getGameMode();

if (mode == GameMode.Creative) {
    // Player is in creative mode
}

if (mode == GameMode.Survival) {
    // Player is in survival mode
}

Spawn Info

// Check if first time in this world
if (player.isFirstSpawn()) {
    // Give starter items
}

// Get spawn time
long spawnTime = player.getLastSpawnTimeNanos();

// Check spawn protection
if (player.hasSpawnProtection()) {
    // Player is protected
}

Player Data

// Get player config data
PlayerConfigData configData = player.getPlayerConfigData();

// Get per-world data
PlayerWorldData worldData = configData.getPerWorldData(world.getName());

Related Components

To get full player information, you often need multiple components:

// Player data
Player player = (Player) commandBuffer.getComponent(ref, Player.getComponentType());

// Position and rotation
TransformComponent transform = (TransformComponent)
    commandBuffer.getComponent(ref, TransformComponent.getComponentType());

// Network/connection info
PlayerRef playerRef = (PlayerRef)
    commandBuffer.getComponent(ref, PlayerRef.getComponentType());
String username = playerRef.getUsername();

// Display name
Nameplate nameplate = (Nameplate)
    commandBuffer.getComponent(ref, Nameplate.getComponentType());

// Stats (health, stamina, etc.)
EntityStatMap stats = (EntityStatMap)
    commandBuffer.getComponent(ref, EntityStatMap.getComponentType());

Example: Full Player Handler

public class PlayerInfoHandler extends RefSystem {

    @Nonnull
    @Override
    public Query getQuery() {
        return Query.and(
            Player.getComponentType(),
            PlayerRef.getComponentType(),
            TransformComponent.getComponentType()
        );
    }

    @Override
    public void onEntityAdded(@Nonnull Ref<EntityStore> ref, @Nonnull AddReason reason,
                               @Nonnull Store store, @Nonnull CommandBuffer commandBuffer) {

        Player player = (Player) commandBuffer.getComponent(ref, Player.getComponentType());
        PlayerRef playerRef = (PlayerRef) commandBuffer.getComponent(ref, PlayerRef.getComponentType());
        TransformComponent transform = (TransformComponent)
            commandBuffer.getComponent(ref, TransformComponent.getComponentType());

        String username = playerRef.getUsername();
        Vector3d position = transform.getPosition();
        GameMode mode = player.getGameMode();

        System.out.println(username + " joined at " + position + " in " + mode + " mode");

        if (player.isFirstSpawn()) {
            player.getInventory().getCombinedHotbarFirst().addItemStack(
                new ItemStack("Tool_Sword_Wood", 1));
            player.sendMessage(Message.raw("Welcome, " + username + "!"));
        }
    }

    @Override
    public void onEntityRemove(@Nonnull Ref<EntityStore> ref, @Nonnull RemoveReason reason,
                                @Nonnull Store store, @Nonnull CommandBuffer commandBuffer) {}
}

See Also

• Components Concept - How components work
• TransformComponent - Position and rotation
• Player Join Event - Handle player joins

[^1]: See Inventory API for access methods and ItemContainer API for addItemStack(), clear(), etc.