feat(ui): Filter all KG log entries

kitten-science · Dec 22, 2023 · bd33d7e · bd33d7e
1 parent 458d0f3
commit bd33d7e
Show file tree

Hide file tree

Showing 7 changed files with 58 additions and 1 deletion.
diff --git a/packages/documentation/docs/sections/log-filters.md b/packages/documentation/docs/sections/log-filters.md
@@ -2,6 +2,10 @@
 
 You can control which events will be logged to the game log. Disable any option if the log message in that category get too excessive.
 
+## All KG log entries
+
+This will just uncheck all the log filters in KG itself, so that logging behavior remains consistent throughout resets.
+
 ## Adoring
 
 -   The galaxy has been adored on the [Religion](./religion.md) tab.

diff --git a/packages/kitten-scientists/source/Engine.ts b/packages/kitten-scientists/source/Engine.ts
@@ -302,6 +302,10 @@ export class Engine {
   private async _iterate(): Promise<void> {
     const context = { tick: new Date().getTime() };
 
+    if (this.settings.filters.disableKGLog.enabled) {
+      this._maintainKGLogFilters();
+    }
+
     // The order in which these actions are performed is probably
     // semi-intentional and should be preserved or improved.
     await this.scienceManager.tick(context);
@@ -315,6 +319,20 @@ export class Engine {
     await this.timeControlManager.tick(context);
   }
 
+  /**
+   * Ensures all log filters in KG are unchecked. This means the events will not be logged.
+   */
+  private _maintainKGLogFilters(): void {
+    for (const filter of Object.values(this._host.game.console.filters)) {
+      filter.enabled = false;
+    }
+
+    const filterCheckboxes = window.document.querySelectorAll("[id^=filter-]");
+    for (const checkbox of filterCheckboxes) {
+      (checkbox as HTMLInputElement).checked = false;
+    }
+  }
+
   /**
    * Retrieve an internationalized string literal.
    *

diff --git a/packages/kitten-scientists/source/settings/LogFilterSettings.ts b/packages/kitten-scientists/source/settings/LogFilterSettings.ts
@@ -76,6 +76,7 @@ export type LogFilterSettingsItems = {
 
 export class LogFilterSettings extends Setting {
   filters: LogFilterSettingsItems;
+  disableKGLog: Setting;
 
   constructor(
     enabled = false,
@@ -98,9 +99,11 @@ export class LogFilterSettings extends Setting {
       promote: new LogFilterSettingsItem(LogFilterItemVariant.Promote),
       misc: new LogFilterSettingsItem(LogFilterItemVariant.Misc),
     },
+    disableKGLog = new Setting(false),
   ) {
     super(enabled);
     this.filters = filters;
+    this.disableKGLog = disableKGLog;
   }
 
   load(settings: Maybe<Partial<LogFilterSettings>>) {
@@ -113,5 +116,6 @@ export class LogFilterSettings extends Setting {
     consumeEntriesPedantic(this.filters, settings.filters, (filter, item) => {
       filter.enabled = item?.enabled ?? filter.enabled;
     });
+    this.disableKGLog.enabled = settings.disableKGLog?.enabled ?? this.disableKGLog.enabled;
   }
 }
diff --git a/packages/kitten-scientists/source/types/game.ts b/packages/kitten-scientists/source/types/game.ts
@@ -82,6 +82,7 @@ export type Game = {
   };
   compressLZData: (data: string) => string;
   console: {
+    filters: Record<string, { enabled: boolean; title: string; unlocked: boolean }>;
     maxMessages: number;
   };
   craft: (name: string, amount: number) => void;

diff --git a/packages/kitten-scientists/source/ui/LogFilterSettingsUi.ts b/packages/kitten-scientists/source/ui/LogFilterSettingsUi.ts
@@ -12,6 +12,14 @@ export class LogFiltersSettingsUi extends SettingsSectionUi<LogFilterSettings> {
     const label = host.engine.i18n("ui.filter");
     super(host, label, settings);
 
+    this.addChild(
+      new SettingsList(host, {
+        children: [new SettingListItem(host, "All KG log entries.", settings.disableKGLog)],
+        hasDisableAll: false,
+        hasEnableAll: false,
+      }),
+    );
+
     const buttonTemplates = [
       {
         name: "buildFilter" as const,

diff --git a/schemas/working-draft/baseline/engine-state.schema.json b/schemas/working-draft/baseline/engine-state.schema.json
@@ -399,9 +399,20 @@
                 "misc"
               ],
               "type": "object"
+            },
+            "disableKGLog": {
+              "additionalProperties": false,
+              "description": "Filter all of KG's own messages.",
+              "properties": {
+                "enabled": {
+                  "description": "Should all of KG's internal messages be filtered from the log?",
+                  "type": "boolean"
+                }
+              },
+              "required": ["enabled"]
             }
           },
-          "required": ["enabled", "filters"],
+          "required": ["enabled", "filters", "disableKGLog"],
           "type": "object"
         },
         "resources": {

diff --git a/schemas/working-draft/settings-profile.schema.json b/schemas/working-draft/settings-profile.schema.json
@@ -389,6 +389,17 @@
               },
               "minProperties": 1,
               "type": "object"
+            },
+            "disableKGLog": {
+              "additionalProperties": false,
+              "description": "Filter all of KG's own messages.",
+              "properties": {
+                "enabled": {
+                  "description": "Should all of KG's internal messages be filtered from the log?",
+                  "type": "boolean"
+                }
+              },
+              "required": ["enabled"]
             }
           },
           "minProperties": 1,