Package net.crux.ac.api

Interface CruxAPI

public interface CruxAPI
Main public entry point for the Crux AntiCheat Developer API.

  • Method Summary

    Modifier and Type
    Method
    Description
    static CruxAPI
    get()
    Static accessor for CruxAPI instance.
    CruxExemptionAPI
    getExemptions()
    Gets the Exemption API manager.
    CruxPlayer
    getPlayer(UUID uuid)
    Gets the CruxPlayer wrapper for the specified player UUID.
    default CruxPlayer
    getPlayer(org.bukkit.entity.Player player)
    Gets the CruxPlayer wrapper for a Bukkit Player.
    String
    getVersion()
    Returns the current API and plugin version string.
    boolean
    isCheckEnabled(String checkName, String variant)
    Checks if a specific check is currently enabled.
    void
    setCheckEnabled(String checkName, String variant, boolean enabled)
    Dynamically enables or disables a specific check.

  • Method Details

    • getPlayer

      CruxPlayer getPlayer(UUID uuid)
      Gets the CruxPlayer wrapper for the specified player UUID.
      Parameters:
      uuid - Player UUID
      Returns:
      CruxPlayer wrapper, or null if the player has no active session profile

    • getPlayer

      default CruxPlayer getPlayer(org.bukkit.entity.Player player)
      Gets the CruxPlayer wrapper for a Bukkit Player.
      Parameters:
      player - Bukkit Player
      Returns:
      CruxPlayer wrapper, or null if the player has no active profile

    • getExemptions

      CruxExemptionAPI getExemptions()
      Gets the Exemption API manager.

    • isCheckEnabled

      boolean isCheckEnabled(String checkName, String variant)
      Checks if a specific check is currently enabled.
      Parameters:
      checkName - Name of the check (e.g. "Flight", "Speed", "Step")
      variant - Variant identifier (e.g. "A", "B") or empty string

    • setCheckEnabled

      void setCheckEnabled(String checkName, String variant, boolean enabled)
      Dynamically enables or disables a specific check.

    • getVersion

      String getVersion()
      Returns the current API and plugin version string.

    • get

      static CruxAPI get()
      Static accessor for CruxAPI instance.