ZentrixAddon

Base class for addon plugins. Handles API availability checks, version compatibility, and addon registration automatically.

Usage

public final class MyAddon extends ZentrixAddon {
    @Override
    protected void onAddonEnable() {
        // Access the API
        ZentrixAPI api = ZentrixAPI.get();
        
        // Use services
        api.getGameService().getActiveGames();
    }

    @Override
    protected void onAddonDisable() {
        // Cleanup code
    }
    
    @Override
    protected String getRequiredAPIVersion() {
        return "1.0.0"; // Minimum API version required
    }
}

API Access

Use ZentrixAPI.get() to access the API from anywhere in your addon:

Methods

Method
Description

onAddonEnable()

Override to add initialization logic

onAddonDisable()

Override to add cleanup logic

getAddonId()

Returns addon identifier (defaults to plugin name)

getRequiredAPIVersion()

Override to specify minimum API version

isZentrixEnabled()

Returns true if addon is registered with Zentrix

Last updated