Code Patterns

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

All 225 Command 60 Damage 2 Ecs 27 Entity 5 Gui 75 Interaction 2 Inventory 4 Moderation 3 Permission 2 Player 9 Plugin 4 Storage 2 Teleport 3 Ui 22 Util 5
← Back to Patterns
player

Kick Player

Disconnect a player from the server.

Example Code

java 
public void kickPlayer(Store<EntityStore> store, UUID playerUuid, String reason) {
    var playerRef = Universe.get().getPlayer(playerUuid);
    var ref = playerRef.getReference();

    // Get PlayerRef component for packet handler
    var playerRefComponent = store.getComponent(ref, PlayerRef.getComponentType());

    // Disconnect with reason
    playerRefComponent.getPacketHandler().disconnect(reason);
}

// Or simpler if you have PlayerRef:
playerRef.getPacketHandler().disconnect("You were kicked!");

Common Mistakes

Not providing a reason to the player.