API Reference

Reference pages for Wonderland Engine’s JavaScript API classes, namespaces and enums.

Custom Components 

You can kick-start your component by creating it through the “Asset Browser”: right-click on free space in the files area.

Make sure to register your component with WL.registerComponent.

To make the component appear in the editor, add the script or folder to the list in “Project Settings”.

See also the JavaScript Quick Start Guide.

Animation

Wrapper around a native animation.

AnimationComponent

Native animation component.

AnimationGraph

Wrapper around a native animation graph.

AnimationGraphManager

Manage animation graphs.

AttributeAccessor

An iterator over a mesh vertex attribute.

AudioClip

Wrapper around an audio clip resource.

BitSet

Stores a bit pattern to quickly test if an index is enabled / disabled.

BrokenComponent

Components must be registered before loading / appending a scene.

CBORReader

CBOR reader.

CollisionComponent

Native collision component.

Component

Provides access to a component instance of a specified component type.

DefaultPropertyCloner

Default cloner implementation.

Emitter

Event emitter.

Environment

Environment lighting properties

Font

Wrapper around a native font resource.

GLTFExtensions

GLTFExtensions API reference

I18N

Class for accessing internationalization (i18n) features.

InputComponent

Native input component.

Interfaces

Interfaces and type aliases

LightComponent

Native light component.

Logger

Logging wrapper.

Material

Wrapper around a native material.

MaterialManager

Manage materials.

math

math API reference

Mesh

Wrapper around a native mesh data.

MeshAttributeAccessor

MeshAttributeAccessor API reference

MeshComponent

Native mesh component.

MeshManager

Manage meshes.

MorphTargets

Wrapper around a native set of morph targets.

Object3D

Scene graph object.

ParticleEffect

Wrapper around a particle effect resource.

ParticleEffectComponent

Native particle effect component.

ParticleEffectManager

Manage particle effects.

Physics

Access to the physics scene

PhysXComponent

Native physx rigid body component.

Pipeline

Wrapper around a pipeline resource.

PipelineManager

Manage pipelines.

Prefab

Base class for prefabs, scenes, and glTF.

PrefabGLTF

glTF scene.

ProbeVolumeScenario

Wrapper around a probe volume scenario resource.

ProbeVolumeScenarioManager

Manage probe volume scenarios.

RayHit

Ray hit.

Resource

Base class for engine resources, such as:

ResourceManager

Manager for resources.

RetainEmitter

Event emitter that retains event data when notified.

Scene

Wonderland Engine (.bin) scene.

SceneResource

Base class for scene resources, such as:

Skin

Wrapper around a native skin data.

TextComponent

Native text component

Texture

Wrapper around a native texture data.

TextureManager

Manage textures.

ViewComponent

Native view component.

WL

Global enumerations, variables, and functions

WonderlandEngine

Main Wonderland Engine instance.

XR

XR API reference

XRSessionState

Properties of a WebXR session