mirror of
https://github.com/clusterio/clusterio.git
synced 2026-11-11 23:04:52 +09:00
7122cbccf8
Replace invokeHook and the per plugin on* methods with AsyncHook collections on the controller, host, instance, clusterioctl and web control objects. Plugin entrypoints export a default function that receives a load context and attaches handlers to the hooks it needs. Class exports still load through fromContext with a deprecation warning. The create templates and docs use the entrypoint function. This is clusterio/clusterio#921 recreated on top of master after the ESM migration and the PluginDeclaration permissions change. Closes #730 Co-Authored-By: Cooldude2606 <25043174+Cooldude2606@users.noreply.github.com> Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
67 lines
2.2 KiB
JavaScript
67 lines
2.2 KiB
JavaScript
import * as lib from "@clusterio/lib";
|
|
//%if multi_context // Messages requires multi context
|
|
|
|
import {
|
|
PluginExampleEvent, PluginExampleRequest,
|
|
//%endif
|
|
//%if controller & web // Subscribing requires web content and the controller
|
|
ExampleSubscribableUpdate, ExampleSubscribableValue,
|
|
//%endif
|
|
//%if multi_context // Messages requires multi context
|
|
} from "./messages.js";
|
|
//%endif
|
|
|
|
export default async function loadControllerPlugin(context) {
|
|
const { controller, logger, plugin } = context;
|
|
//%if controller & web // Subscribing requires web content and the controller
|
|
// If needed, replace with loading from database file such as lib.Datastore
|
|
const exampleDatabase = new Map([["foo", new ExampleSubscribableValue("foo", 0, false)]]);
|
|
//%endif
|
|
//%if multi_context // Messages requires multi context
|
|
|
|
controller.handle(PluginExampleEvent, async (event) => {
|
|
logger.info(JSON.stringify(event));
|
|
});
|
|
|
|
controller.handle(PluginExampleRequest, async (request) => {
|
|
logger.info(JSON.stringify(request));
|
|
return {
|
|
myResponseString: request.myString,
|
|
myResponseNumbers: request.myNumberArray,
|
|
};
|
|
});
|
|
//%endif
|
|
//%if controller & web // Subscribing requires web content and the controller
|
|
|
|
controller.subscriptions.handle(ExampleSubscribableUpdate, async (request) => {
|
|
logger.info(JSON.stringify(request));
|
|
const values = [...exampleDatabase.values()].filter(
|
|
value => value.updatedAtMs > request.lastRequestTimeMs,
|
|
);
|
|
return values.length ? new ExampleSubscribableUpdate(values) : null;
|
|
});
|
|
//%endif
|
|
|
|
controller.hooks.controllerConfigFieldChanged.attach(plugin.name, async (field, curr, prev) => {
|
|
logger.info(`controller::controllerConfigFieldChanged ${field}`);
|
|
});
|
|
//%if instance
|
|
|
|
controller.hooks.instanceConfigFieldChanged.attach(plugin.name, async (instance, field, curr, prev) => {
|
|
logger.info(`controller::instanceConfigFieldChanged ${instance.id} ${field}`);
|
|
});
|
|
//%endif
|
|
|
|
controller.hooks.save.attach(plugin.name, async () => {
|
|
logger.info("controller::save");
|
|
});
|
|
|
|
controller.hooks.shutdown.attach(plugin.name, async () => {
|
|
logger.info("controller::shutdown");
|
|
});
|
|
|
|
controller.hooks.playerEvent.attach(plugin.name, async (instance, event) => {
|
|
logger.info(`controller::playerEvent ${instance.id} ${JSON.stringify(event)}`);
|
|
});
|
|
}
|