@wonderlandengine/editor-api 1.2.0-dev.0

package/README.md

@@ -0,0 +1,24 @@
+# Wonderland Editor JavaScript Plugin API
+
+(Experimental!) API to extend the Wonderland Editor with JavaScript or TypeScript.
+
+**Note:** This package requires the upcoming 1.2.0 version of Wonderland Engine.
+
+Learn more about Wonderland Engine in the [documentation](https://wonderlandengine.com/editor/plugins/).
+
+# How to use
+
+Create a new plugin project:
+```sh
+npm init
+```
+
+Add a "wonderlandengine" key in your `package.json`. Now install the API:
+
+```sh
+npm i --save @wonderlandengine/editor-api
+```
+
+And create your first plugin!
+
+That plugin can be used in any Wonderland Engine project by [installing the directory](https://wonderlandengine.com/editor/plugins#development).

package/dist/data.d.ts

@@ -0,0 +1,671 @@
+/** Object reference */
+export type ObjectReference = string | null;
+/** Mesh reference */
+export type MeshReference = string | null;
+/** Texture reference */
+export type TextureReference = string | null;
+/** Shader reference */
+export type ShaderReference = string | null;
+/** Font reference */
+export type FontReference = string | null;
+/** Pipeline reference */
+export type PipelineReference = string | null;
+/** Material reference */
+export type MaterialReference = string | null;
+/** Skin reference */
+export type SkinReference = string | null;
+/** Image reference */
+export type ImageReference = string | null;
+/** Animation reference */
+export type AnimationReference = string | null;
+/** Project settings */
+export declare class ProjectSettings {
+    name: string;
+    customIndexHtml: boolean;
+    extraFilesFolder: string;
+    packageForStreaming: boolean;
+}
+/** Sky settings */
+export declare class SkySettings {
+    enabled: boolean;
+    material: MaterialReference;
+}
+/** Bloom settings */
+export declare class BloomSettings {
+    enabled: boolean;
+    kernelSize: number;
+    passes: number;
+    threshold: number;
+    intensity: number;
+}
+/** HDR settings */
+export declare class HdrSettings {
+    exposure: number;
+}
+/** Texture streaming settings */
+export declare class TextureStreamingSettings {
+    maxCacheSize: number;
+    maxUploadPerFrame: number;
+}
+/** Rendering settings */
+export declare class RenderingSettings {
+    textureAtlasSize: number[];
+    compressedTextureAtlasSize: number[];
+    clearColor: number[];
+    maxShadows: number;
+    usePreZ: boolean;
+    useMultiDraw: boolean;
+    useFrustumCulling: boolean;
+    sky: SkySettings;
+    bloom: BloomSettings;
+    hdr: HdrSettings;
+    textureStreaming: TextureStreamingSettings;
+}
+/** Camera settings */
+export declare class CameraSettings {
+    near: number;
+    far: number;
+}
+/** Editor settings */
+export declare class EditorSettings {
+    serverPort: number;
+    serverCOEP: string;
+    camera: CameraSettings;
+    ids: string;
+}
+/** Plugins settings */
+export declare class PluginsSettings {
+}
+/** WebXR feature flags */
+export interface WebXRFeatureFlags {
+    local: boolean;
+    'local-floor': boolean;
+    'bounded-floor': boolean;
+    unbounded: boolean;
+    'hand-tracking': boolean;
+    'hit-test': boolean;
+    'plane-detection': boolean;
+    'light-estimation': boolean;
+    anchors: boolean;
+    occlusion: boolean;
+    'marker-tracking': boolean;
+    extraFeatures: string;
+}
+/** WebXR settings */
+export declare class WebXRSettings {
+    optionalFeatures: WebXRFeatureFlags;
+    requiredFeatures: WebXRFeatureFlags;
+}
+/** PWA settings */
+export declare class PWASettings {
+    enable: boolean;
+    customServiceWorker: boolean;
+    customManifest: boolean;
+    display: 'fullscreen' | 'standalone' | 'minimal-ui' | 'browser';
+    ovrPackageName: string;
+    appIcon: ImageReference;
+}
+/** Runtime settings */
+export declare class RuntimeSettings {
+    visualizeColliders: boolean;
+    visualizePhysX: boolean;
+    visualizeOverdraw: boolean;
+    googleAnalytics: string;
+    googleAnalyticsSecondary: string;
+    enableRuntimeGltf: boolean;
+    viewObject: ObjectReference;
+    webxr: WebXRSettings;
+    xrButtonColor: string;
+    pwa: PWASettings;
+}
+/** Bundling type enum */
+export declare enum BundlingType {
+    None = "none",
+    Esbuild = "esbuild",
+    Npm = "npm"
+}
+/** Scripting settings */
+export declare class ScriptingSettings {
+    sourcePaths: never[];
+    libraryPaths: never[];
+    bundlingType: BundlingType;
+    npmScript: string;
+    esbuildFlags: string;
+    entryPoint: string;
+}
+/** VR settings */
+export declare class VRSettings {
+    enable: boolean;
+    rightEyeObject: ObjectReference;
+    leftEyeObject: ObjectReference;
+    framebufferScaleFactor: number;
+}
+/** Physics settings */
+export declare class PhysXSettings {
+    enable: boolean;
+    maxTimestep: number;
+    contactOffset: number;
+    restOffset: number;
+    groupNames: {
+        '0': string;
+        '1': string;
+        '2': string;
+        '3': string;
+        '4': string;
+        '5': string;
+        '6': string;
+        '7': string;
+    };
+    gravity: number[];
+    lengthToleranceScale: number;
+    speedToleranceScale: number;
+}
+/** AR settings */
+export declare class ARSettings {
+    enable: boolean;
+}
+/** Localization settings */
+export declare class LocalizationSettings {
+    enableZipCompression: boolean;
+    format: 'i18next';
+    languagesFolder: string;
+    defaultLanguage: string;
+}
+/** Settings for the currently open project */
+export declare class Settings {
+    project: ProjectSettings;
+    rendering: RenderingSettings;
+    editor: EditorSettings;
+    runtime: RuntimeSettings;
+    scripting: ScriptingSettings;
+    plugins: PluginsSettings;
+    vr: VRSettings;
+    ar: ARSettings;
+    physx: PhysXSettings;
+    localization: LocalizationSettings;
+}
+/** Image compression type */
+export declare enum ImageCompressionType {
+    None = "etc1s",
+    ETC1s = "etc1s",
+    UASTC = "uastc"
+}
+/** Image resource */
+export declare class ImageResource {
+    name: string;
+    maxSize: number[];
+    compression: ImageCompressionType;
+    stream: boolean;
+    isProbe: boolean;
+    isSpecularProbe: boolean;
+}
+/** Texture resource */
+export declare class TextureResource {
+    name: string;
+    image: ImageReference;
+    type: number;
+    minFilter: number;
+    magFilter: number;
+    mipFilter: number;
+    wrapping: number[];
+}
+/** Shader stage enum */
+export declare enum ShaderStage {
+    Fragment = "fragment",
+    Vertex = "vertex"
+}
+/** Shader type enum */
+export declare enum ShaderType {
+    Forward = "forward",
+    Fullscreen = "fullscreen"
+}
+/** Shader resource */
+export declare class ShaderResource {
+    name: string;
+    stage: ShaderStage;
+    type: ShaderType;
+    packageUnused: boolean;
+}
+/** Mesh resource */
+export declare class MeshResource {
+    name: string;
+    simplify: boolean;
+    simplifyTarget: number;
+    simplifyTargetError: number;
+    importScaling: number;
+}
+/** Material properties for the default Phong pipeline */
+export declare class PhongMaterial {
+    ambientColor: number[];
+    diffuseTexture: TextureReference;
+    diffuseColor: number[];
+    specularColor: number[];
+    emissiveTexture: TextureReference;
+    emissiveColor: number[];
+    fogColor: number[];
+    normalTexture: TextureReference;
+    lightmapTexture: TextureReference;
+    lightmapFactor: number;
+    shininess: number;
+    alphaMaskThreshold: number;
+    alphaMaskTexture: TextureReference;
+}
+/** Material properties for the default Phong pipeline */
+export declare class PhysicalMaterial {
+    albedoColor: number[];
+    emissiveTexture: TextureReference;
+    emissiveColor: number[];
+    albedoTexture: TextureReference;
+    metallicFactor: number;
+    roughnessFactor: number;
+    roughnessMetallicTexture: TextureReference;
+    specularProbeTexture: TextureReference;
+    irradianceProbeTexture: TextureReference;
+    normalTexture: TextureReference;
+    occlusionTexture: TextureReference;
+    occlusionFactor: number;
+    alphaMaskThreshold: number;
+    alphaMaskTexture: TextureReference;
+}
+/** Material properties for the default MeshVisualizer pipeline */
+export declare class MeshVisualizerMaterial {
+    color: number[];
+    wireframeColor: number[];
+}
+/** Material properties for the default Flat pipeline */
+export declare class FlatMaterial {
+    color: number[];
+    flatTexture: TextureReference;
+    alphaMaskThreshold: number;
+    alphaMaskTexture: TextureReference;
+}
+/** Material properties for the default Particle pipeline */
+export declare class ParticleMaterial {
+    color: number[];
+    mainTexture: TextureReference;
+    noiseTexture: TextureReference;
+    offsetX: number;
+    offsetY: number;
+}
+/** Material properties for the default DistanceFieldVector pipeline */
+export declare class DistanceFieldVectorMaterial {
+    color: number[];
+    outlineColor: number[];
+    outlineRange: number[];
+    vectorTexture: TextureReference;
+    smoothness: number;
+}
+/** Material properties for the default Text pipeline */
+export declare class TextMaterial {
+    color: number[];
+    effectColor: number[];
+    font: FontReference;
+}
+/** Material properties for the default Sky pipeline */
+export declare class SkyMaterial {
+    colorStop0: number[];
+    colorStop1: number[];
+    colorStop2: number[];
+    colorStop3: number[];
+    texture: TextureReference;
+}
+/** Material properties for the default Background pipeline */
+export declare class BackgroundMaterial {
+    colorStop0: number[];
+    colorStop1: number[];
+    colorStop2: number[];
+    colorStop3: number[];
+    texture: TextureReference;
+}
+/** Material properties for the default Particle pipeline */
+export declare class MaterialResource {
+    pipeline: PipelineReference;
+    name: string;
+    Phong?: PhongMaterial;
+    Physical?: PhysicalMaterial;
+    MeshVisualizer?: MeshVisualizerMaterial;
+    Flat?: FlatMaterial;
+    Particle?: ParticleMaterial;
+    DistanceFieldVector?: DistanceFieldVectorMaterial;
+    Text?: TextMaterial;
+    Sky?: SkyMaterial;
+    Background?: BackgroundMaterial;
+}
+/** 'animation' component configuration */
+export declare class AnimationComponent {
+    preview: boolean;
+    retarget: boolean;
+    autoplay: boolean;
+    playCount: number;
+    speed: number;
+    skin: SkinReference;
+    animation: AnimationReference;
+}
+/** Light type enum */
+export declare enum LightType {
+    /** Point light type */
+    Point = "point",
+    /** Spot light type */
+    Spot = "spot",
+    /** Sun light type */
+    Sun = "sun"
+}
+/** 'light' component configuration */
+export declare class LightComponent {
+    type: LightType;
+    color: number[];
+    intensity: number;
+    shadowRange: number;
+    outerAngle: number;
+    innerAngle: number;
+    shadows: boolean;
+    shadowBias: number;
+    shadowNormalBias: number;
+    shadowTexelSize: number;
+    cascadeCount: number;
+}
+/** 'view' component configuration */
+export declare class ViewComponent {
+    fov: number;
+    near: number;
+    far: number;
+}
+/** Settings for a sphere physics shape */
+export declare class PhysXSphereConfig {
+    radius: number;
+}
+/** Settings for a box physics shape */
+export declare class PhysXBoxConfig {
+    extents: number[];
+}
+/** Settings for a capsule physics shape */
+export declare class PhysXCapsuleConfig {
+    radius: number;
+    halfHeight: number;
+}
+/** Settings for a triangle mesh physics shape */
+export declare class PhysXTriangleMeshConfig {
+    mesh: MeshReference;
+    scaling: number[];
+}
+/** Settings for a convex mesh physics shape */
+export declare class PhysXConvexMeshConfig {
+    mesh: MeshReference;
+    scaling: number[];
+}
+/** Physics shape type enum */
+export declare enum PhysXShapeType {
+    Sphere = "sphere",
+    Box = "box",
+    Capsule = "capsule",
+    TriangleMesh = "triangleMesh",
+    ConvexMesh = "convexMesh"
+}
+/** 'physx' component configuration */
+export declare class PhysXComponent {
+    static: boolean;
+    kinematic: boolean;
+    simulate: boolean;
+    allowQuery: boolean;
+    allowSimulation: boolean;
+    mass: number;
+    shape: PhysXShapeType;
+    sphere?: PhysXSphereConfig;
+    box?: PhysXBoxConfig;
+    capsule?: PhysXCapsuleConfig;
+    triangleMesh?: PhysXTriangleMeshConfig;
+    convexMesh?: PhysXConvexMeshConfig;
+    linearDamping: number;
+    angularDamping: number;
+    staticFriction: number;
+    dynamicFriction: number;
+    bounciness: number;
+    gravity: boolean;
+    trigger: boolean;
+    block: number;
+    groups: number;
+    lockAxis: number;
+    sleepOnActivate: boolean;
+    translationOffset: number[];
+    rotationOffset: number[];
+    solverPositionIterations: number;
+    solverVelocityIterations: number;
+}
+/** 'mesh' component configuration */
+export declare class MeshComponent {
+    material: MaterialReference;
+    mesh: MeshReference;
+    skin: SkinReference;
+}
+/** Text effect type enum */
+export declare enum TextEffectType {
+    None = "none",
+    Outline = "outline"
+}
+/** 'text' component configuration */
+export declare class TextComponent {
+    alignment: string;
+    justification: string;
+    characterSpacing: number;
+    lineSpacing: number;
+    effect: TextEffectType;
+    text: string;
+    material: MaterialReference;
+}
+/** Settings for a sphere collider */
+export declare class SphereConfig {
+    radius: number;
+}
+/** Settings for a AxisAlignedBoundingBox collider */
+export declare class AABBConfig {
+    extents: number[];
+}
+/** Settings for a box collider */
+export declare class BoxConfig {
+    extents: number[];
+}
+/** 'collision' component configuration */
+export declare class CollisionComponent {
+    collider: 'sphere' | 'aabb' | 'box';
+    sphere?: SphereConfig;
+    aabb?: AABBConfig;
+    box?: BoxConfig;
+    groups: number;
+}
+/** Input type enum */
+export declare enum InputType {
+    Head = "head",
+    EyeLeft = "eye left",
+    EyeRight = "eye right",
+    HandLeft = "hand left",
+    HandRight = "hand right",
+    RayLeft = "ray left",
+    RayRight = "ray right"
+}
+/** 'input' component configuration */
+export declare class InputComponent {
+    type: InputType;
+}
+export declare class AnimationEvent {
+    time: number;
+    name: string;
+}
+/** Animation resource */
+export declare class AnimationResource {
+    /** Name of the animation */
+    name: string;
+    /** Whether to compress the animation */
+    pack: boolean;
+    /** Targets influenced per track */
+    targets: ObjectReference[];
+    /** Animation events track */
+    events: AnimationEvent[];
+}
+/** Component configuration */
+export declare class ComponentConfig {
+    /** Component type */
+    type: string | null;
+    /** Whether the component is active */
+    active: boolean;
+    /** Configuration for animation components */
+    animation?: AnimationComponent;
+    /** Configuration for collision components */
+    collision?: CollisionComponent;
+    /** Configuration for input components */
+    input?: InputComponent;
+    /** Configuration for light components */
+    light?: LightComponent;
+    /** Configuration for mesh components */
+    mesh?: MeshComponent;
+    /** Configuration for physx components */
+    physx?: PhysXComponent;
+    /** Configuration for text components */
+    text?: TextComponent;
+    /** Configuration for view components */
+    view?: ViewComponent;
+}
+/** Object resource */
+export declare class ObjectResource {
+    /** Name of the object */
+    name: string;
+    /** Translation vector */
+    translation: number[];
+    /** Rotation quaternion */
+    rotation: number[];
+    /** Scaling vector */
+    scaling: number[];
+    /** Parent object, or null if parent is root */
+    parent: ObjectReference;
+    /** Skin this object is part of, or `null`, if not a joint. */
+    skin: SkinReference;
+    /** List of components on this object */
+    components: ComponentConfig[];
+}
+/** Skin resource */
+export declare class SkinResource {
+    /** Name of the skin */
+    name: string;
+    /** List of objects that make up the joints of this skin */
+    joints: ObjectReference[];
+}
+/** Blend function enum for {@link PipelineResource} */
+export declare enum BlendFunction {
+    Zero = "zero",
+    One = "one",
+    SourceColor = "source color",
+    OnceMinusSourceColor = "one minus source color",
+    SourceAlpha = "source alpha",
+    SourceAlphaSaturate = "source alpha saturate",
+    OneMinusSourceAlpha = "one minus source alpha",
+    DestinationColor = "destination color",
+    OneMinusDestinationColor = "one minus destination color",
+    DestinationAlpha = "destination alpha",
+    OneMinusDestinationAlpha = "one minus destination alpha"
+}
+/** Blend equation enum for {@link PipelineResource} */
+export declare enum BlendEquation {
+    Add = "add",
+    Subtract = "subtract",
+    ReverseSubtract = "reverse subtract",
+    Min = "min",
+    Max = "max"
+}
+/** Depth function enum for {@link PipelineResource} */
+export declare enum DepthFunction {
+    Never = "never",
+    Always = "always",
+    Less = "less",
+    LessOrEqual = "less or equal",
+    Equal = "equal",
+    NotEqual = "not equal",
+    GreaterOrEqual = "greater or equal",
+    Greater = "greater"
+}
+/** Pipeline resource */
+export declare class PipelineResource {
+    name: string;
+    doubleSided: boolean;
+    castShadows: boolean;
+    depthTest: boolean;
+    depthWrite: boolean;
+    blending: boolean;
+    sampleAlphaToCoverage: boolean;
+    shader: ShaderReference;
+    viewVertexShader: ShaderReference;
+    features: {
+        [key: string]: boolean;
+    };
+    blendSrcRgb: BlendFunction;
+    blendSrcAlpha: BlendFunction;
+    blendDestRgb: BlendFunction;
+    blendDestAlpha: BlendFunction;
+    blendEqRgb: BlendEquation;
+    blendEqAlpha: BlendEquation;
+    depthFunction: DepthFunction;
+}
+/** Font resource */
+export declare class FontResource {
+    /** Name of the font */
+    name: string;
+    /** Which characters need to be renderable with this font */
+    characters: string;
+    /** Whether to support the "outline" effect with this font */
+    outline: boolean;
+    /** Size of the outline */
+    outlineSize: number;
+}
+/** Language resource */
+export declare class LanguageResource {
+    /** Name of the language */
+    name: string;
+    /** Custom terms */
+    strings: {
+        [key: string]: string;
+    };
+}
+/**
+ * @brief 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 declare class EditorData {
+    /** Project settings */
+    settings: Settings;
+    /** List of scene file paths */
+    files: string[];
+    /** Animation resources */
+    animations: AnimationResource[];
+    /** Object resources */
+    objects: ObjectResource[];
+    /** Skin resources */
+    skins: SkinResource[];
+    /** Image resources */
+    images: ImageResource[];
+    /** Shader resources */
+    shaders: ShaderResource[];
+    /** Mesh resources */
+    meshes: MeshResource[];
+    /** Texture resources */
+    textures: TextureResource[];
+    /** Material resources */
+    materials: MaterialResource[];
+    /** Font resources */
+    fonts: FontResource[];
+    /** Pipeline resources */
+    pipelines: PipelineResource[];
+    /** Language resources */
+    languages: LanguageResource[];
+}
+export declare let data: EditorData;