Package me.kzlyth.api.kick


package me.kzlyth.api.kick
API package for kicking players in Zenith-Mod.

This package contains the KickAPI class, which provides methods to kick players from the server. All kicks are automatically recorded in the history database with a case ID.

Database Compatibility: All methods in this API are fully compatible with H2, SQLite, MySQL, and MariaDB databases. The API automatically adapts to the configured database type from the configuration file.

Important Notes:

  • Players must be online to be kicked
  • Players with the zenith.kick.bypass permission cannot be kicked
  • All kicks are recorded in the history database (zn_history)
  • Each kick receives a unique case ID

Example usage:


 ZenithAPI api = ZenithAPI.getInstance();
 if (api != null) {
     KickAPI kickAPI = api.getKickAPI();
     
     UUID playerUuid = UUID.fromString("123e4567-e89b-12d3-a456-426614174000");
     kickAPI.kick(playerUuid, "Inappropriate behavior").thenAccept(caseId -> {
         getLogger().info("Player kicked. Case ID: " + caseId);
     });
 }
 
Seit:
1.2.3
Autor:
Zenith-Studios
  • Klassen
    Klasse
    Beschreibung
    API for kicking players in Zenith-Mod.