@makefully/platypus 4.1.20 → 4.1.22

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@makefully/platypus",
-    "version": "4.1.20",
+    "version": "4.1.22",
     "description": "2D tile-based HTML5 game engine with a component-based entity model",
     "license": "MIT",
     "contributors": [

package/src/Game.js

@@ -1,6 +1,6 @@
 /* global document, platypus, window */
 import {Application} from 'springroll';
-import {CullerPlugin, Application as PixiApplication, Ticker, extensions} from 'pixi.js';
+import {CullerPlugin, Application as PixiApplication, Rectangle, Ticker, extensions} from 'pixi.js';
 import {arrayCache, greenSlice, greenSplice, union} from './utils/array.js';
 import Data from './Data.js';
 import Entity from './Entity.js';
@@ -224,6 +224,9 @@ class Game extends Messenger {
                                 this.ticker.remove(this.tickInstance);
                                 this.paused = true;
                                 sound.pauseAll();
+                                // Release held keys so pause does not leave sticky input,
+                                // and so HandlerController can pass keyboard through to HTML.
+                                this.triggerOnChildren('blur-control');
                             }
                         } else {
                             if (this.paused) {
@@ -820,6 +823,82 @@ class Game extends Messenger {
         }
         return entities;
     }
+
+    /**
+     * Captures a screenshot of the currently visible game viewport (the canvas /
+     * camera view), not the full stage or world bounds.
+     *
+     * Prefer this over `renderer.extract.*(stage)` without a frame — extracting
+     * the bare stage uses content bounds and can include off-screen world area.
+     *
+     * @param {Object} [options]
+     * @param {string} [options.format='png'] Image format for data URLs (`png`, `jpg`/`jpeg`, `webp`).
+     * @param {number} [options.quality] Encoder quality for lossy formats (0–1).
+     * @param {boolean} [options.render=true] Render the stage before capturing.
+     * @param {string} [options.as='dataURL'] Return type: `dataURL` or `canvas`.
+     * @return {Promise<string|HTMLCanvasElement|null>} Screenshot, or null if unavailable.
+     **/
+    async captureViewport (options = {}) {
+        const
+            {
+                format = 'png',
+                quality,
+                render = true,
+                as = 'dataURL'
+            } = options,
+            {renderer, stage} = this;
+
+        if (!renderer || !stage) {
+            return null;
+        }
+
+        if (render) {
+            renderer.render(stage);
+        }
+
+        const
+            {resolution, screen} = renderer,
+            frame = new Rectangle(0, 0, screen.width, screen.height),
+            extractOptions = {
+                target: stage,
+                frame,
+                resolution
+            };
+
+        try {
+            if (as === 'canvas') {
+                return renderer.extract.canvas(extractOptions);
+            }
+
+            return await renderer.extract.base64({
+                ...extractOptions,
+                format,
+                quality
+            });
+        } catch (err) {
+            platypus.debug.warn('Game.captureViewport failed.', err);
+
+            // Fallback: canvas buffer after the render above (viewport-sized).
+            try {
+                if (as === 'canvas') {
+                    return this.canvas;
+                }
+
+                const mime = format === 'jpg' || format === 'jpeg'
+                    ? 'image/jpeg'
+                    : format === 'webp'
+                        ? 'image/webp'
+                        : 'image/png';
+
+                return typeof quality === 'number'
+                    ? this.canvas.toDataURL(mime, quality)
+                    : this.canvas.toDataURL(mime);
+            } catch (fallbackErr) {
+                platypus.debug.warn('Game.captureViewport canvas fallback failed.', fallbackErr);
+                return null;
+            }
+        }
+    }
     
     /**
     * This method destroys the game.

package/src/components/HandlerController.js

@@ -4,6 +4,43 @@ import Gamepad from '../Gamepad.js';
 import createComponentClass from '../factory.js';
 
 const
+    /**
+     * Whether the event target is (or is inside) an editable field. Used so
+     * capture-phase game key handlers do not call preventDefault / emit game
+     * input while the user types in HTML overlays (forms, Notefully, etc.).
+     *
+     * @param {Event} event
+     * @return {Boolean}
+     */
+    isEditableKeyboardTarget = function (event) {
+        const target = event?.target;
+
+        if (!target || typeof target.closest !== 'function') {
+            return false;
+        }
+
+        if (target.isContentEditable) {
+            return true;
+        }
+
+        const tag = target.tagName;
+
+        if (tag === 'INPUT' || tag === 'TEXTAREA' || tag === 'SELECT') {
+            return true;
+        }
+
+        return !!target.closest('input, textarea, select, [contenteditable=""], [contenteditable="true"]');
+    },
+    /**
+     * When the game is paused or focus is in an editable field, let the browser
+     * handle keys (no game events, no preventDefault).
+     *
+     * @param {Event} event
+     * @return {Boolean}
+     */
+    shouldPassThroughKeyboard = function (event) {
+        return !!(platypus.game?.paused || isEditableKeyboardTarget(event));
+    },
     broadcastHandleController = function (tick) {
         if (hasGamepads) {
             const
@@ -170,25 +207,33 @@ export default createComponentClass(/** @lends platypus.components.HandlerContro
      */
     initialize: function () {
         const
-            {enableDefaultEvents} = this;
+            {enableDefaultEvents} = this,
+            wrapKeyboard = (handler) => (event) => {
+                if (shouldPassThroughKeyboard(event)) {
+                    return;
+                }
+
+                handler(event);
+            };
 
         this.upsToBlur = [];
 
         if (platypus.game.settings.debug || enableDefaultEvents === 'all') { // If this is a test build, leave in the browser key combinations so debug tools can be opened as expected.
-            this.callbackKeyDown = onDown.bind(this, 'keyboard');
-            this.callbackKeyUp = onUp.bind(this, 'keyboard');
+            this.callbackKeyDown = wrapKeyboard(onDown.bind(this, 'keyboard'));
+            this.callbackKeyUp = wrapKeyboard(onUp.bind(this, 'keyboard'));
         } else { // Otherwise remove default browser behavior for key inputs so that they do not interfere with game-play.
             const
                 preventDefault = Array.isArray(enableDefaultEvents) ? (event) => enableDefaultEvents.indexOf(event.code) === -1 ? event.preventDefault() : null : (event) => event.preventDefault();
 
-            this.callbackKeyDown = (event) => {
+            this.callbackKeyDown = wrapKeyboard((event) => {
                 onDown.call(this, 'keyboard', event);
-                preventDefault(event); // default 'none' may be too aggressive - if problems arise, we may need to limit this to certain key combos that get in the way of game-play. Example: (event.metaKey && event.keyCode == 37) causes an accidental cmd key press to send the browser back a page while playing and hitting the left arrow button.
-            };
-            this.callbackKeyUp = (event) => {
+                // Still aggressive for gameplay keys, but not while paused or typing in HTML.
+                preventDefault(event);
+            });
+            this.callbackKeyUp = wrapKeyboard((event) => {
                 onUp.call(this, 'keyboard', event);
                 preventDefault(event);
-            };
+            });
         }
 
         window.addEventListener('keydown', this.callbackKeyDown, true);
@@ -256,8 +301,8 @@ export default createComponentClass(/** @lends platypus.components.HandlerContro
     },
     methods: {
         destroy: function () {
-            window.removeEventListener('keydown', this.callbackKeyDown);
-            window.removeEventListener('keyup',   this.callbackKeyUp);
+            window.removeEventListener('keydown', this.callbackKeyDown, true);
+            window.removeEventListener('keyup',   this.callbackKeyUp,   true);
             for (let i = 0; i < this.gamepads.length; i++) {
                 if (this.gamepads[i]) {
                     this.gamepads[i].recycle();