Checkbox for setting guest cap.

README.md

@@ -1,115 +1,7 @@
-# OpenRCT2 TypeScript Plugin Template
+# OpenRCT2 Soft Guest Cap Editor
 
-A simple and minimal template for OpenRCT2 plugins using TypeScript based on [Basssiiie's OpenRCT2-Simple-Typescript-Template](https://github.com/Basssiiie/OpenRCT2-Simple-Typescript-Template) with a few changes to file content and structure.
+A plugin for OpenRCT2 that allows you to edit the soft guest cap of your park. The soft guest cap is the maximum number of guests that will spawn naturally in your park.
 
-Also supports:
+## Thanks
 
-- Automatic plugin reload in OpenRCT2 (hot reload)
-- Out of the box minification to improve file sizes
-- Support for external NPM packages (like FlexUI)
-
-## How to start
-
-1. Install latest version of [Node](https://nodejs.org/en/) and make sure to include NPM and enable the "Add to PATH" option during installation.
-2. Use the green "Use this template" button in the top right corner of this page, or download the project to a location of your choice on your PC.
-3. Open a terminal or command prompt.
-4. Use `cd` to change your current directory to the root folder of this project.
-5. Run `npm ci` to install the project's dependencies.
-6. Find `openrct2.d.ts` TypeScript API declaration file in OpenRCT2 files. copy it to `./lib/` folder.
-   - This file can usually be found in the [OpenRCT2 installation directory](#openrct2-installation-directory).
-   - Alternatively you can download the file from Github [here](https://raw.githubusercontent.com/OpenRCT2/OpenRCT2/develop/distribution/openrct2.d.ts).
-   - Another option is to make a symbolic link instead of copying the file, which will keep the file up to date whenever you install new versions of OpenRCT2.
-7. In `./src/info.js`, change plugin info, such as name and author, to your liking.
-
----
-
-## Commands
-
-The template comes with several terminal commands to make developing plugins easier.
-
-`npm run build`
-
-Creates a release build of your plugin. This version is optimized for sharing with others, using Terser to make the file as small as possible. By default, the plugin will be outputted to `./dist/`.
-
-`npm run build:dev`
-
-Creates a develop build of your plugin. This version is not optimized for sharing, but easier to read in case you want to see the outputted Javascript. By default, the plugin will be outputted in the plugin folder of the default [OpenRCT2 user directory](#openrct2-user-directory).
-
-`npm start` or `npm run start`
-
-Will start a script that will automatically run `npm run build:dev` every time you make a change to any Typescript or Javascript file inside the `./src/` folder.
-
-### Output paths
-
-The output paths can be changed in `rollup.config.js`, specifically in the `getOutput()` method.
-
----
-
-## Access game logs
-
-When your plugin is not loading properly, it may be useful to be able to read the logs of the game to see if there are any errors. Furthermore, if you use the `console.log` function, the resulting logs can be read here as well.
-
-### Windows
-
-1. Navigate to the folder where [OpenRCT2 is installed](#openrct2-installation-directory).
-2. Launch the `openrct2.com` file located there (the MS-DOS application).
-   - If file extensions are hidden, make sure to [enable them](https://support.microsoft.com/en-us/windows/common-file-name-extensions-in-windows-da4a4430-8e76-89c5-59f7-1cdbbc75cb01).
-
-### MacOS
-
-1. Launch a terminal or another command-line prompt.
-2. Using the `cd` command, navigate to the folder where [OpenRCT2 is installed](#openrct2-installation-directory).
-3. Run `open OpenRCT2.app/Contents/MacOS/OpenRCT2` to launch OpenRCT2 with logging enabled.
-
-### Linux
-
-1. Launch a terminal or another command-line prompt.
-2. Using the `cd` command, navigate to the folder where [OpenRCT2 is installed](#openrct2-installation-directory).
-3. Run `./openrct2` to launch OpenRCT2 with logging enabled.
-
----
-
-## Hot reload
-
-This project supports the [OpenRCT2 hot reload feature](https://github.com/OpenRCT2/OpenRCT2/blob/master/distribution/scripting.md#writing-scripts) for development.
-
-1. Navigate to your [OpenRCT2 user directory](#openrct2-user-directory) and open the `config.ini` file.
-2. Enable hot reload by setting `enable_hot_reloading = true` in the file.
-3. Run `npm start` in the directory of this project to start the hot reload server.
-4. Start the OpenRCT2 and load a save or start a new game.
-5. Each time you save any of the files in `./src/`, the server will compile `./src/registerPlugin.ts` and place compiled plugin file inside your local OpenRCT2 plugin directory.
-6. OpenRCT2 will notice file changes and it will reload the plugin.
-
----
-
-## Folders
-
-### OpenRCT2 installation directory
-
-This is the directory where the game is installed.
-
-- **Windows:** usually `C:/Users/<USERNAME>/Documents/OpenRCT2/bin/` when using the launcher or `C:/Program Files/OpenRCT2/` when an installer was used.
-- **MacOS:** the folder where the `OpenRCT2.app` application file was placed.
-- **Linux:** depends on the distro, but likely either `/usr/share/openrct2` when installed through a package manager, or mounted in `/tmp` when using an AppImage.
-
-### OpenRCT2 user directory
-
-This is the directory where the game stores user data, like save games and plugins.
-
-- **Windows:** usually `Documents/OpenRCT2/` or `C:/Users/<USERNAME>/Documents/OpenRCT2/`.
-- **MacOS:** usually `/Users/<USERNAME>/Library/Application Support/OpenRCT2/`. Note that `Library` is a hidden folder in your user directory, so by default it will not show up in Finder.
-- **Linux:** usually `/home/<USERNAME>/.config`, `$HOME/.config`, or where the environment variable `$XDG_CONFIG_HOME` points to if it's set.
-
-You can also open this folder from inside OpenRCT2, by selecting "Open custom content folder" in the dropdown under the red toolbox in the main menu.
-
----
-
-## Dependencies
-
-The following libraries and tools are used in this template:
-
-- **NodeJS** is the JavaScript engine used to develop and run code when the game is not running.
-- **NPM** is a library and package manager for JavasScript and TypeScript and can be used to install new packages and update existing packages in the project.
-- **TypeScript** is a expansion language to JavaScript that adds type checking when you are writing the code. It allows you to specify rules for how objects and values look like, so TypeScript can report back if your code follows these rules (instead of crashes or errors in-game).
-- **Rollup** bundles all source code, runs it through some plugins like TypeScript, and then outputs a single JavaScript plugin file.
-- **Nodemon** is the program that can watch a folder for changes and then trigger a specified action. It is used by `npm start` to watch the `./src/` folder and triggers `npm run build:dev` if any changes occur.
+This plugin was built using Bassie's Flex UI library. You can find it [here](https://github.com/Basssiiie/OpenRCT2-FlexUI).

src/main.ts

@@ -1,56 +1,56 @@
-import {
-  button,
-  label,
-  textbox,
-  window,
-  store,
-  checkbox,
-  Bindable,
-  ElementVisibility,
-} from "openrct2-flexui";
+import { button, checkbox, label, textbox, window } from "openrct2-flexui";
 
-let suggestedGuestMaximum = store("");
-let setGuestCap: Bindable<ElementVisibility> = "hidden";
+let suggestedGuestMaximum: number = park.suggestedGuestMaximum;
+let activate: boolean = false;
+let event: any;
 
 export const allWidgets = window({
   title: "OpenRCT2 Soft Guest Cap Editor",
   width: { value: 200, min: 200, max: 10_000 },
-  height: { value: 90, min: 120, max: 10_000 },
+  height: { value: 100, min: 100, max: 10_000 },
   content: [
     label({
       alignment: "centred",
       text: "Enter your desired soft guest cap",
+      tooltip:
+        "This is the maximum number of guests that will be allowed in your park",
     }),
     textbox({
+      text: suggestedGuestMaximum.toString(),
       onChange: (text: string) => {
-        suggestedGuestMaximum.set(text);
+        suggestedGuestMaximum = Number(text);
       },
-      visibility: setGuestCap,
     }),
     checkbox({
-      text: "Set Guest Cap",
-      onChange: (checked) => {
-        setGuestCap = checked ? "visible" : "hidden";
+      text: "Active custom soft guest cap",
+      isChecked: activate,
+      onChange: function (checked) {
+        activate = checked;
+        if (checked) {
+          event = context.subscribe("park.calculateGuestCap", (e) => {
+            e.suggestedGuestMaximum = suggestedGuestMaximum;
+          });
+        } else if (event) {
+          event.unsubscribe();
+          event = null;
+        }
       },
     }),
     button({
       text: "Current Guest Cap",
       onClick: () => {
         park.postMessage(
-          `Your current soft guest cap is ${park.suggestedGuestMaximum}`,
+          `Your current soft guest cap is ${park.suggestedGuestMaximum}`
         );
       },
       height: "23px",
     }),
   ],
 });
 
-export function startup() {
+export function main() {
   if (typeof ui !== "undefined") {
     const menuItemName = "Soft Guest Cap Editor";
     ui.registerMenuItem(menuItemName, () => allWidgets.open());
-    context.subscribe("park.calculateGuestCap", (e) => {
-      e.suggestedGuestMaximum = Number(suggestedGuestMaximum.get());
-    });
   }
 }

src/plugin.ts

@@ -1,6 +1,6 @@
 // @ts-ignore
 import * as info from "./info.js";
-import { startup } from "./main";
+import { main } from "./main";
 
 registerPlugin({
   name: info.name,
@@ -9,5 +9,5 @@ registerPlugin({
   type: info.type,
   licence: info.license,
   targetApiVersion: info.targetApiVersion,
-  main: startup,
+  main: main,
 });