WL

WL : object

Wonderland Engine API

Kind: global namespace

• WL : object
  • .canvas : HTMLCanvasElement
  • .xrSession : XRSession
  • .onXRSupported : xrSupportCallback
  • .onSceneLoaded : sceneLoadedCallback
  • .arSupported
  • .vrSupported
  • .scene
  • .physics
  • .Type : enum
  • .Collider : enum
  • .Alignment : enum
  • .Justification : enum
  • .InputType : enum
  • .LightType : enum
  • .AnimationState : enum
  • .ForceMode : enum
  • .CollisionEventType : enum
  • .Shape : enum
  • .MeshIndexType : enum
  • .onXRSessionStart : xrSessionStartCallback
  • .onXRSessionEnd : xrSessionEndCallback
  • .textures
    • .load(filename, crossOrigin) ⇒ Promise.<Texture>
  • .registerComponent(name, params, object)
  • .init()
  • ._initPhysics()
  • .CustomParameter : object
  • .xrSessionStartCallback : function
  • .xrSessionEndCallback : function
  • .xrSupportCallback : function
  • .sceneLoadedCallback : function
  • .collisionCallback : function

.canvas : HTMLCanvasElement

Canvas element that Wonderland Engine renders to

Kind: static property of WL

.xrSession : XRSession

Current WebXR session or null if no session active

Kind: static property of WL

.onXRSupported : xrSupportCallback

List of functions to call once VR/AR support has been determined.

Kind: static property of WL

.onSceneLoaded : sceneLoadedCallback

List of functions to call once the main scene has been loaded

Kind: static property of WL

.arSupported

Whether AR is supported by the browser

undefined until support could be determined

Kind: static property of WL

.vrSupported

Whether VR is supported by the browser

undefined until support could be determined

Kind: static property of WL

.scene

Current main scene

Kind: static property of WL
Type{scene}:

.physics

Physics, only available when physx is enabled in the runtime

Kind: static property of WL
Type{physics}:

.Type : enum

Component parameter type enum

Kind: static enum of WL
Properties

.Collider : enum

Collider type enum for CollisionComponent

Kind: static enum of WL
Properties

.Alignment : enum

Alignment type enum for TextComponent

Kind: static enum of WL
Properties

.Justification : enum

Justification type enum for TextComponent

Kind: static enum of WL
Properties

.InputType : enum

Input type enum for InputComponent

Kind: static enum of WL
Properties

.LightType : enum

Light type enum for LightComponent

Kind: static enum of WL
Properties

.AnimationState : enum

Animation state of AnimationComponent

Kind: static enum of WL
Properties

.ForceMode : enum

Rigid body force mode for addForce and addTorque.

Kind: static enum of WL
Properties

.CollisionEventType : enum

Collision callback event type

Kind: static enum of WL
Properties

.Shape : enum

Rigid body shape.

Kind: static enum of WL
Properties

.MeshIndexType : enum

Mesh index type

Kind: static enum of WL
Properties

.onXRSessionStart : xrSessionStartCallback

List of functions to call if a WebXR session is started

Kind: static constant of WL

.onXRSessionEnd : xrSessionEndCallback

List of functions to call if a WebXR session ends

Kind: static constant of WL

.textures

Access to the texures managed by Wonderland Engine

Kind: static constant of WL

.load (filename, crossOrigin) ⇒ Promise.<Texture>

Load an image from URL as Texture

Kind: static method of textures
Returns: Promise.<Texture> - Loaded texture

.registerComponent (name, params, object)

Register a custom JavaScript component type

Kind: static method of WL

Example

registerComponent('my-new-type', {
 myParam: {type: Type.Float, default: 42.0},
}, {
 init: function() {},
 start: function() {},
 update: function(dt) {},
 onActivate: function() {},
 onDeactivate: function() {},
});

.init ()

Initialize API resources, called by the engine automatically.

Kind: static method of WL

._initPhysics ()

Initialize API resources, called by the engine automatically, if PhysX is enabled.

Kind: static method of WL

.CustomParameter : object

Kind: static typedef of WL
Properties

.xrSessionStartCallback : function

Kind: static typedef of WL

.xrSessionEndCallback : function

Kind: static typedef of WL

.xrSupportCallback : function

Kind: static typedef of WL

.sceneLoadedCallback : function

Kind: static typedef of WL

.collisionCallback : function

Kind: static typedef of WL