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

package/README.md

@@ -1,8 +1,8 @@
-# Wonderland Editor JavaScript Plugin API
+# Wonderland Editor JavaScript/TypeScript Plugin API
 
-(Experimental!) API to extend the Wonderland Editor with JavaScript or TypeScript.
+API to extend the Wonderland Editor with JavaScript or TypeScript.
 
-**Note:** This package requires the upcoming 1.2.0 version of Wonderland Engine.
+**Note:** This package requires version 1.2.4 of Wonderland Engine.
 
 Learn more about Wonderland Engine in the [documentation](https://wonderlandengine.com/editor/plugins/).
 

package/dist/data.d.ts

@@ -1,3 +1,4 @@
+export declare let data: EditorData;
 /** Object reference */
 export type ObjectReference = string | null;
 /** Mesh reference */
@@ -20,21 +21,38 @@ export type SkinReference = string | null;
 export type ImageReference = string | null;
 /** Animation reference */
 export type AnimationReference = string | null;
+/** Project type */
+export declare enum ProjectType {
+    Website = "website",
+    Game = "game"
+}
+export declare function toValue(value: any): any;
+export declare class Access {
+    exists?: (key: string) => boolean;
+    keys(): string[];
+    values(): any[];
+    entries(): [string, any][];
+    toValue(): Object;
+    toJSON(): Object;
+    [Symbol.iterator](): IterableIterator<[string, any]>;
+}
 /** Project settings */
-export declare class ProjectSettings {
+export declare class ProjectSettings extends Access {
     name: string;
+    description: string;
+    type: ProjectType;
     customIndexHtml: boolean;
     extraFilesFolder: string;
     packageForStreaming: boolean;
     version: number[];
 }
 /** Sky settings */
-export declare class SkySettings {
+export declare class SkySettings extends Access {
     enabled: boolean;
     material: MaterialReference;
 }
 /** Bloom settings */
-export declare class BloomSettings {
+export declare class BloomSettings extends Access {
     enabled: boolean;
     passes: number;
     threshold: number;
@@ -57,12 +75,12 @@ export declare enum TonemappingMode {
     Exponential = "exponential"
 }
 /** HDR settings */
-export declare class HdrSettings {
+export declare class HdrSettings extends Access {
     exposure: number;
     tonemapping: TonemappingMode;
 }
 /** Texture streaming settings */
-export declare class TextureStreamingSettings {
+export declare class TextureStreamingSettings extends Access {
     maxCacheSize: number;
     maxUploadPerFrame: number;
 }
@@ -73,7 +91,7 @@ export declare enum EnvironmentMode {
     SphericalHarmonic2 = "spherical-harmonic-2"
 }
 /** Environment settings */
-export declare class EnvironmentSettings {
+export declare class EnvironmentSettings extends Access {
     enabled: boolean;
     image: ImageReference;
     mode: EnvironmentMode;
@@ -83,7 +101,7 @@ export declare class EnvironmentSettings {
     maxSpecularEnvironmentSize: number;
 }
 /** Rendering settings */
-export declare class RenderingSettings {
+export declare class RenderingSettings extends Access {
     api: 'webgl2' | 'webgpu-or-webgl2';
     textureAtlasSize: number[];
     compressedTextureAtlasSize: number[];
@@ -100,12 +118,12 @@ export declare class RenderingSettings {
     maxTextures: number;
 }
 /** Camera settings */
-export declare class CameraSettings {
+export declare class CameraSettings extends Access {
     near: number;
     far: number;
 }
 /** Editor settings */
-export declare class EditorSettings {
+export declare class EditorSettings extends Access {
     serverPort: number;
     serverCOEP: string;
     camera: CameraSettings;
@@ -116,30 +134,29 @@ export declare class EditorSettings {
     };
 }
 /** Plugins settings */
-export declare class PluginsSettings {
+export declare class PluginsSettings extends Access {
 }
 /** WebXR feature flags */
 export interface WebXRFeatureFlags {
-    local: boolean;
+    'local': boolean;
     'local-floor': boolean;
     'bounded-floor': boolean;
-    unbounded: boolean;
+    'unbounded': boolean;
     'hand-tracking': boolean;
     'hit-test': boolean;
     'plane-detection': boolean;
     'light-estimation': boolean;
-    anchors: boolean;
-    occlusion: boolean;
+    'anchors': boolean;
+    'occlusion': boolean;
     'marker-tracking': boolean;
-    extraFeatures: string;
 }
 /** WebXR settings */
-export declare class WebXRSettings {
+export declare class WebXRSettings extends Access {
     optionalFeatures: WebXRFeatureFlags;
     requiredFeatures: WebXRFeatureFlags;
 }
 /** PWA settings */
-export declare class PWASettings {
+export declare class PWASettings extends Access {
     enable: boolean;
     customServiceWorker: boolean;
     customManifest: boolean;
@@ -148,7 +165,7 @@ export declare class PWASettings {
     appIcon: ImageReference;
 }
 /** Runtime settings */
-export declare class RuntimeSettings {
+export declare class RuntimeSettings extends Access {
     visualizeColliders: boolean;
     visualizePhysX: boolean;
     visualizeOverdraw: boolean;
@@ -167,7 +184,7 @@ export declare enum BundlingType {
     Npm = "npm"
 }
 /** Scripting settings */
-export declare class ScriptingSettings {
+export declare class ScriptingSettings extends Access {
     sourcePaths: never[];
     libraryPaths: never[];
     bundlingType: BundlingType;
@@ -177,14 +194,14 @@ export declare class ScriptingSettings {
     entryPoint: string;
 }
 /** VR settings */
-export declare class VRSettings {
+export declare class VRSettings extends Access {
     enable: boolean;
     rightEyeObject: ObjectReference;
     leftEyeObject: ObjectReference;
     framebufferScaleFactor: number;
 }
 /** Physics settings */
-export declare class PhysXSettings {
+export declare class PhysXSettings extends Access {
     enable: boolean;
     maxTimestep: number;
     contactOffset: number;
@@ -204,18 +221,18 @@ export declare class PhysXSettings {
     speedToleranceScale: number;
 }
 /** AR settings */
-export declare class ARSettings {
+export declare class ARSettings extends Access {
     enable: boolean;
 }
 /** Localization settings */
-export declare class LocalizationSettings {
+export declare class LocalizationSettings extends Access {
     enableZipCompression: boolean;
     format: 'i18next';
     languagesFolder: string;
     defaultLanguage: string;
 }
 /** Settings for the currently open project */
-export declare class Settings {
+export declare class Settings extends Access {
     project: ProjectSettings;
     rendering: RenderingSettings;
     editor: EditorSettings;
@@ -233,8 +250,16 @@ export declare enum ImageCompressionType {
     ETC1s = "etc1s",
     UASTC = "uastc"
 }
+export declare class Link extends Access {
+    name: string;
+    file: string;
+}
+export declare class Resource extends Access {
+    name: string;
+    link: Link | null;
+}
 /** Image resource */
-export declare class ImageResource {
+export declare class ImageResource extends Resource {
     name: string;
     maxSize: number[];
     compression: ImageCompressionType;
@@ -244,7 +269,7 @@ export declare class ImageResource {
     hdr: boolean;
 }
 /** Texture resource */
-export declare class TextureResource {
+export declare class TextureResource extends Resource {
     name: string;
     image: ImageReference;
     type: number;
@@ -264,14 +289,14 @@ export declare enum ShaderType {
     Fullscreen = "fullscreen"
 }
 /** Shader resource */
-export declare class ShaderResource {
+export declare class ShaderResource extends Resource {
     name: string;
     stage: ShaderStage;
     type: ShaderType;
     packageUnused: boolean;
 }
 /** Mesh resource */
-export declare class MeshResource {
+export declare class MeshResource extends Resource {
     name: string;
     simplify: boolean;
     simplifyTarget: number;
@@ -280,7 +305,7 @@ export declare class MeshResource {
     hasMorphTargets: boolean;
 }
 /** Material properties for the default Phong pipeline */
-export declare class PhongMaterial {
+export declare class PhongMaterial extends Access {
     ambientColor: number[];
     diffuseTexture: TextureReference;
     diffuseColor: number[];
@@ -296,7 +321,7 @@ export declare class PhongMaterial {
     alphaMaskTexture: TextureReference;
 }
 /** Material properties for the default Phong pipeline */
-export declare class PhysicalMaterial {
+export declare class PhysicalMaterial extends Access {
     albedoColor: number[];
     emissiveTexture: TextureReference;
     emissiveColor: number[];
@@ -313,19 +338,19 @@ export declare class PhysicalMaterial {
     alphaMaskTexture: TextureReference;
 }
 /** Material properties for the default MeshVisualizer pipeline */
-export declare class MeshVisualizerMaterial {
+export declare class MeshVisualizerMaterial extends Access {
     color: number[];
     wireframeColor: number[];
 }
 /** Material properties for the default Flat pipeline */
-export declare class FlatMaterial {
+export declare class FlatMaterial extends Access {
     color: number[];
     flatTexture: TextureReference;
     alphaMaskThreshold: number;
     alphaMaskTexture: TextureReference;
 }
 /** Material properties for the default Particle pipeline */
-export declare class ParticleMaterial {
+export declare class ParticleMaterial extends Access {
     color: number[];
     mainTexture: TextureReference;
     noiseTexture: TextureReference;
@@ -333,7 +358,7 @@ export declare class ParticleMaterial {
     offsetY: number;
 }
 /** Material properties for the default DistanceFieldVector pipeline */
-export declare class DistanceFieldVectorMaterial {
+export declare class DistanceFieldVectorMaterial extends Access {
     color: number[];
     outlineColor: number[];
     outlineRange: number[];
@@ -341,13 +366,13 @@ export declare class DistanceFieldVectorMaterial {
     smoothness: number;
 }
 /** Material properties for the default Text pipeline */
-export declare class TextMaterial {
+export declare class TextMaterial extends Access {
     color: number[];
     effectColor: number[];
     font: FontReference;
 }
 /** Material properties for the default Sky pipeline */
-export declare class SkyMaterial {
+export declare class SkyMaterial extends Access {
     colorStop0: number[];
     colorStop1: number[];
     colorStop2: number[];
@@ -355,7 +380,7 @@ export declare class SkyMaterial {
     texture: TextureReference;
 }
 /** Material properties for the default Background pipeline */
-export declare class BackgroundMaterial {
+export declare class BackgroundMaterial extends Access {
     colorStop0: number[];
     colorStop1: number[];
     colorStop2: number[];
@@ -363,7 +388,7 @@ export declare class BackgroundMaterial {
     texture: TextureReference;
 }
 /** Material properties for the default Particle pipeline */
-export declare class MaterialResource {
+export declare class MaterialResource extends Resource {
     pipeline: PipelineReference;
     name: string;
     Phong?: PhongMaterial;
@@ -387,8 +412,8 @@ export declare enum RootMotionMode {
     ApplyToOwner = "applyToOwner",
     ScriptEvent = "scriptEvent"
 }
-/** 'animation' component configuration */
-export declare class AnimationComponent {
+/** 'animation' component */
+export declare class AnimationComponent extends Access {
     preview: boolean;
     retarget: boolean;
     autoplay: boolean;
@@ -413,8 +438,8 @@ export declare enum LightType {
     /** Sun light type */
     Sun = "sun"
 }
-/** 'light' component configuration */
-export declare class LightComponent {
+/** 'light' component */
+export declare class LightComponent extends Access {
     type: LightType;
     color: number[];
     intensity: number;
@@ -434,34 +459,34 @@ export declare enum ProjectionType {
     /** Orthographic projection */
     Orthographic = "orthographic"
 }
-/** 'view' component configuration */
-export declare class ViewComponent {
+/** 'view' component */
+export declare class ViewComponent extends Access {
     projectionType: ProjectionType;
     fov: number;
     extent: number;
     near: number;
     far: number;
 }
-/** Settings for a sphere physics shape */
-export declare class PhysXSphereConfig {
+/** Sphere physics shape */
+export declare class PhysXSphere extends Access {
     radius: number;
 }
-/** Settings for a box physics shape */
-export declare class PhysXBoxConfig {
+/** Box physics shape */
+export declare class PhysXBox extends Access {
     extents: number[];
 }
-/** Settings for a capsule physics shape */
-export declare class PhysXCapsuleConfig {
+/** Capsule physics shape */
+export declare class PhysXCapsule extends Access {
     radius: number;
     halfHeight: number;
 }
-/** Settings for a triangle mesh physics shape */
-export declare class PhysXTriangleMeshConfig {
+/** Triangle mesh physics shape */
+export declare class PhysXTriangleMesh extends Access {
     mesh: MeshReference;
     scaling: number[];
 }
-/** Settings for a convex mesh physics shape */
-export declare class PhysXConvexMeshConfig {
+/** Convex mesh physics shape */
+export declare class PhysXConvexMesh extends Access {
     mesh: MeshReference;
     scaling: number[];
 }
@@ -473,8 +498,8 @@ export declare enum PhysXShapeType {
     TriangleMesh = "triangleMesh",
     ConvexMesh = "convexMesh"
 }
-/** 'physx' component configuration */
-export declare class PhysXComponent {
+/** 'physx' component */
+export declare class PhysXComponent extends Access {
     static: boolean;
     kinematic: boolean;
     simulate: boolean;
@@ -482,11 +507,11 @@ export declare class PhysXComponent {
     allowSimulation: boolean;
     mass: number;
     shape: PhysXShapeType;
-    sphere?: PhysXSphereConfig;
-    box?: PhysXBoxConfig;
-    capsule?: PhysXCapsuleConfig;
-    triangleMesh?: PhysXTriangleMeshConfig;
-    convexMesh?: PhysXConvexMeshConfig;
+    sphere?: PhysXSphere;
+    box?: PhysXBox;
+    capsule?: PhysXCapsule;
+    triangleMesh?: PhysXTriangleMesh;
+    convexMesh?: PhysXConvexMesh;
     linearDamping: number;
     angularDamping: number;
     staticFriction: number;
@@ -503,8 +528,8 @@ export declare class PhysXComponent {
     solverPositionIterations: number;
     solverVelocityIterations: number;
 }
-/** 'mesh' component configuration */
-export declare class MeshComponent {
+/** 'mesh' component */
+export declare class MeshComponent extends Access {
     material: MaterialReference;
     mesh: MeshReference;
     skin: SkinReference;
@@ -523,8 +548,8 @@ export declare enum TextWrapMode {
     Hard = "hard",
     Clip = "clip"
 }
-/** 'text' component configuration */
-export declare class TextComponent {
+/** 'text' component */
+export declare class TextComponent extends Access {
     alignment: string;
     verticalAlignment: string;
     characterSpacing: number;
@@ -535,24 +560,24 @@ export declare class TextComponent {
     wrapMode: TextWrapMode;
     wrapWidth: number;
 }
-/** Settings for a sphere collider */
-export declare class SphereConfig {
+/** Sphere collider */
+export declare class Sphere extends Access {
     radius: number;
 }
-/** Settings for a AxisAlignedBoundingBox collider */
-export declare class AABBConfig {
+/** AxisAlignedBoundingBox collider */
+export declare class AABB extends Access {
     extents: number[];
 }
-/** Settings for a box collider */
-export declare class BoxConfig {
+/** Box collider */
+export declare class Box extends Access {
     extents: number[];
 }
-/** 'collision' component configuration */
-export declare class CollisionComponent {
+/** 'collision' component */
+export declare class CollisionComponent extends Access {
     collider: 'sphere' | 'aabb' | 'box';
-    sphere?: SphereConfig;
-    aabb?: AABBConfig;
-    box?: BoxConfig;
+    sphere?: Sphere;
+    aabb?: AABB;
+    box?: Box;
     groups: number;
 }
 /** Input type enum */
@@ -565,21 +590,21 @@ export declare enum InputType {
     RayLeft = "ray left",
     RayRight = "ray right"
 }
-/** 'input' component configuration */
-export declare class InputComponent {
+/** 'input' component */
+export declare class InputComponent extends Access {
     type: InputType;
 }
-export declare class AnimationEvent {
+export declare class AnimationEvent extends Access {
     time: number;
     name: string;
 }
-export declare class RootMotion {
+export declare class RootMotion extends Access {
     target: ObjectReference;
     translationAxis: number;
     rotationAxis: number;
 }
 /** Animation resource */
-export declare class AnimationResource {
+export declare class AnimationResource extends Resource {
     /** Name of the animation */
     name: string;
     /** Whether to compress the animation */
@@ -590,31 +615,31 @@ export declare class AnimationResource {
     events: AnimationEvent[];
     rootMotion?: RootMotion;
 }
-/** Component configuration */
-export declare class ComponentConfig {
+/** Component */
+export declare class ObjectComponent extends Access {
     /** Component type */
     type: string | null;
     /** Whether the component is active */
     active: boolean;
-    /** Configuration for animation components */
+    /** Animation component */
     animation?: AnimationComponent;
-    /** Configuration for collision components */
+    /** Collision component */
     collision?: CollisionComponent;
-    /** Configuration for input components */
+    /** Input component */
     input?: InputComponent;
-    /** Configuration for light components */
+    /** Light component */
     light?: LightComponent;
-    /** Configuration for mesh components */
+    /** Mesh component */
     mesh?: MeshComponent;
-    /** Configuration for physx components */
+    /** Physx component */
     physx?: PhysXComponent;
-    /** Configuration for text components */
+    /** Text component */
     text?: TextComponent;
-    /** Configuration for view components */
+    /** View component */
     view?: ViewComponent;
 }
 /** Object resource */
-export declare class ObjectResource {
+export declare class ObjectResource extends Resource {
     /** Name of the object */
     name: string;
     /** Translation vector */
@@ -628,10 +653,10 @@ export declare class ObjectResource {
     /** Skin this object is part of, or `null`, if not a joint. */
     skin: SkinReference;
     /** List of components on this object */
-    components: ComponentConfig[];
+    components: ObjectComponent[];
 }
 /** Skin resource */
-export declare class SkinResource {
+export declare class SkinResource extends Resource {
     /** Name of the skin */
     name: string;
     /** List of objects that make up the joints of this skin */
@@ -678,7 +703,7 @@ export declare enum MeshSorting {
     MeshIndex = "mesh-index"
 }
 /** Pipeline resource */
-export declare class PipelineResource {
+export declare class PipelineResource extends Resource {
     name: string;
     doubleSided: boolean;
     castShadows: boolean;
@@ -701,7 +726,7 @@ export declare class PipelineResource {
     depthFunction: DepthFunction;
 }
 /** Font resource */
-export declare class FontResource {
+export declare class FontResource extends Resource {
     /** Name of the font */
     name: string;
     /** Which characters need to be renderable with this font */
@@ -712,18 +737,21 @@ export declare class FontResource {
     outlineSize: number;
 }
 /** Language resource */
-export declare class LanguageResource {
+export declare class LanguageResource extends Resource {
     /** Name of the language */
     name: string;
     /** Whether this is the default language */
     isDefault: boolean;
 }
 /** File resource */
-export declare class FileResource {
+export declare class FileResource extends Resource {
     fileName: string;
     importerName: string;
     importPhysicalAsPhongMaterials: boolean;
 }
+export declare class ResourceSection<T> {
+    [key: string]: T;
+}
 /**
  * Access to Wonderland Editor's data.
  *
@@ -741,32 +769,31 @@ export declare class FileResource {
  *    WL.data.objects[123].components[0].text.text
  * ```
  */
-export declare class EditorData {
+export interface EditorData {
     /** Project settings */
     settings: Settings;
     /** List of scene file paths */
-    files: FileResource[];
+    files: ResourceSection<FileResource>;
     /** Animation resources */
-    animations: AnimationResource[];
+    animations: ResourceSection<AnimationResource>;
     /** Object resources */
-    objects: ObjectResource[];
+    objects: ResourceSection<ObjectResource>;
     /** Skin resources */
-    skins: SkinResource[];
+    skins: ResourceSection<SkinResource>;
     /** Image resources */
-    images: ImageResource[];
+    images: ResourceSection<ImageResource>;
     /** Shader resources */
-    shaders: ShaderResource[];
+    shaders: ResourceSection<ShaderResource>;
     /** Mesh resources */
-    meshes: MeshResource[];
+    meshes: ResourceSection<MeshResource>;
     /** Texture resources */
-    textures: TextureResource[];
+    textures: ResourceSection<TextureResource>;
     /** Material resources */
-    materials: MaterialResource[];
+    materials: ResourceSection<MaterialResource>;
     /** Font resources */
-    fonts: FontResource[];
+    fonts: ResourceSection<FontResource>;
     /** Pipeline resources */
-    pipelines: PipelineResource[];
+    pipelines: ResourceSection<PipelineResource>;
     /** Language resources */
-    languages: LanguageResource[];
+    languages: ResourceSection<LanguageResource>;
 }
-export declare let data: EditorData;