Interfaces

• WL
  • ActivateOptions: Interface
  • ComponentProperty: Interface
  • ComponentProto: Interface
  • GLTFExtensionsInstance: Interface
  • GLTFExtensionsLegacy: Interface
  • InMemoryLoadOptions: Interface
  • InstantiateGltfResult: Interface
  • InstantiateResult: Interface
  • ListenerOptions: Interface
  • LoadRuntimeOptions: Interface
  • MaterialConstructor: Interface
  • MaterialParameters: Interface
  • MeshParameters: Interface
  • NativeComponents: Interface
  • NumberArray: Interface
  • Options: Interface
  • PropertyCloner: Interface
  • PropertyRecord: Interface
  • PropertyReferenceOptions: Interface
  • RetainListenerOptions: Interface
  • SceneAppendParameters: Interface
  • SceneLoadOptions: Interface
  • UrlLoadOptions: Interface
  • XROfferSessionOptions: Interface
  • CollisionCallback: Type Alias
  • ComponentConstructor: Type Alias
  • Constructor: Type Alias
  • DictionaryOption: Type Alias
  • FirstConstructorParam: Type Alias
  • GLTFOptions: Type Alias
  • ImageLike: Type Alias
  • ListenerCallback: Type Alias
  • LoadOptions: Type Alias
  • ProgressCallback: Type Alias
  • PropertyArgs: Type Alias
  • PropertyKeys: Type Alias
  • SceneAppendResult: Type Alias
  • SceneAppendResultWithExtensions: Type Alias
  • Tagger: Type Alias
  • TypedArray: Type Alias
  • TypedArrayCtor: Type Alias
  • Version: Type Alias

.ActivateOptions: Interface 

Options for scene activation.

Properties

.ComponentProperty: Interface 

Custom component property.

For more information about component properties, have a look at the Properties attribute.

Properties

.ComponentProto: Interface 

Component prototype interface.

User component’s should have the same structure.

Properties

.GLTFExtensionsInstance: Interface 

Extension data obtained from glTF files.

Properties

.GLTFExtensionsLegacy: Interface 

Legacy gltf extension type.

Deprecated: Use the new loadGLTF API.

Properties

.InMemoryLoadOptions: Interface 

Loading options for in-memory data.

Properties

.InstantiateGltfResult: Interface 

Properties

.InstantiateResult: Interface 

Properties

.ListenerOptions: Interface 

Registration options for a listener in an Emitter.

Properties

.LoadRuntimeOptions: Interface 

Options to forward to loadRuntime

Properties

.MaterialConstructor: Interface 

Material constructor.

Material classes are automatically generated by the runtime based on the loaded scene shaders.

Properties

.MaterialParameters: Interface 

Constructor parameters object for a Material instance.

Deprecated: Use getTemplate instead:

1const PhongMaterial = engine.materials.getTemplate('Phong Opaque');
2const material = new PhongMaterial();
3material.setDiffuseColor([1, 0, 0]);

Properties

.MeshParameters: Interface 

Mesh constructor parameters object.

Usage:

1const mesh = Mesh({vertexCount: 3, indexData: [0, 1, 2]});

Properties

.NativeComponents: Interface 

Native components list

Properties

.NumberArray: Interface 

Represents any object that can be used as an array for read / write.

Properties

.Options: Interface 

Options for the decoder.

Properties

.PropertyCloner: Interface 

Cloning interface for component properties.

Used for component initialization and cloning.

Properties

.PropertyRecord: Interface 

Interface describing a record class used in properties.

1import {property, PropertyRecord} from '@wonderlandengine/api';
2class Record implements PropertyRecord {
3  @property.string()
4  string: string;
5  @property.record(SubRecord)
6  subrecord: SubRecord;
7}

Note: Implementing PropertyRecord isn’t required.

Properties

.PropertyReferenceOptions: Interface 

Options to create a reference property, i.e., object, mesh, animation, skin, etc…

Properties

.RetainListenerOptions: Interface 

Registration options for a listener in an RetainEmitter.

Those options extend ListenerOptions.

Properties

.SceneAppendParameters: Interface 

Options for append.

Properties

.SceneLoadOptions: Interface 

Scene loading options.

Properties

.UrlLoadOptions: Interface 

Options for loading files from a URL.

Properties

.XROfferSessionOptions: Interface 

Options for xrOfferSession

Properties

.CollisionCallback: Type Alias 

Definition:

1CollisionCallback = (type: CollisionEventType, other: PhysXComponent) ⇒ void

.ComponentConstructor: Type Alias 

Component constructor type.

For more information, please have a look at the Component class.

Definition:

1ComponentConstructor<T: extends Component> = (scene: Prefab, manager: number, id: number) ⇒ T & {
2    InheritProperties: boolean;
3    Properties: Record&lt;string, ComponentProperty&gt;;
4    TypeName: string;
5    _isBaseComponent: boolean;
6    _propertyOrder: string[];
7    onRegister: (engine: WonderlandEngine) ⇒ void;
8}

.Constructor: Type Alias 

Definition:

1Constructor<T> = (...args: any[][]) ⇒ T

.DictionaryOption: Type Alias 

Whether key/value dictionaries should be decoded as objects or as Map<K, V>. The latter is useful if non-string keys or iterating in insertion order are required.

Definition:

1DictionaryOption = 'object' | 'map'

.FirstConstructorParam: Type Alias 

Definition:

1FirstConstructorParam<T> = ['undefined']

.GLTFOptions: Type Alias 

GLTF-specific loading options.

Definition:

1GLTFOptions = {
2    extensions: boolean;
3}

.ImageLike: Type Alias 

Element that can be used as an image in the engine.

Definition:

1ImageLike = HTMLImageElement | HTMLVideoElement | HTMLCanvasElement | ImageBitmap

.ListenerCallback: Type Alias 

Definition:

1ListenerCallback<T: extends unknown[]> = (...data: T[]) ⇒ void

.LoadOptions: Type Alias 

Options used during loading.

Definition:

1LoadOptions<Extra> = string | UrlLoadOptions & Partial&lt;Extra&gt;

.ProgressCallback: Type Alias 

Definition:

1ProgressCallback = (current: number, total: number) ⇒ void

.PropertyArgs: Type Alias 

Retrieve all the argument types of a Property function.

Definition:

1PropertyArgs<key: extends PropertyKeys> = Parameters&lt;['undefined']&gt;

.PropertyKeys: Type Alias 

All the keys that exists on the Property object.

Definition:

1PropertyKeys = keyof undefined

.SceneAppendResult: Type Alias 

Result obtained when appending a scene with append.

Definition:

1SceneAppendResult = Object3D | null | SceneAppendResultWithExtensions

.SceneAppendResultWithExtensions: Type Alias 

Result obtained when appending a scene with append with gltf extensions.

Definition:

1SceneAppendResultWithExtensions = {
2    extensions: GLTFExtensionsLegacy;
3    root: Object3D | null;
4}

.Tagger: Type Alias 

Definition:

1Tagger = (tag: number | bigint, value: any) ⇒ any

.TypedArray: Type Alias 

Typed array instance based on a given TypedArrayCtor constructor.

Definition:

1TypedArray<T: extends TypedArrayCtor> = InstanceType&lt;T&gt;

.TypedArrayCtor: Type Alias 

A type alias for any TypedArray constructor, except big-int arrays.

Definition:

1TypedArrayCtor = Int8ArrayConstructor | Uint8ArrayConstructor | Uint8ClampedArrayConstructor | Int16ArrayConstructor | Uint16ArrayConstructor | Int32ArrayConstructor | Uint32ArrayConstructor | Float32ArrayConstructor | Float64ArrayConstructor

.Version: Type Alias 

Version type following a subset of the Semantic Versioning specification.

Definition:

1Version = {
2    major: number;
3    minor: number;
4    patch: number;
5    rc: number;
6}