MCEngine Artificial Intelligence API Usage

registerModel(Plugin plugin, String platform, String model)

/** * Registers a model under a given platform if not already loaded. */

API Code

public void registerModel(Plugin plugin, String platform, String model) {
    MCEngineArtificialIntelligenceApiUtilAi.registerModel(plugin, platform, model);
}

Usage

MCEngineArtificialIntelligenceApi api = new MCEngineArtificialIntelligenceApi();
api.registerModel(plugin, "openai", "gpt-4o");

Summary

Registers a model so that it can be used to process prompts.

getResponse(String platform, String model, String message)

/** Sends message using registered model and returns response */

API Code

public String getResponse(String platform, String model, String message) {
    return getAi(platform, model).getResponse(message);
}

Usage

MCEngineArtificialIntelligenceApi api = new MCEngineArtificialIntelligenceApi();
String reply = api.getResponse("openai", "gpt-3.5-turbo", "Hello, AI!");

Summary

Gets a direct AI response using server-registered token.

getResponse(String platform, String model, String token, String message)

/** Sends message using provided token and returns response */

API Code

public String getResponse(String platform, String model, String token, String message) {
    return getAi(platform, model).getResponse(token, message);
}

Usage

MCEngineArtificialIntelligenceApi api = new MCEngineArtificialIntelligenceApi();
String reply = api.getResponse("openrouter", "custom-model", "my-token", "How's the weather?");

Summary

Gets AI response using provided player token.

getAi(String platform, String model)

/** Retrieves a registered model by platform and name */

API Code

public IMCEngineArtificialIntelligenceApiModel getAi(String platform, String model) {
    return MCEngineArtificialIntelligenceApiUtilAi.getAi(platform, model);
}

Usage

IMCEngineArtificialIntelligenceApiModel model = new MCEngineArtificialIntelligenceApi().getAi("openai", "gpt-4");

Summary

Returns the model instance or null if not found.

getAiAll()

/** Returns all registered models */

API Code

public Map<String, Map<String, IMCEngineArtificialIntelligenceApiModel>> getAiAll() {
    return (Map<String, Map<String, IMCEngineArtificialIntelligenceApiModel>>) (Map<?, ?>)
        MCEngineArtificialIntelligenceApiUtilAi.getAllModels();
}

Usage

MCEngineArtificialIntelligenceApi api = new MCEngineArtificialIntelligenceApi();
Map<String, Map<String, IMCEngineArtificialIntelligenceApiModel>> allModels = api.getAiAll();

Summary

Retrieves all models by platform and model name.

runBotTask(...)

/** Runs an async bot task for the player */

API Code

public void runBotTask(Plugin plugin, IMCEngineArtificialIntelligenceDB db, Player player, String tokenType, String platform, String model, String message) {
    new MCEngineArtificialIntelligenceApiUtilBotTask(plugin, this, db, tokenType, player, platform, model, message)
        .runTaskAsynchronously(plugin);
}

Usage

MCEngineArtificialIntelligenceApi api = new MCEngineArtificialIntelligenceApi();
api.runBotTask(plugin, db, player, "player", "openai", "gpt-4", "Tell me a joke");

Summary

Triggers a bot task using the player’s or server’s token depending on type.

setWaiting(Player player, boolean waiting)

/** Sets whether player is waiting for AI response */

API Code

public void setWaiting(Player player, boolean waiting) {
    MCEngineArtificialIntelligenceApiUtilBotManager.setWaiting(player, waiting);
}

Usage

api.setWaiting(player, true);

Summary

Tracks whether a player is waiting for AI response.

checkWaitingPlayer(Player player)

/** Checks if a player is in waiting state */

API Code

public boolean checkWaitingPlayer(Player player) {
    return MCEngineArtificialIntelligenceApiUtilBotManager.isWaiting(player);
}

Usage

boolean waiting = api.checkWaitingPlayer(player);

Summary

Checks if player is waiting for a previous response.