From 379d2575a035acc93529e92af8796ec6029391bb Mon Sep 17 00:00:00 2001 From: Cooldude2606 <25043174+Cooldude2606@users.noreply.github.com> Date: Thu, 7 Aug 2025 17:42:52 +0100 Subject: [PATCH] Improve comments --- packages/create/templates/plugin-js/controller.js | 4 ++-- packages/create/templates/plugin-js/instance.js | 2 +- packages/create/templates/plugin-js/web/plugin.jsx | 4 ++-- packages/create/templates/plugin-ts/controller.ts | 6 +++--- packages/create/templates/plugin-ts/instance.ts | 2 +- packages/create/templates/plugin-ts/web/plugin.tsx | 4 ++-- 6 files changed, 11 insertions(+), 11 deletions(-) diff --git a/packages/create/templates/plugin-js/controller.js b/packages/create/templates/plugin-js/controller.js index b578d248..b1611c6a 100644 --- a/packages/create/templates/plugin-js/controller.js +++ b/packages/create/templates/plugin-js/controller.js @@ -1,7 +1,7 @@ "use strict"; const lib = require("@clusterio/lib"); const { BaseControllerPlugin } = require("@clusterio/controller"); -//%if multi_context // Subscribing requires multi context +//%if multi_context // Messages requires multi context const { PluginExampleEvent, PluginExampleRequest, @@ -9,7 +9,7 @@ const { //%if controller & web // Subscribing requires web content and the controller ExampleSubscribableUpdate, ExampleSubscribableValue, //%endif -//%if multi_context // Subscribing requires multi context +//%if multi_context // Messages requires multi context } = require("./messages"); //%endif diff --git a/packages/create/templates/plugin-js/instance.js b/packages/create/templates/plugin-js/instance.js index 6993aa1d..284222a2 100644 --- a/packages/create/templates/plugin-js/instance.js +++ b/packages/create/templates/plugin-js/instance.js @@ -35,7 +35,7 @@ class InstancePlugin extends BaseInstancePlugin { this.logger.info(`onPlayerEvent::onPlayerEvent ${JSON.stringify(event)}`); //%if module if (this.instance.status === "running") { - this.sendRcon("/sc __plugin_name__.foo()"); + await this.sendRcon("/sc __plugin_name__.foo()"); } //%endif } diff --git a/packages/create/templates/plugin-js/web/plugin.jsx b/packages/create/templates/plugin-js/web/plugin.jsx index 8dc03690..92b78ae3 100644 --- a/packages/create/templates/plugin-js/web/plugin.jsx +++ b/packages/create/templates/plugin-js/web/plugin.jsx @@ -12,7 +12,7 @@ import React, { import { BaseWebPlugin, PageLayout, PageHeader, Control, ControlContext, notifyErrorHandler, } from "@clusterio/web_ui"; -//%if multi_context // Subscribing requires multi context +//%if multi_context // Messages requires multi context import { PluginExampleEvent, PluginExampleRequest, @@ -20,7 +20,7 @@ import { //%if controller // Subscribing requires web content and the controller ExampleSubscribableUpdate, ExampleSubscribableValue, //%endif -//%if multi_context // Subscribing requires multi context +//%if multi_context // Messages requires multi context } from "../messages"; //%endif diff --git a/packages/create/templates/plugin-ts/controller.ts b/packages/create/templates/plugin-ts/controller.ts index cca31956..49fed9b4 100644 --- a/packages/create/templates/plugin-ts/controller.ts +++ b/packages/create/templates/plugin-ts/controller.ts @@ -1,6 +1,6 @@ import * as lib from "@clusterio/lib"; import { BaseControllerPlugin, InstanceInfo } from "@clusterio/controller"; -//%if multi_context // Subscribing requires multi context +//%if multi_context // Messages requires multi context import { PluginExampleEvent, PluginExampleRequest, @@ -8,7 +8,7 @@ import { //%if controller & web // Subscribing requires web content and the controller ExampleSubscribableUpdate, ExampleSubscribableValue, //%endif -//%if multi_context // Subscribing requires multi context +//%if multi_context // Messages requires multi context } from "./messages"; //%endif @@ -25,7 +25,7 @@ export class ControllerPlugin extends BaseControllerPlugin { //%endif //%if controller & web // Subscribing requires web content and the controller this.controller.subscriptions.handle(ExampleSubscribableUpdate, this.handleExampleSubscription.bind(this)); - this.exampleDatabase = new Map(); // If needed, replace with loading from database file + this.exampleDatabase = new Map(); // If needed, replace with loading from database file such as lib.Datastore //%endif //%if multi_context // Subscribing requires multi context } diff --git a/packages/create/templates/plugin-ts/instance.ts b/packages/create/templates/plugin-ts/instance.ts index 21af1189..fae91ce8 100644 --- a/packages/create/templates/plugin-ts/instance.ts +++ b/packages/create/templates/plugin-ts/instance.ts @@ -42,7 +42,7 @@ export class InstancePlugin extends BaseInstancePlugin { this.logger.info(`onPlayerEvent::onPlayerEvent ${JSON.stringify(event)}`); //%if module if (this.instance.status === "running") { - this.sendRcon("/sc __plugin_name__.foo()"); + await this.sendRcon("/sc __plugin_name__.foo()"); } //%endif } diff --git a/packages/create/templates/plugin-ts/web/plugin.tsx b/packages/create/templates/plugin-ts/web/plugin.tsx index c8b830fe..9d516f05 100644 --- a/packages/create/templates/plugin-ts/web/plugin.tsx +++ b/packages/create/templates/plugin-ts/web/plugin.tsx @@ -12,7 +12,7 @@ import React, { import { BaseWebPlugin, PageLayout, PageHeader, Control, ControlContext, notifyErrorHandler, } from "@clusterio/web_ui"; -//%if multi_context // Subscribing requires multi context +//%if multi_context // Messages requires multi context import { PluginExampleEvent, PluginExampleRequest, @@ -20,7 +20,7 @@ import { //%if controller & web // Subscribing requires web content and the controller ExampleSubscribableUpdate, ExampleSubscribableValue, //%endif -//%if multi_context // Subscribing requires multi context +//%if multi_context // Messages requires multi context } from "../messages"; //%endif