@wonderlandengine/editor-api 1.2.3-dev.1 → 1.2.4

package/dist/data.js

@@ -1,18 +1,70 @@
+export let data = (global._wl_internalBinding ?? (() => { }))('data');
+/* Copy over the access functions to the base prototype */
+let ApiObject = data ? Object.getPrototypeOf(Object.getPrototypeOf(data)) : null;
+/** Project type */
+export var ProjectType;
+(function (ProjectType) {
+    ProjectType["Website"] = "website";
+    ProjectType["Game"] = "game";
+})(ProjectType || (ProjectType = {}));
+export function toValue(value) {
+    if (ApiObject.isPrototypeOf(value))
+        return value.toValue();
+    else
+        return value;
+}
+export class Access {
+    exists;
+    keys() {
+        return Object.keys(this).filter((k) => this.exists(k));
+    }
+    values() {
+        return Object.keys(this)
+            .filter((k) => this.exists(k))
+            .map((k) => toValue(this[k]));
+    }
+    entries() {
+        return Object.entries(this)
+            .filter(([k, v]) => this.exists(k))
+            .map(([k, v]) => [k, toValue(v)]);
+    }
+    toValue() {
+        return Object.fromEntries(this.entries());
+    }
+    toJSON() {
+        return this.toValue();
+    }
+    [Symbol.iterator]() {
+        return Object.entries(this)[Symbol.iterator]();
+    }
+}
+if (ApiObject) {
+    Object.assign(ApiObject, {
+        keys: Access.prototype.keys,
+        values: Access.prototype.values,
+        entries: Access.prototype.entries,
+        toValue: Access.prototype.toValue,
+        toJSON: Access.prototype.toJSON,
+        [Symbol.iterator]: Access.prototype[Symbol.iterator],
+    });
+}
 /** Project settings */
-export class ProjectSettings {
+export class ProjectSettings extends Access {
     name = '';
+    description = '';
+    type = ProjectType.Website;
     customIndexHtml = false;
     extraFilesFolder = 'static';
     packageForStreaming = false;
     version = [1, 2, 0];
 }
 /** Sky settings */
-export class SkySettings {
+export class SkySettings extends Access {
     enabled = false;
     material = null;
 }
 /** Bloom settings */
-export class BloomSettings {
+export class BloomSettings extends Access {
     enabled = false;
     passes = 3;
     threshold = 1.25;
@@ -36,12 +88,12 @@ export var TonemappingMode;
     TonemappingMode["Exponential"] = "exponential";
 })(TonemappingMode || (TonemappingMode = {}));
 /** HDR settings */
-export class HdrSettings {
+export class HdrSettings extends Access {
     exposure = 1.0;
     tonemapping = TonemappingMode.Reinhard;
 }
 /** Texture streaming settings */
-export class TextureStreamingSettings {
+export class TextureStreamingSettings extends Access {
     maxCacheSize = 1024;
     maxUploadPerFrame = 10;
 }
@@ -53,7 +105,7 @@ export var EnvironmentMode;
     EnvironmentMode["SphericalHarmonic2"] = "spherical-harmonic-2";
 })(EnvironmentMode || (EnvironmentMode = {}));
 /** Environment settings */
-export class EnvironmentSettings {
+export class EnvironmentSettings extends Access {
     enabled = false;
     image = null;
     mode = EnvironmentMode.Disabled;
@@ -63,7 +115,7 @@ export class EnvironmentSettings {
     maxSpecularEnvironmentSize = 512;
 }
 /** Rendering settings */
-export class RenderingSettings {
+export class RenderingSettings extends Access {
     api = 'webgl2';
     textureAtlasSize = [8192, 4096];
     compressedTextureAtlasSize = [16384, 8192];
@@ -80,12 +132,12 @@ export class RenderingSettings {
     maxTextures = 1024;
 }
 /** Camera settings */
-export class CameraSettings {
+export class CameraSettings extends Access {
     near = 0.02;
     far = 100.0;
 }
 /** Editor settings */
-export class EditorSettings {
+export class EditorSettings extends Access {
     serverPort = 8080;
     serverCOEP = 'require-corp';
     camera = new CameraSettings();
@@ -96,10 +148,10 @@ export class EditorSettings {
     };
 }
 /** Plugins settings */
-export class PluginsSettings {
+export class PluginsSettings extends Access {
 }
 /** WebXR settings */
-export class WebXRSettings {
+export class WebXRSettings extends Access {
     optionalFeatures = {
         'local': true,
         'local-floor': false,
@@ -112,7 +164,6 @@ export class WebXRSettings {
         'anchors': false,
         'occlusion': false,
         'marker-tracking': false,
-        'extraFeatures': '',
     };
     requiredFeatures = {
         'local': true,
@@ -126,11 +177,10 @@ export class WebXRSettings {
         'anchors': false,
         'occlusion': false,
         'marker-tracking': false,
-        'extraFeatures': '',
     };
 }
 /** PWA settings */
-export class PWASettings {
+export class PWASettings extends Access {
     enable = false;
     customServiceWorker = false;
     customManifest = false;
@@ -139,7 +189,7 @@ export class PWASettings {
     appIcon = null;
 }
 /** Runtime settings */
-export class RuntimeSettings {
+export class RuntimeSettings extends Access {
     visualizeColliders = false;
     visualizePhysX = false;
     visualizeOverdraw = false;
@@ -159,7 +209,7 @@ export var BundlingType;
     BundlingType["Npm"] = "npm";
 })(BundlingType || (BundlingType = {}));
 /** Scripting settings */
-export class ScriptingSettings {
+export class ScriptingSettings extends Access {
     sourcePaths = [];
     libraryPaths = [];
     bundlingType = BundlingType.Esbuild;
@@ -169,14 +219,14 @@ export class ScriptingSettings {
     entryPoint = 'js/index.js';
 }
 /** VR settings */
-export class VRSettings {
+export class VRSettings extends Access {
     enable = true;
     rightEyeObject = null;
     leftEyeObject = null;
     framebufferScaleFactor = 1.0;
 }
 /** Physics settings */
-export class PhysXSettings {
+export class PhysXSettings extends Access {
     enable = false;
     maxTimestep = 0.05;
     contactOffset = 0.02;
@@ -196,18 +246,18 @@ export class PhysXSettings {
     speedToleranceScale = 10.0;
 }
 /** AR settings */
-export class ARSettings {
+export class ARSettings extends Access {
     enable = false;
 }
 /** Localization settings */
-export class LocalizationSettings {
+export class LocalizationSettings extends Access {
     enableZipCompression = false;
     format = 'i18next';
     languagesFolder = 'languages';
     defaultLanguage = 'en';
 }
 /** Settings for the currently open project */
-export class Settings {
+export class Settings extends Access {
     project = new ProjectSettings();
     rendering = new RenderingSettings();
     editor = new EditorSettings();
@@ -226,8 +276,16 @@ export var ImageCompressionType;
     ImageCompressionType["ETC1s"] = "etc1s";
     ImageCompressionType["UASTC"] = "uastc";
 })(ImageCompressionType || (ImageCompressionType = {}));
+export class Link extends Access {
+    name = '';
+    file = '';
+}
+export class Resource extends Access {
+    name = '';
+    link = null;
+}
 /** Image resource */
-export class ImageResource {
+export class ImageResource extends Resource {
     name = 'image';
     maxSize = [8192, 8192];
     compression = ImageCompressionType.ETC1s;
@@ -237,7 +295,7 @@ export class ImageResource {
     hdr = false;
 }
 /** Texture resource */
-export class TextureResource {
+export class TextureResource extends Resource {
     name = 'texture';
     image = null;
     type = 1;
@@ -259,14 +317,14 @@ export var ShaderType;
     ShaderType["Fullscreen"] = "fullscreen";
 })(ShaderType || (ShaderType = {}));
 /** Shader resource */
-export class ShaderResource {
+export class ShaderResource extends Resource {
     name = 'shader';
     stage = ShaderStage.Fragment;
     type = ShaderType.Forward;
     packageUnused = false;
 }
 /** Mesh resource */
-export class MeshResource {
+export class MeshResource extends Resource {
     name = 'mesh';
     simplify = false;
     simplifyTarget = 0.5;
@@ -275,7 +333,7 @@ export class MeshResource {
     hasMorphTargets = false;
 }
 /** Material properties for the default Phong pipeline */
-export class PhongMaterial {
+export class PhongMaterial extends Access {
     ambientColor = [0.05, 0.05, 0.05, 1.0];
     diffuseTexture = null;
     diffuseColor = [1, 1, 1, 1.0];
@@ -291,7 +349,7 @@ export class PhongMaterial {
     alphaMaskTexture = null;
 }
 /** Material properties for the default Phong pipeline */
-export class PhysicalMaterial {
+export class PhysicalMaterial extends Access {
     albedoColor = [1.0, 1.0, 1.0, 1.0];
     emissiveTexture = null;
     emissiveColor = [0.0, 0.0, 0.0, 1.0];
@@ -308,19 +366,19 @@ export class PhysicalMaterial {
     alphaMaskTexture = null;
 }
 /** Material properties for the default MeshVisualizer pipeline */
-export class MeshVisualizerMaterial {
+export class MeshVisualizerMaterial extends Access {
     color = [0.5, 0.5, 0.5, 1];
     wireframeColor = [1, 1, 1, 1];
 }
 /** Material properties for the default Flat pipeline */
-export class FlatMaterial {
+export class FlatMaterial extends Access {
     color = [1, 1, 1, 1];
     flatTexture = null;
     alphaMaskThreshold = 0.5;
     alphaMaskTexture = null;
 }
 /** Material properties for the default Particle pipeline */
-export class ParticleMaterial {
+export class ParticleMaterial extends Access {
     color = [1, 1, 1, 1];
     mainTexture = null;
     noiseTexture = null;
@@ -328,7 +386,7 @@ export class ParticleMaterial {
     offsetY = 0.0;
 }
 /** Material properties for the default DistanceFieldVector pipeline */
-export class DistanceFieldVectorMaterial {
+export class DistanceFieldVectorMaterial extends Access {
     color = [1, 1, 1, 1];
     outlineColor = [0, 0, 0, 1];
     outlineRange = [0.4, 0.3];
@@ -336,13 +394,13 @@ export class DistanceFieldVectorMaterial {
     smoothness = 0.02;
 }
 /** Material properties for the default Text pipeline */
-export class TextMaterial {
+export class TextMaterial extends Access {
     color = [1, 1, 1, 1];
     effectColor = [0, 0, 0, 1];
     font = null;
 }
 /** Material properties for the default Sky pipeline */
-export class SkyMaterial {
+export class SkyMaterial extends Access {
     colorStop0 = [1, 1, 1, 1];
     colorStop1 = [0.55, 0.95, 1, 1];
     colorStop2 = [0.55, 0.95, 1, 1];
@@ -350,7 +408,7 @@ export class SkyMaterial {
     texture = null;
 }
 /** Material properties for the default Background pipeline */
-export class BackgroundMaterial {
+export class BackgroundMaterial extends Access {
     colorStop0 = [1, 1, 1, 1];
     colorStop1 = [0.55, 0.95, 1, 1];
     colorStop2 = [0.55, 0.95, 1, 1];
@@ -358,7 +416,7 @@ export class BackgroundMaterial {
     texture = null;
 }
 /** Material properties for the default Particle pipeline */
-export class MaterialResource {
+export class MaterialResource extends Resource {
     pipeline = null;
     name = 'material';
     Phong;
@@ -384,8 +442,8 @@ export var RootMotionMode;
     RootMotionMode["ApplyToOwner"] = "applyToOwner";
     RootMotionMode["ScriptEvent"] = "scriptEvent";
 })(RootMotionMode || (RootMotionMode = {}));
-/** 'animation' component configuration */
-export class AnimationComponent {
+/** 'animation' component */
+export class AnimationComponent extends Access {
     preview = false;
     retarget = false;
     autoplay = false;
@@ -408,8 +466,8 @@ export var LightType;
     /** Sun light type */
     LightType["Sun"] = "sun";
 })(LightType || (LightType = {}));
-/** 'light' component configuration */
-export class LightComponent {
+/** 'light' component */
+export class LightComponent extends Access {
     type = LightType.Point;
     color = [1.0, 1.0, 1.0];
     intensity = 1;
@@ -430,34 +488,34 @@ export var ProjectionType;
     /** Orthographic projection */
     ProjectionType["Orthographic"] = "orthographic";
 })(ProjectionType || (ProjectionType = {}));
-/** 'view' component configuration */
-export class ViewComponent {
+/** 'view' component */
+export class ViewComponent extends Access {
     projectionType = ProjectionType.Perspective;
     fov = 90;
     extent = 10;
     near = 0.01;
     far = 100;
 }
-/** Settings for a sphere physics shape */
-export class PhysXSphereConfig {
+/** Sphere physics shape */
+export class PhysXSphere extends Access {
     radius = 0.25;
 }
-/** Settings for a box physics shape */
-export class PhysXBoxConfig {
+/** Box physics shape */
+export class PhysXBox extends Access {
     extents = [0.25, 0.25, 0.25];
 }
-/** Settings for a capsule physics shape */
-export class PhysXCapsuleConfig {
+/** Capsule physics shape */
+export class PhysXCapsule extends Access {
     radius = 0.15;
     halfHeight = 0.25;
 }
-/** Settings for a triangle mesh physics shape */
-export class PhysXTriangleMeshConfig {
+/** Triangle mesh physics shape */
+export class PhysXTriangleMesh extends Access {
     mesh = null;
     scaling = [1, 1, 1];
 }
-/** Settings for a convex mesh physics shape */
-export class PhysXConvexMeshConfig {
+/** Convex mesh physics shape */
+export class PhysXConvexMesh extends Access {
     mesh = null;
     scaling = [1, 1, 1];
 }
@@ -470,8 +528,8 @@ export var PhysXShapeType;
     PhysXShapeType["TriangleMesh"] = "triangleMesh";
     PhysXShapeType["ConvexMesh"] = "convexMesh";
 })(PhysXShapeType || (PhysXShapeType = {}));
-/** 'physx' component configuration */
-export class PhysXComponent {
+/** 'physx' component */
+export class PhysXComponent extends Access {
     static = false;
     kinematic = false;
     simulate = true;
@@ -500,8 +558,8 @@ export class PhysXComponent {
     solverPositionIterations = 4;
     solverVelocityIterations = 1;
 }
-/** 'mesh' component configuration */
-export class MeshComponent {
+/** 'mesh' component */
+export class MeshComponent extends Access {
     material = null;
     mesh = null;
     skin = null;
@@ -522,8 +580,8 @@ export var TextWrapMode;
     TextWrapMode["Hard"] = "hard";
     TextWrapMode["Clip"] = "clip";
 })(TextWrapMode || (TextWrapMode = {}));
-/** 'text' component configuration */
-export class TextComponent {
+/** 'text' component */
+export class TextComponent extends Access {
     alignment = 'center';
     verticalAlignment = 'middle';
     characterSpacing = 0.0;
@@ -534,20 +592,20 @@ export class TextComponent {
     wrapMode = TextWrapMode.None;
     wrapWidth = 0.0;
 }
-/** Settings for a sphere collider */
-export class SphereConfig {
+/** Sphere collider */
+export class Sphere extends Access {
     radius = 1.0;
 }
-/** Settings for a AxisAlignedBoundingBox collider */
-export class AABBConfig {
+/** AxisAlignedBoundingBox collider */
+export class AABB extends Access {
     extents = [1.0, 1.0, 1.0];
 }
-/** Settings for a box collider */
-export class BoxConfig {
+/** Box collider */
+export class Box extends Access {
     extents = [1.0, 1.0, 1.0];
 }
-/** 'collision' component configuration */
-export class CollisionComponent {
+/** 'collision' component */
+export class CollisionComponent extends Access {
     collider = 'sphere';
     sphere;
     aabb;
@@ -565,21 +623,21 @@ export var InputType;
     InputType["RayLeft"] = "ray left";
     InputType["RayRight"] = "ray right";
 })(InputType || (InputType = {}));
-/** 'input' component configuration */
-export class InputComponent {
+/** 'input' component */
+export class InputComponent extends Access {
     type = InputType.Head;
 }
-export class AnimationEvent {
+export class AnimationEvent extends Access {
     time = 0.0;
     name = '';
 }
-export class RootMotion {
+export class RootMotion extends Access {
     target = null;
     translationAxis = 0;
     rotationAxis = 0;
 }
 /** Animation resource */
-export class AnimationResource {
+export class AnimationResource extends Resource {
     /** Name of the animation */
     name = 'animation';
     /** Whether to compress the animation */
@@ -590,31 +648,31 @@ export class AnimationResource {
     events = [];
     rootMotion;
 }
-/** Component configuration */
-export class ComponentConfig {
+/** Component */
+export class ObjectComponent extends Access {
     /** Component type */
     type = null;
     /** Whether the component is active */
     active = true;
-    /** Configuration for animation components */
+    /** Animation component */
     animation;
-    /** Configuration for collision components */
+    /** Collision component */
     collision;
-    /** Configuration for input components */
+    /** Input component */
     input;
-    /** Configuration for light components */
+    /** Light component */
     light;
-    /** Configuration for mesh components */
+    /** Mesh component */
     mesh;
-    /** Configuration for physx components */
+    /** Physx component */
     physx;
-    /** Configuration for text components */
+    /** Text component */
     text;
-    /** Configuration for view components */
+    /** View component */
     view;
 }
 /** Object resource */
-export class ObjectResource {
+export class ObjectResource extends Resource {
     /** Name of the object */
     name = 'object';
     /** Translation vector */
@@ -631,7 +689,7 @@ export class ObjectResource {
     components = [];
 }
 /** Skin resource */
-export class SkinResource {
+export class SkinResource extends Resource {
     /** Name of the skin */
     name = 'skin';
     /** List of objects that make up the joints of this skin */
@@ -682,7 +740,7 @@ export var MeshSorting;
     MeshSorting["MeshIndex"] = "mesh-index";
 })(MeshSorting || (MeshSorting = {}));
 /** Pipeline resource */
-export class PipelineResource {
+export class PipelineResource extends Resource {
     name = 'pipeline';
     doubleSided = false;
     castShadows = false;
@@ -703,7 +761,7 @@ export class PipelineResource {
     depthFunction = DepthFunction.Less;
 }
 /** Font resource */
-export class FontResource {
+export class FontResource extends Resource {
     /** Name of the font */
     name = 'font';
     /** Which characters need to be renderable with this font */
@@ -714,61 +772,17 @@ export class FontResource {
     outlineSize = 0.1;
 }
 /** Language resource */
-export class LanguageResource {
+export class LanguageResource extends Resource {
     /** Name of the language */
     name = 'language';
     /** Whether this is the default language */
     isDefault = false;
 }
 /** File resource */
-export class FileResource {
+export class FileResource extends Resource {
     fileName = '';
     importerName = '';
     importPhysicalAsPhongMaterials = true;
 }
-/**
- * Access to Wonderland Editor's data.
- *
- * Hold control and hover any field in Wonderland Editor to see its JSON path.
- * The path is equivalent to how you find the matching chain of properties.
- * @example
- *
- * ```
- *    /objects/123/components/0/text/text
- * ```
- *
- * Will match the following code:
- *
- * ```ts
- *    WL.data.objects[123].components[0].text.text
- * ```
- */
-export class EditorData {
-    /** Project settings */
-    settings = new Settings();
-    /** List of scene file paths */
-    files = [];
-    /** Animation resources */
-    animations = [];
-    /** Object resources */
-    objects = [];
-    /** Skin resources */
-    skins = [];
-    /** Image resources */
-    images = [];
-    /** Shader resources */
-    shaders = [];
-    /** Mesh resources */
-    meshes = [];
-    /** Texture resources */
-    textures = [];
-    /** Material resources */
-    materials = [];
-    /** Font resources */
-    fonts = [];
-    /** Pipeline resources */
-    pipelines = [];
-    /** Language resources */
-    languages = [];
+export class ResourceSection {
 }
-export let data = (global._wl_internalBinding ?? (() => { }))('data');

package/dist/index.d.ts

@@ -4,10 +4,34 @@ export * as tools from './tools.js';
 export * from './project.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

@@ -6,10 +6,12 @@ export { tools_1 as tools };
 export * from './project.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

@@ -17,11 +17,13 @@ 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;
 }
+/** Project paths */
 export interface Project {
     /**
      * Root directory of the project