@wonderlandengine/editor-api 1.2.3-dev.2 → 1.3.1

package/dist/index.d.ts

@@ -2,12 +2,37 @@ export * from './data.js';
 export * as ui from './ui.js';
 export * as tools from './tools.js';
 export * from './project.js';
+export * from './workspace.js';
 /** Editor plugin */
 export declare class EditorPlugin {
+    /** Name of the plugin */
     name: string;
-    draw?: () => void;
-    preProjectSave?: () => boolean;
-    postProjectLoad?: () => boolean;
-    prePackage?: () => boolean;
-    postPackage?: () => boolean;
+    /**
+     * Called to let the plugin draw it's ui. See {@link ui}.
+     */
+    draw?(): void;
+    /**
+     * Called before a project is saved
+     *
+     * @returns `false` to indicate failure to save.
+     */
+    preProjectSave?(): boolean;
+    /**
+     * Called after a project is loaded
+     *
+     * @returns `false` to indicate failure to load.
+     */
+    postProjectLoad?: boolean;
+    /**
+     * Called before a project is packaged
+     *
+     * @returns `false` to abort packaging.
+     */
+    prePackage?(): boolean;
+    /**
+     * Called after a project is packaged
+     *
+     * @returns `false` to abort packaging.
+     */
+    postPackage?(): boolean;
 }

package/dist/index.js

@@ -4,12 +4,15 @@ export { ui_1 as ui };
 import * as tools_1 from './tools.js';
 export { tools_1 as tools };
 export * from './project.js';
+export * from './workspace.js';
 /** Editor plugin */
 export class EditorPlugin {
+    /** Name of the plugin */
     name = 'Editor Plugin';
-    draw;
-    preProjectSave;
+    /**
+     * Called after a project is loaded
+     *
+     * @returns `false` to indicate failure to load.
+     */
     postProjectLoad;
-    prePackage;
-    postPackage;
 }

package/dist/native.d.ts

@@ -1,4 +1,5 @@
 import { EditorData } from './data.js';
+import { Workspace } from './workspace.js';
 interface NativeToolsAPI {
     packageProject(destDir?: string): number;
     loadFile(filename: string): number;
@@ -17,12 +18,17 @@ interface NativeUiAPI {
     checkbox(label: string, value: boolean): boolean | null;
     colorEdit4(label: string, value: Float32Array): boolean;
     dummy(width: number, height: number): void;
-    sameLine(offset: number): void;
+    sameLine(offset?: number): void;
     separator(): void;
     spinner(): void;
     beginGroup(): void;
     endGroup(): void;
+    inputFloat(label: string, value: number): number | null;
+    inputFloat3(label: string, value: Float32Array): boolean;
+    inputInt(label: string, value: number): number | null;
+    inputInt3(label: string, value: Int32Array): boolean;
 }
+/** Project paths */
 export interface Project {
     /**
      * Root directory of the project
@@ -67,5 +73,6 @@ declare global {
     function _wl_internalBinding(moduleName: 'ui'): NativeUiAPI;
     function _wl_internalBinding(moduleName: 'data'): EditorData;
     function _wl_internalBinding(moduleName: 'project'): Project;
+    function _wl_internalBinding(moduleName: 'workspace'): Workspace;
 }
 export {};

package/dist/ui.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" resolution-mode="require"/>
-/** Image to be used in the {@ref Ui}. */
+/** Image to be used in {@link ui}. */
 export declare class UiImage {
     _id: number;
     constructor(id: number);
@@ -91,7 +91,7 @@ export declare const dummy: (width: number, height: number) => void;
  *
  * @param offset Offset on the x axis.
  */
-export declare const sameLine: (offset: number) => void;
+export declare const sameLine: (offset?: number) => void;
 /** Separator line. */
 export declare const separator: () => void;
 /** Begin a widget group. */
@@ -100,3 +100,53 @@ export declare const beginGroup: () => void;
 export declare const endGroup: () => void;
 /** Spinner to indicate loading. */
 export declare const spinner: () => void;
+/**
+ * Draggable float input
+ * @param label Label for the input.
+ * @param value Current value.
+ * @returns The new value when changed by the user this frame, otherwise `null`.
+ *
+ * @example
+ *     let myFloat = 0;
+ *     const n = ui.inputFloat("change this:", myFloat);
+ *     if(n !== null) myFloat = n;
+ */
+export declare const inputFloat: (label: string, value: number) => number | null;
+/**
+ * Draggable float3 input
+ * @param label Label for the input.
+ * @param value Current value.
+ * @returns `true` if changed by the user this frame, `false` otherwise.
+ *
+ * @example
+ *     const myFloat3 = new Float32Array(3);
+ *     if(ui.inputFloat3("change this:", myFloat3)) {
+ *        console.log("changed");
+ *     }
+ */
+export declare const inputFloat3: (label: string, value: Float32Array) => boolean;
+/**
+ * Draggable int input
+ * @param label Label for the input.
+ * @param value Current value.
+ * @returns The new value when changed by the user this frame, otherwise `null`.
+ *
+ * @example
+ *     let myInt = 0;
+ *     const n = ui.inputInt("change this:", myInt);
+ *     if(n !== null) myInt = n;
+ */
+export declare const inputInt: (label: string, value: number) => number | null;
+/**
+ * Draggable int3 input
+ * @param label Label for the input.
+ * @param value Current value.
+ * @returns `true` if changed by the user this frame, `false` otherwise.
+ *
+ * @example
+ *     const myInt3 = new Int32Array(3);
+ *     if(ui.inputInt3("change this:", myInt3)) {
+ *        console.log("changed");
+ *     }
+ */
+export declare const inputInt3: (label: string, value: Int32Array) => boolean;

package/dist/ui.js

@@ -1,6 +1,6 @@
 import { awaitJob } from './tools.js';
 const ui = _wl_internalBinding('ui');
-/** Image to be used in the {@ref Ui}. */
+/** Image to be used in {@link ui}. */
 export class UiImage {
     _id = -1;
     constructor(id) {
@@ -124,3 +124,53 @@ export const beginGroup = ui.beginGroup.bind(ui);
 export const endGroup = ui.endGroup.bind(ui);
 /** Spinner to indicate loading. */
 export const spinner = ui.spinner.bind(ui);
+/**
+ * Draggable float input
+ * @param label Label for the input.
+ * @param value Current value.
+ * @returns The new value when changed by the user this frame, otherwise `null`.
+ *
+ * @example
+ *     let myFloat = 0;
+ *     const n = ui.inputFloat("change this:", myFloat);
+ *     if(n !== null) myFloat = n;
+ */
+export const inputFloat = ui.inputFloat.bind(ui);
+/**
+ * Draggable float3 input
+ * @param label Label for the input.
+ * @param value Current value.
+ * @returns `true` if changed by the user this frame, `false` otherwise.
+ *
+ * @example
+ *     const myFloat3 = new Float32Array(3);
+ *     if(ui.inputFloat3("change this:", myFloat3)) {
+ *        console.log("changed");
+ *     }
+ */
+export const inputFloat3 = ui.inputFloat3.bind(ui);
+/**
+ * Draggable int input
+ * @param label Label for the input.
+ * @param value Current value.
+ * @returns The new value when changed by the user this frame, otherwise `null`.
+ *
+ * @example
+ *     let myInt = 0;
+ *     const n = ui.inputInt("change this:", myInt);
+ *     if(n !== null) myInt = n;
+ */
+export const inputInt = ui.inputInt.bind(ui);
+/**
+ * Draggable int3 input
+ * @param label Label for the input.
+ * @param value Current value.
+ * @returns `true` if changed by the user this frame, `false` otherwise.
+ *
+ * @example
+ *     const myInt3 = new Int32Array(3);
+ *     if(ui.inputInt3("change this:", myInt3)) {
+ *        console.log("changed");
+ *     }
+ */
+export const inputInt3 = ui.inputInt3.bind(ui);

package/dist/workspace.d.ts

@@ -0,0 +1,10 @@
+/** @todo: Give access to each projects using: getProject(filename). */
+/**
+ * Workspace access.
+ *
+ * Allows to read the current workspace setup.
+ */
+export interface Workspace {
+    mainFilename: string;
+}
+export declare const workspace: Workspace;

package/dist/workspace.js

@@ -0,0 +1,2 @@
+/** @todo: Give access to each projects using: getProject(filename). */
+export const workspace = _wl_internalBinding('workspace');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wonderlandengine/editor-api",
-  "version": "1.2.3-dev.2",
+  "version": "1.3.1",
   "description": "Wonderland Engine's Editor API for plugins - very experimental.",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
@@ -11,7 +11,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/WonderlandEngine/api.git"
+    "url": "git+https://github.com/WonderlandEngine/editor-api.git"
   },
   "keywords": [
     "webxr",