@needle-tools/engine 3.2.13-alpha → 3.2.15-alpha

package/lib/engine-components/utils/OpenURL.d.ts

@@ -0,0 +1,21 @@
+import { IPointerClickHandler, PointerEventData } from "../ui";
+import { Behaviour } from "../Component";
+export declare enum OpenURLMode {
+    NewTab = 0,
+    SameTab = 1,
+    NewWindow = 2
+}
+export declare class OpenURL extends Behaviour implements IPointerClickHandler {
+    clickable: boolean;
+    url?: string;
+    mode: OpenURLMode;
+    open(): Promise<void>;
+    start(): void;
+    onEnable(): void;
+    onDisable(): void;
+    onPointerEnter(args: any): void;
+    onPointerExit(): void;
+    onPointerClick(args: PointerEventData): void;
+    private _safariNewTabWorkaround;
+    private _validateUrl;
+}

package/lib/engine-components/utils/OpenURL.js

@@ -0,0 +1,125 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+import { Behaviour } from "../Component";
+import { serializable } from "../../engine/engine_serialization";
+import { isDevEnvironment, showBalloonMessage } from "../../engine/debug";
+import { isSafari } from "../../engine/engine_utils";
+import { ObjectRaycaster, Raycaster } from "../ui/Raycaster";
+import { tryGetUIComponent } from "../ui/Utils";
+export var OpenURLMode;
+(function (OpenURLMode) {
+    OpenURLMode[OpenURLMode["NewTab"] = 0] = "NewTab";
+    OpenURLMode[OpenURLMode["SameTab"] = 1] = "SameTab";
+    OpenURLMode[OpenURLMode["NewWindow"] = 2] = "NewWindow";
+})(OpenURLMode || (OpenURLMode = {}));
+export class OpenURL extends Behaviour {
+    clickable = true;
+    url;
+    mode = OpenURLMode.NewTab;
+    async open() {
+        if (!this.url) {
+            console.error("URL is not set", this);
+            return;
+        }
+        this._validateUrl();
+        if (isDevEnvironment())
+            showBalloonMessage("Open URL: " + this.url);
+        switch (this.mode) {
+            case OpenURLMode.NewTab:
+                if (isSafari()) {
+                    globalThis.open(this.url, "_blank");
+                }
+                else
+                    globalThis.open(this.url, "_blank");
+                break;
+            case OpenURLMode.SameTab:
+                if (isSafari()) {
+                    globalThis.open(this.url, "_top");
+                }
+                else
+                    globalThis.open(this.url, "_self");
+                break;
+            case OpenURLMode.NewWindow:
+                if (isSafari()) {
+                    globalThis.open(this.url, "_top");
+                }
+                else
+                    globalThis.open(this.url, "_new");
+                break;
+        }
+    }
+    start() {
+        const raycaster = this.gameObject.getComponentInParent(ObjectRaycaster);
+        if (!raycaster)
+            this.gameObject.addNewComponent(ObjectRaycaster);
+    }
+    onEnable() {
+        if (isSafari())
+            window.addEventListener("touchend", this._safariNewTabWorkaround);
+    }
+    onDisable() {
+        if (isSafari())
+            window.removeEventListener("touchend", this._safariNewTabWorkaround);
+    }
+    onPointerEnter(args) {
+        if (!args.used && this.clickable)
+            this.context.input.setCursorPointer();
+    }
+    onPointerExit() {
+        if (this.clickable)
+            this.context.input.setCursorNormal();
+    }
+    onPointerClick(args) {
+        if (this.clickable && !args.used && this.url?.length)
+            this.open();
+    }
+    _safariNewTabWorkaround = () => {
+        if (!this.clickable || !this.url?.length)
+            return;
+        // we only need this workaround for opening a new tab
+        if (this.mode === OpenURLMode.SameTab)
+            return;
+        // When we process the click directly in the browser event we can open a new tab
+        // by emitting a link attribute and calling onClick
+        const raycaster = this.gameObject.getComponentInParent(Raycaster);
+        if (raycaster) {
+            const hits = raycaster.performRaycast();
+            if (!hits)
+                return;
+            for (const hit of hits) {
+                if (hit.object === this.gameObject || tryGetUIComponent(hit.object)?.gameObject === this.gameObject) {
+                    this._validateUrl();
+                    var a = document.createElement('a');
+                    a.setAttribute("target", "_blank");
+                    a.setAttribute("href", this.url);
+                    a.click();
+                    break;
+                }
+            }
+        }
+    };
+    _validateUrl() {
+        if (!this.url)
+            return;
+        if (this.url.startsWith("www.")) {
+            if (isDevEnvironment()) {
+                console.warn("URL is not valid, adding https:// to the start of the URL", this.url);
+            }
+            this.url = "https://" + this.url;
+        }
+    }
+}
+__decorate([
+    serializable()
+], OpenURL.prototype, "clickable", void 0);
+__decorate([
+    serializable()
+], OpenURL.prototype, "url", void 0);
+__decorate([
+    serializable()
+], OpenURL.prototype, "mode", void 0);
+//# sourceMappingURL=OpenURL.js.map

package/lib/engine-components/utils/OpenURL.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OpenURL.js","sourceRoot":"","sources":["../../../src/engine-components/utils/OpenURL.ts"],"names":[],"mappings":";;;;;;AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,YAAY,EAAE,MAAM,mCAAmC,CAAC;AACjE,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAC1E,OAAO,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AACrD,OAAO,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC7D,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAEhD,MAAM,CAAN,IAAY,WAIX;AAJD,WAAY,WAAW;IACnB,iDAAU,CAAA;IACV,mDAAW,CAAA;IACX,uDAAa,CAAA;AACjB,CAAC,EAJW,WAAW,KAAX,WAAW,QAItB;AAED,MAAM,OAAO,OAAQ,SAAQ,SAAS;IAGlC,SAAS,GAAY,IAAI,CAAC;IAG1B,GAAG,CAAU;IAGb,IAAI,GAAgB,WAAW,CAAC,MAAM,CAAC;IAEvC,KAAK,CAAC,IAAI;QACN,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;YACX,OAAO,CAAC,KAAK,CAAC,gBAAgB,EAAE,IAAI,CAAC,CAAC;YACtC,OAAO;SACV;QAED,IAAI,CAAC,YAAY,EAAE,CAAC;QAEpB,IAAI,gBAAgB,EAAE;YAAE,kBAAkB,CAAC,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,CAAA;QAGnE,QAAQ,IAAI,CAAC,IAAI,EAAE;YACf,KAAK,WAAW,CAAC,MAAM;gBACnB,IAAI,QAAQ,EAAE,EAAE;oBACZ,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;iBACvC;;oBAEG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;gBACxC,MAAM;YACV,KAAK,WAAW,CAAC,OAAO;gBACpB,IAAI,QAAQ,EAAE,EAAE;oBACZ,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;iBACrC;;oBACI,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;gBACxC,MAAM;YACV,KAAK,WAAW,CAAC,SAAS;gBACtB,IAAI,QAAQ,EAAE,EAAE;oBACZ,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;iBACrC;;oBACI,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;gBACvC,MAAM;SAEb;IACL,CAAC;IAED,KAAK;QACD,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC,eAAe,CAAC,CAAC;QACxE,IAAI,CAAC,SAAS;YAAE,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,eAAe,CAAC,CAAC;IACrE,CAAC;IAED,QAAQ;QACJ,IAAI,QAAQ,EAAE;YAAE,MAAM,CAAC,gBAAgB,CAAC,UAAU,EAAE,IAAI,CAAC,uBAAuB,CAAC,CAAC;IACtF,CAAC;IACD,SAAS;QACL,IAAI,QAAQ,EAAE;YAAE,MAAM,CAAC,mBAAmB,CAAC,UAAU,EAAE,IAAI,CAAC,uBAAuB,CAAC,CAAC;IACzF,CAAC;IAED,cAAc,CAAC,IAAI;QACf,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,SAAS;YAC5B,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,gBAAgB,EAAE,CAAC;IAC9C,CAAC;IACD,aAAa;QACT,IAAI,IAAI,CAAC,SAAS;YACd,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,eAAe,EAAE,CAAC;IAC7C,CAAC;IACD,cAAc,CAAC,IAAsB;QACjC,IAAI,IAAI,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,GAAG,EAAE,MAAM;YAChD,IAAI,CAAC,IAAI,EAAE,CAAC;IACpB,CAAC;IAEO,uBAAuB,GAAG,GAAG,EAAE;QACnC,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM;YAAE,OAAO;QACjD,qDAAqD;QACrD,IAAI,IAAI,CAAC,IAAI,KAAK,WAAW,CAAC,OAAO;YAAE,OAAO;QAC9C,gFAAgF;QAChF,mDAAmD;QACnD,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC;QAClE,IAAI,SAAS,EAAE;YACX,MAAM,IAAI,GAAG,SAAS,CAAC,cAAc,EAAE,CAAC;YACxC,IAAI,CAAC,IAAI;gBAAE,OAAO;YAClB,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;gBACpB,IAAI,GAAG,CAAC,MAAM,KAAK,IAAI,CAAC,UAAU,IAAI,iBAAiB,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,UAAU,KAAK,IAAI,CAAC,UAAU,EAAE;oBACjG,IAAI,CAAC,YAAY,EAAE,CAAC;oBACpB,IAAI,CAAC,GAAG,QAAQ,CAAC,aAAa,CAAC,GAAG,CAAsB,CAAC;oBACzD,CAAC,CAAC,YAAY,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;oBACnC,CAAC,CAAC,YAAY,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;oBACjC,CAAC,CAAC,KAAK,EAAE,CAAC;oBACV,MAAM;iBACT;aACJ;SACJ;IACL,CAAC,CAAA;IAEO,YAAY;QAChB,IAAI,CAAC,IAAI,CAAC,GAAG;YAAE,OAAO;QACtB,IAAI,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE;YAC7B,IAAI,gBAAgB,EAAE,EAAE;gBACpB,OAAO,CAAC,IAAI,CAAC,2DAA2D,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;aACvF;YACD,IAAI,CAAC,GAAG,GAAG,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC;SACpC;IACL,CAAC;CACJ;AApGG;IADC,YAAY,EAAE;0CACW;AAG1B;IADC,YAAY,EAAE;oCACF;AAGb;IADC,YAAY,EAAE;qCACwB"}