Fix save + add contour thresholds

Author: masked-rpgmaker

.eslintrc.js

@@ -8,6 +8,7 @@ module.exports = {
         "plugin:@typescript-eslint/recommended"
     ],
     rules: {
-        "brace-style": ["error", "1tbs", { "allowSingleLine": true }]
+        "brace-style": ["error", "1tbs", { "allowSingleLine": true }],
+        "@typescript-eslint/ban-ts-comment": "off"
     }
 };

plugin-metadata.yaml

@@ -147,6 +147,28 @@ params:
         text:
           default: Nearest
           pt: Mais próximo
+  - name: advanced
+    text:
+      default: Advanced
+      pt: Avançado
+    description:
+      default: Advanced parameters for the plugin
+      pt: Parâmetros avançados do plugin
+    children:
+      - name: saveRectCoverThresholds
+        text:
+          default: Save rect cover thresholds
+          pt: Limites da cobertura por retângulos no save
+        description:
+          default: |-
+            List of threshold values for contour detection on save. More values imply bigger save files, but with finer
+            detail. Zero is implicit.
+          pt: |-
+            Lista de valores limitantes para a detecção de contornos no save. Mais valores implicam em arquivos de save
+            maiores, mas com maior precisão. O zero é implícito.
+        type: array
+        items: number
+        default: ["0.25", "0.5", "0.75"]
 
 commands:
   - name: setPlayerVisionRange

src/core/fog-of-war/renderer.ts

@@ -19,12 +19,7 @@ export class FogOfWarRenderer extends PIXI.ObjectRenderer {
     }
 
     private _createShader(): PIXI.Shader {
-        const fragmentSrc = {
-            bicubic: bicubicFragmentSrc,
-            bilinear: bilinearFragmentSrc,
-            nearest: nearestFragmentSrc
-        }[pluginParams.fogFilter];
-
+        const fragmentSrc = this.getFragmentSrc(pluginParams.fogFilter);
         return PIXI.Shader.from(vertexSrc, fragmentSrc, {
             uProjectionMatrix: new PIXI.Matrix(),
             uTint: new Float32Array([0, 0, 0]),
@@ -34,6 +29,15 @@ export class FogOfWarRenderer extends PIXI.ObjectRenderer {
         });
     }
 
+    getFragmentSrc(name: string): string {
+        switch (name) {
+            case "bicubic": return bicubicFragmentSrc
+            case "bilinear": return bilinearFragmentSrc
+            case "nearest": return nearestFragmentSrc
+            default: throw `unknown shader ${name}`;
+        }
+    }
+
     get shader(): PIXI.Shader {
         return this._shader;
     }

src/game/fog-of-war.ts

@@ -18,16 +18,25 @@ export class Game_FogOfWar {
         this._invalidated = false;
     }
 
-    static from(width: number, height: number, rects: Rect[]): Game_FogOfWar {
+    static from(width: number, height: number, contourRects: Rect[][], contourValues: number[]): Game_FogOfWar {
         const fog = new Game_FogOfWar();
         fog.reset(width, height);
-        for (const [left, top, right, bottom] of rects) {
-            for (let j = top; j <= bottom; j++) {
-                for (let i = left; i <= right; i++) {
-                    fog._data[i + j * width] = Game_FogOfWar.FOW_MAX_DARKNESS;
+        fog._data.fill(Game_FogOfWar.FOW_MAX_DARKNESS);
+
+        const contours = contourValues
+            .map((value, i) => [value, contourRects[i]] as [number, Rect[]])
+            .sort(([a,], [b,]) => b - a);
+
+        for (const [value, rects] of contours) {
+            for (const [left, top, right, bottom] of rects) {
+                for (let j = top; j <= bottom; j++) {
+                    for (let i = left; i <= right; i++) {
+                        fog._data[i + j * width] = value * Game_FogOfWar.FOW_MAX_DARKNESS;
+                    }
                 }
             }
         }
+
         return fog;
     }
 

src/main.ts

@@ -1,4 +1,5 @@
 export * from "./game";
 export * from "./core";
+export * from "./utils";
 import "./patch";
 import "./commands";

src/parameters.ts

@@ -14,5 +14,8 @@ export default {
         blue: Number(tint.blue)
     },
     fogDispersionTime: Number(parameters['fogDispersionTime']),
-    fogFilter: parameters['fogFilter']
+    fogFilter: parameters['fogFilter'],
+    advanced: {
+        saveRectCoverThresholds: [0, ...JSON.parse(parameters['saveRectCoverThresholds']).map(Number)]
+    }
 };

src/patch/core/json-ex.ts

@@ -8,14 +8,16 @@
 import { Game_FogOfWar } from "game";
 import { RectCover } from "utils";
 
+import pluginParams from "parameters";
+
 declare class JsonEx {
     static _encode(value: unknown, depth: number): string
     static _decode(value: unknown): unknown
 }
 
 const _JsonEx_encode = JsonEx._encode;
 JsonEx._encode = function(value, depth): string {
-    if (typeof value === "object" && value != null) {
+    if (typeof value === "object" && !(value instanceof Array) && value != null) {
         const constructor = value.constructor;
         value = Object.assign({}, value);
         Object.setPrototypeOf(value, constructor.prototype);
@@ -24,9 +26,11 @@ JsonEx._encode = function(value, depth): string {
     if (value instanceof Game_FogOfWar) {
         const width = value.width;
         const height = value.height;
-        const cover = new RectCover(value);
-        const rects = cover.minimize();
-        return _JsonEx_encode.call(this, { '@': 'Game_FogOfWar', width, height, rects }, depth + 1);
+        const contours = pluginParams.advanced.saveRectCoverThresholds.map(threshold => {
+            const cover = new RectCover(value as Game_FogOfWar, threshold);
+            return cover.minimize();
+        });
+        return _JsonEx_encode.call(this, { '@': 'Game_FogOfWar', width, height, contours }, depth + 1);
     }
 
     return _JsonEx_encode.call(this, value, depth);
@@ -36,7 +40,11 @@ const _JsonEx_decode = JsonEx._decode;
 JsonEx._decode = function(value): unknown {
     if (typeof value === "object" && value != null) {
         if (value["@"] === 'Game_FogOfWar') {
-            return Game_FogOfWar.from(value['width'], value['height'], value['rects']);
+            return Game_FogOfWar.from(
+                value['width'],
+                value['height'],
+                value['contours'],
+                pluginParams.advanced.saveRectCoverThresholds);
         }
     }
     return _JsonEx_decode.call(this, value);

src/utils/rect-cover.ts

@@ -10,10 +10,12 @@ export type Grid = {
 type Strip = { x: number, top: number, bottom: number };
 
 export class RectCover {
-    private _grid: Grid
+    private readonly _grid: Grid
+    private readonly _threshold: number;
 
-    constructor(grid: Grid) {
+    constructor(grid: Grid, threshold: number) {
         this._grid = grid;
+        this._threshold = threshold;
     }
 
     private _slice(): Strip[] {
@@ -23,8 +25,7 @@ export class RectCover {
             for (let y = 0; y < this._grid.height; y++) {
                 const sy = y;
 
-                while (this._grid.at(x, y))
-                    y++;
+                while (this._grid.at(x, y) <= this._threshold) y++;
 
                 if (sy != y) {
                     strips.push({
@@ -43,21 +44,22 @@ export class RectCover {
         const strips = this._slice();
         const rectangles = new RectTrie();
         for (const { x: sx, top, bottom } of strips) {
-            const rect: Rect = [top, bottom, 0, 0];
+            const rect: Rect = [sx, top, sx, bottom];
 
             let x = sx;
             right: while (x < this._grid.width) {
-                for (let y = top; y <= bottom; y++)
-                    if (!this._grid.at(x, y)) break right;
-                
+                for (let y = top; y <= bottom; y++) {
+                    if (this._grid.at(x, y) > this._threshold) break right;
+                }
                 x++;
             }
             rect[2] = x - 1;
 
             x = sx;
             left: while (x >= 0) {
-                for (let y = top; y <= bottom; y++)
-                    if (!this._grid.at(x, y)) break left;
+                for (let y = top; y <= bottom; y++) {
+                    if (this._grid.at(x, y) > this._threshold) break left;
+                }
                 x--;
             }
             rect[0] = x + 1;

src/utils/rect-trie.ts

@@ -48,7 +48,8 @@ class RectTrieNode {
     }
 
     *[Symbol.iterator](): Iterator<[number, RectTrieNode]> {
-        for (const [value, child] of Object.entries(this._children))
+        for (const [value, child] of Object.entries(this._children)) {
             yield [Number(value), child];
+        }
     }
 }