WL

• WL
  • Alignment: enum
  • AnimationState: enum
  • Collider: enum
  • CollisionEventType: enum
  • ForceMode: enum
  • InputType: enum
  • Justification: enum
  • LightType: enum
  • LockAxis: enum
  • MaterialParamType: enum
  • MeshAttribute: enum
  • MeshIndexType: enum
  • MeshSkinningType: enum
  • Shape: enum
  • TextEffect: enum
  • Type: enum
  • .APIVersion: Version
  • .DestroyedComponentInstance: { _ }
  • .DestroyedObjectInstance: { _ }
  • .DestroyedTextureInstance: { _ }
  • .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; }
  • .checkRuntimeCompatibility(version) ⇒ void
  • .loadRuntime(runtime, options) ⇒ Promise<WonderlandEngine>

.Alignment: enum 

Alignment type enum for TextComponent.

Properties

.AnimationState: enum 

Animation state of AnimationComponent.

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

.Justification: enum 

Justification type enum for TextComponent.

Properties

.LightType: enum 

Light type enum for LightComponent.

Properties

.LockAxis: enum 

Enum for Physics axes locking

See angularLockAxis and linearLockAxis.

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

.Shape: enum 

Rigid body shape.

PhysX SDK Guide.

Properties

.TextEffect: enum 

Effect type enum for TextComponent.

Properties

.Type: enum 

Component property type.

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.

.DestroyedTextureInstance: { _ } 

Proxy used to override prototypes of destroyed textures.

.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; } 

Component property namespace.

Usage:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

import {Component, Property} from '@wonderlandengine/api';

class MyComponent extends Component {
    static Properties = {
        myBool: Property.bool(true),
        myInt: Property.int(42),
        myString: Property.string('Hello World!'),
        myMesh: Property.mesh(),
    }
}

For TypeScript users, you can use the decorators instead.

.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.

.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.