WL

• WL
  • Alignment: enum
  • AnimationState: enum
  • CBORType: enum
  • Collider: enum
  • CollisionEventType: enum
  • ForceMode: enum
  • InputType: enum
  • LightType: enum
  • LockAxis: enum
  • LogLevel: enum
  • LogTag: enum
  • MaterialParamType: enum
  • MeshAttribute: enum
  • MeshIndexType: enum
  • MeshSkinningType: enum
  • ProjectionType: enum
  • RootMotionMode: enum
  • Shape: enum
  • TextEffect: enum
  • TextWrapMode: enum
  • Type: enum
  • VerticalAlignment: enum
  • .APIVersion: Version
  • .DestroyedComponentInstance: { _ }
  • .DestroyedObjectInstance: { _ }
  • .DestroyedPrefabInstance: { _ }
  • .Justification: typeof VerticalAlignment
  • .Property: { (opts: PropertyReferenceOptions) ⇒ ComponentProperty; (defaultValue: boolean) ⇒ ComponentProperty; (r: number, g: number, b: number, a: number) ⇒ ComponentProperty; (values: string[], defaultValue: string | number) ⇒ ComponentProperty; (defaultValue: number) ⇒ ComponentProperty; (defaultValue: number) ⇒ ComponentProperty; (opts: PropertyReferenceOptions) ⇒ ComponentProperty; (opts: PropertyReferenceOptions) ⇒ ComponentProperty; (opts: PropertyReferenceOptions) ⇒ ComponentProperty; (opts: PropertyReferenceOptions) ⇒ ComponentProperty; (defaultValue: string) ⇒ ComponentProperty; (opts: PropertyReferenceOptions) ⇒ ComponentProperty; (x: number, y: number) ⇒ ComponentProperty; (x: number, y: number, z: number) ⇒ ComponentProperty; (x: number, y: number, z: number, w: number) ⇒ ComponentProperty; }
  • .defaultPropertyCloner: DefaultPropertyCloner
  • .capitalizeFirstUTF8(str) ⇒ string
  • .checkRuntimeCompatibility(version) ⇒ void
  • .clamp(val, min, max) ⇒ number
  • .createDestroyedProxy(type) ⇒ { _ }
  • .decode<T>(data, tagger, options) ⇒ T
  • .fetchStreamWithProgress(path, onProgress, signal) ⇒ Promise<ReadableStream<Uint8Array>>
  • .fetchWithProgress(path, onProgress, signal) ⇒ Promise<ArrayBuffer>
  • .getBaseUrl(url) ⇒ string
  • .getFilename(url) ⇒ string
  • .getType(typeInfo) ⇒ CBORType
  • .isImageLike(value) ⇒ value is ImageLike
  • .isNumber(value) ⇒ value is number
  • .isString(value) ⇒ value is string
  • .isUndefined(type, length) ⇒ boolean
  • .loadRuntime(runtime, options) ⇒ Promise<WonderlandEngine>
  • .onImageReady<T>(image) ⇒ Promise<T>
  • .timeout(time) ⇒ Promise<void>

.Alignment: enum 

Alignment type enum for TextComponent.

Properties

.AnimationState: enum 

Animation state of AnimationComponent.

Properties

.CBORType: enum 

Properties

.Collider: enum 

Collider type enum for CollisionComponent.

Properties

.CollisionEventType: enum 

Collision callback event type.

Properties

.ForceMode: enum 

Rigid body force mode for addForce and addTorque.

PhysX API Reference

Properties

.InputType: enum 

Input type enum for InputComponent.

Properties

.LightType: enum 

Light type enum for LightComponent.

Properties

.LockAxis: enum 

Enum for Physics axes locking

See angularLockAxis and linearLockAxis.

Properties

.LogLevel: enum 

Logging levels supported by Logger.

Properties

.LogTag: enum 

Default set of logging tags used by the API.

Properties

.MaterialParamType: enum 

Material parameter type.

Properties

.MeshAttribute: enum 

Mesh attribute enum.

Properties

.MeshIndexType: enum 

Mesh index type.

Properties

.MeshSkinningType: enum 

Mesh skinning type.

Properties

.ProjectionType: enum 

Projection type enum for ViewComponent.

Properties

.RootMotionMode: enum 

Root motion mode of AnimationComponent.

Properties

.Shape: enum 

Rigid body shape.

PhysX SDK Guide.

Properties

.TextEffect: enum 

Effect type enum for TextComponent.

Properties

.TextWrapMode: enum 

Wrap mode enum for TextComponent.

Properties

.Type: enum 

Component property type.

Properties

.VerticalAlignment: enum 

Vertical alignment type enum for TextComponent.

Properties

.APIVersion: Version 

Version of this API.

.DestroyedComponentInstance: { _ } 

Proxy used to override prototypes of destroyed components.

.DestroyedObjectInstance: { _ } 

Proxy used to override prototypes of destroyed objects.

.DestroyedPrefabInstance: { _ } 

Proxy used to override prototypes of destroyed prefabs.

.Justification: typeof VerticalAlignment 

Justification type enum for TextComponent.

Deprecated: Please use VerticalAlignment instead.

.Property: { (opts: PropertyReferenceOptions) ⇒ ComponentProperty; (defaultValue: boolean) ⇒ ComponentProperty; (r: number, g: number, b: number, a: number) ⇒ ComponentProperty; (values: string[], defaultValue: string | number) ⇒ ComponentProperty; (defaultValue: number) ⇒ ComponentProperty; (defaultValue: number) ⇒ ComponentProperty; (opts: PropertyReferenceOptions) ⇒ ComponentProperty; (opts: PropertyReferenceOptions) ⇒ ComponentProperty; (opts: PropertyReferenceOptions) ⇒ ComponentProperty; (opts: PropertyReferenceOptions) ⇒ ComponentProperty; (defaultValue: string) ⇒ ComponentProperty; (opts: PropertyReferenceOptions) ⇒ ComponentProperty; (x: number, y: number) ⇒ ComponentProperty; (x: number, y: number, z: number) ⇒ ComponentProperty; (x: number, y: number, z: number, w: number) ⇒ ComponentProperty; } 

Component property namespace.

Usage:

 1import {Component, Property} from '@wonderlandengine/api';
 2
 3class MyComponent extends Component {
 4    static Properties = {
 5        myBool: Property.bool(true),
 6        myInt: Property.int(42),
 7        myString: Property.string('Hello World!'),
 8        myMesh: Property.mesh(),
 9    }
10}

For TypeScript users, you can use the decorators instead.

.defaultPropertyCloner: DefaultPropertyCloner 

Default cloner for property values.

.capitalizeFirstUTF8(str: string) ⇒ string 

Capitalize the first letter in a string.

Note: The string must be UTF-8.

Returns: The string with the first letter capitalized.

.checkRuntimeCompatibility(version: Version) ⇒ void 

Ensures that this API is compatible with the given runtime version.

We only enforce compatibility for major and minor components, i.e., the runtime and the API must both be of the form x.y.*.

Throws: If the major or the minor components are different.

.clamp(val: number, min: number, max: number) ⇒ number 

Clamp the value in the range [min; max].

Returns: The clamped value.

.createDestroyedProxy(type: string) ⇒ { _ } 

Create a proxy throwing destroyed errors upon access.

Returns: The proxy instance

.decode<T>(data: Uint8Array, tagger: Tagger, options: Options) ⇒ T 

Converts a Concise Binary Object Representation (CBOR) buffer into an object.

1const buffer = new Uint8Array([0xa2, 0x01, 0x02, 0x03, 0x04]).buffer;
2const decoded = decode(buffer);
3console.log(decoded); // { "1": 2, "3": 4 }

CBOR values can be wrapped in a numeric tag. To handle and possibly transform tagged values, pass a tagger function:

 1const buffer = new Uint8Array([
 2  0xa1, 0x63, 0x75, 0x72, 0x6c, 0xd8, 0x20, 0x70,
 3  0x68, 0x74, 0x74, 0x70, 0x3a, 0x2f, 0x2f, 0x73,
 4  0x69, 0x74, 0x65, 0x2e, 0x63, 0x6f, 0x6d, 0x2f
 5]);
 6const decoded = decode(buffer, (tag, value) => {
 7    if (tag === 32) return new URL(value);
 8    return value;
 9});
10console.log(decoded); // { url: URL { href: "http://site.com/" } }

Decoded basic types generally match the equivalent JavaScript types. Byte strings are decoded to Uint8Array.

Tagged values are left as-is, with the following exceptions:

• Bignum values (byte strings with tag 2 or 3) are decoded to BigInt
• Little-endian versions of typed arrays as defined in RFC 8746 are decoded to JavaScript typed arrays

Returns: The CBOR buffer converted to a JavaScript value.

.fetchStreamWithProgress(path: string, onProgress: ProgressCallback, signal: AbortSignal) ⇒ Promise<ReadableStream<Uint8Array>> 

Fetch a file as a ReadableStream, with fetch progress passed to a callback.

Returns: Promise that resolves when the fetch successfully completes.

.fetchWithProgress(path: string, onProgress: ProgressCallback, signal: AbortSignal) ⇒ Promise<ArrayBuffer> 

Fetch a file as an ArrayBuffer, with fetch progress passed to a callback.

Returns: Promise that resolves when the fetch successfully completes.

.getBaseUrl(url: string) ⇒ string 

Get parent path from a URL.

Returns: Parent URL without trailing slash.

.getFilename(url: string) ⇒ string 

Get the filename of a url.

Returns: A string containing the filename. If no filename is found, returns the input string.

.getType(typeInfo: number) ⇒ CBORType 

Check whether the type is an array, a record, or a native type (decodable without recursion).

Returns: The type category.

.isImageLike(value: any) ⇒ value is ImageLike 

Check whether a given value is a visual media.

Returns: true if the value is an image, video, or canvas.

.isNumber(value: any) ⇒ value is number 

Check if a given value is a native number or a Number instance.

Returns: true if the value has type number literal or Number, false otherwise.

.isString(value: any) ⇒ value is string 

Check if a given value is a native string or a String instance.

Returns: true if the value has type string literal or String, false otherwise.

.isUndefined(type: CBORType, length: number) ⇒ boolean 

.loadRuntime(runtime: string, options: Partial<LoadRuntimeOptions>) ⇒ Promise<WonderlandEngine> 

Load the runtime using the WASM and JS files.

Returns: A promise that resolves when the engine is ready to be used.

.onImageReady<T>(image: T) ⇒ Promise<T> 

Promise resolved once the image is ready to be used

Returns: A promise with the image, once it’s ready to be used.

.timeout(time: number) ⇒ Promise<void> 

Schedule a timeout, resolving in time milliseconds.

Note: setTimeout being a macro-task, this method can be use as a debounce call.

Returns: A promise resolving in time ms.