Global

Members

(constant) ActionQueueType :String

The action queue type.
Type:
  • String
Properties:
Name Type Description
EnterLevel String The actions of entering object level.
Source:

(constant) AlignType :String

The align type.
Type:
  • String
Properties:
Name Type Description
Center String Center alignment.
Left String Left alignment.
Top String Top alignment.
TopLeft String Top-Left alignment.
TopRight String Top-Right alignment.
Right String Right alignment.
Bottom String Bottom alignment.
BottomLeft String Bottom-Left alignment.
BottomRight String Bottom-Right alignment.
Source:

(constant) AnimationDirectionType :String

The animation direction type.
Type:
  • String
Properties:
Name Type Description
Normal String Play in normal mode.
Reverse String Play in reverse mode.
Source:

(constant) AxisType :String

The axis type.
Type:
  • String
Properties:
Name Type Description
X String X-Axis
Y String Y-Axis
Z String Z-Axis
Source:

(constant) BlendingType :String

The blending type.
Type:
  • String
Properties:
Name Type Description
No String Disable blending.
Normal String Normal blending. color(RGB) = (sourceColor * 1) + (destinationColor * (1 - srcAlpha)) color(A) = (sourceAlpha * 1) + (destinationAlpha * (1 - srcAlpha))
Additive String Additive blending. color(RGBA) = (sourceColor * 1) + (destinationColor * 1).
Subtractive String Subtractive blending. color(RGB) = destinationColor * (1 - srcAlpha) color(A) = destinationAlpha * 1
Multiply String Multiply blending. color(RGB) = destinationColor * sourceColor color(A) = destinationAlpha * sourceAlpha
Source:

(constant) BoxHelperModeType :String

The box helper mode type.
Type:
  • String
Properties:
Name Type Description
All String All
Root String Root
Bodies String Bodies
Source:

(constant) CodeType :String

The code type.
Type:
  • String
Properties:
Name Type Description
Escape String
Digit1 String
Digit2 String
Digit3 String
Digit4 String
Digit5 String
Digit6 String
Digit7 String
Digit8 String
Digit9 String
Digit0 String
Minus String
Equal String
Backspace String
Tab String
KeyQ String
KeyW String
KeyE String
KeyR String
KeyT String
KeyY String
KeyU String
KeyI String
KeyO String
KeyP String
BracketLeft String
BracketRight String
Enter String
ControlLeft String
KeyA String
KeyS String
KeyD String
KeyF String
KeyG String
KeyH String
KeyJ String
KeyK String
KeyL String
Semicolon String
Quote String
Backquote String
ShiftLeft String
Backslash String
KeyZ String
KeyX String
KeyC String
KeyV String
KeyB String
KeyN String
KeyM String
Comma String
Period String
Slash String
ShiftRight String
NumpadMultiply String
AltLeft String
Space String
CapsLock String
F1 String
F2 String
F3 String
F4 String
F5 String
F6 String
F7 String
F8 String
F9 String
F10 String
Pause String
ScrollLock String
Numpad7 String
Numpad8 String
Numpad9 String
NumpadSubtract String
Numpad4 String
Numpad5 String
Numpad6 String
NumpadAdd String
Numpad1 String
Numpad2 String
Numpad3 String
Numpad0 String
NumpadDecimal String
F11 String
F12 String
F13 String
F14 String
F15 String
F16 String
F17 String
F18 String
F19 String
F20 String
F21 String
F22 String
F23 String
F24 String
NumpadComma String
NumpadEnter String
ControlRight String
BrowserHome String
NumpadDivide String
PrintScreen String
AltRight String
NumLock String
Home String
ArrowUp String
PageUp String
ArrowLeft String
ArrowRight String
End String
ArrowDown String
PageDown String
Insert String
Delete String
Source:

(constant) ColliderType :String

The collider type.
Type:
  • String
Properties:
Name Type Description
Box String Use bounding box to check collider.
Sphere String Use bounding sphere to check collider.
Source:

(constant) Earcut

Port from https://github.com/mapbox/earcut (v2.2.2)
Source:

(constant) EventType :String

The event type.
Type:
  • String
Properties:
Name Type Description
AppQuit String When application quit.
AppEnter String When application be setted as current.
AppLeave String When application be setted as not current.
Update String When update.
FocusIn String When application focus in.
FocusOut String When application focus out.
Resize String When application resize.
MouseEnter String When mouse enter object.
MouseLeave String When mouse leave object.
MouseMove String When mouse move.
MouseUp String When mouse button up.
MouseDown String When mouse button down.
Wheel String When mouse wheel rolling.
Click String When touch end.
DBLClick String When double touch end.
KeyDown String When key down.
KeyUp String When key up.
KeyPress String When key is pressing.
DropFiles String When drop file(s) into application container.
EnterState String When enter state.
LeaveState String When leave state.
RegisterLevelAction String When register level action for level component at the first time
BeforeLeaveLevel String Before leave object level.
LeaveLevel String Leave object level.
AfterLeaveLevel String After leave object level.
BeforeEnterLevel String Before enter object level.
EnterLevel String Enter object level.
AfterEnterLevel String After enter object level.
CompleteEnterLevel String Complete object level entering.
ColliderEnter String When enter(hit) object's collider(just only once before leave collider).
ColliderLeave String When leave object's collider.
Create String When create object event.
Load String When load object resource event.
Progress String When loading object resources.
Error String When load object resouces failed.
BeforeDestroy String When before destroy object event.
Destroy String When destroy object event.
AfterDestroy String When after destroy object event.
BeforeAddChild String When before add child into object.
AfterAddChild String When after add child into object.
BeforeRemoveChild String When before remove child from object.
AfterRemoveChild String When after remove child from object.
StartFlying String When object start to fly.
Flying String When object is flying.
StopFlying String When object stop to fly.
CompleteFlying String When object finish to fly.
ActiveChange String When object active attribute changed.
VisibleChange String When object visible attribute changed.
StopAnimation String When object stop to play animation.
PlayAnimation String When object start to play animation.
ChangeAttributes String When object change attributes.
EnableViewport String When camera enable viewport.
CameraChangePreStart String When camera is ready to start changing.
CameraChangeStart String When camera starts to change.
CameraChange String When camera is changing.
CameraChangePreEnd String When camera is ready to end change.
CameraChangeEnd String When camera ends changing.
BeforeCameraCapture String When camera start to capture screen.
AfterCameraCapture String When camera finish to capture screen.
BeforeLoadResolvers String when before load resolvers in sceneloader
Source:

(constant) FilterResultType :String

The filter result type.
Type:
  • String
Properties:
Name Type Description
Pass String
Fail String
Ignore String
Source:

(constant) FontWeight :String

The font weight.
Type:
  • String
Properties:
Name Type Description
Normal String Normal.
Bold String Bold.
Bolder String Bolder.
Lighter String Lighter.
Source:

(constant) GeometryBuilderUtils

Geometry Builder Utils
Source:

(constant) ImageColorFormat :String

The image color format type.
Type:
  • String
Properties:
Name Type Description
RGB String Red, Green, Blue(RGB) color format.
RGBA String Alpha, Red, Green, Blue(RGBA) color format.
BC7_M6_OPAQUE_ONLY String
Source:

(constant) ImageEncodingType :String

The image encoding type.
Type:
  • String
Properties:
Name Type Description
LINEAR String
SRGB String
RGBE String
RGBM7 String
RGBM16 String
RGBD String
GAMMA String
Source:

(constant) ImageFilterType :String

The image filter type.
Type:
  • String
Properties:
Name Type Description
NearestFilter String Use the value of the texture element that is nearest to the specified texture coordinates.
NearestMipmapNearestFilter String Chooses the mipmap that most closely matches the size of the pixel being textured and uses the NearestFilter.
NearestMipmapLinearFilter String Chooses the two mipmaps that most closely match the size of the pixel being textured and uses the NearestFilter.
LinearFilter String Use the weighted average of the four texture elements that are closest to the specified texture coordinates.
LinearMipmapNearestFilter String Chooses the mipmap that most closely matches the size of the pixel being textured and uses the LinearFilter.
LinearMipmapLinearFilter String Chooses the two mipmaps that most closely matches the size of the pixel being textured and uses the LinearFilter.
Source:

(constant) ImageMappingType :String

The image mapping type.
Type:
  • String
Properties:
Name Type Description
UV String Image texture map normally.
CubeReflection String CubeReflection
CubeRefraction String CubeRefraction
EquirectangularReflection String Use the single one env map to show image, like sky box etc.
EquirectangularRefraction String EquirectangularRefraction
Source:

(constant) ImageSlotType :String

The image slot type.
Type:
  • String
Properties:
Name Type Description
Map String Map
EnvMap String EnvMap
AlphaMap String AlphaMap
EmissiveMap String EmissiveMap
NormalMap String NormalMap
ColorMapping String ColorMapping
AOMap String AOMap(An Ambient Occlusion Map)
Source:

(constant) ImageWrapType :String

The image wrap type.
Type:
  • String
Properties:
Name Type Description
Repeat String Image fill in repeat mode.
ClampToEdge String Image use edge to repeat.
MirroredRepeat String Image fill in repeat/mirror one by one mode.
Source:

(constant) InheritType :String

The inheritance type.
Type:
  • String
Properties:
Name Type Description
Normal String The object would process action normally(process it then pass to children).
Break String The object would process action but do not pass to children
Jump String The object would skip action but keep passing to children.
Stop String The object would break action and do not pass to children
Source:

(constant) LoopType :String

The loop type.
Type:
  • String
Properties:
Name Type Description
Repeat String The value(s) change in repeat loop mode.
PingPong String The value(s) change in ping-pong loop mode.
Source:

(constant) MouseButtonType :String

The mouse button type.
Type:
  • String
Properties:
Name Type Description
None String Invalid mouse button type.
Left String The mouse left button type.
Middle String The mouse middle button type.
Right String The mouse right button type.
Source:

(constant) PickMode :String

The pick mode.
Type:
  • String
Properties:
Name Type Description
Mesh String Mesh
BoundingBox String BoundingBox
Source:

(constant) PickType :String

The pick type.
Type:
  • String
Properties:
Name Type Description
Raycaster String Raycaster
GPU String GPU
GPUFast String
Source:

(constant) PivotMode :String

The pivot mode.
Type:
  • String
Properties:
Name Type Description
Auto String Auto
Location String Location
Source:

(constant) PlayState :String

The play state.
Type:
  • String
Properties:
Name Type Description
Ready String It's ready.
Playing String It's playing.
Paused String It had paused.
Stopped String It had stopped.
Finished String It had finished.
Source:

(constant) PolygonBuilder

PolygonBuilder
Source:

(constant) ProjectionType :String

The projection type.
Type:
  • String
Properties:
Name Type Description
Orthographic String Orthographic
Perspective String Perspective
Source:

(constant) RelationshipDirection :String

The relationship direction type.
Type:
  • String
Properties:
Name Type Description
Out String Out source -> target
In String In target -> source
InOut String InOut
None String NONE
Source:

(constant) RenderType :String

The render type.
Type:
  • String
Properties:
Name Type Description
Sprite String Sprite
Plane String Plane
Source:

(constant) ShadowQualityType :Number

The shadow quality type.
Type:
  • Number
Properties:
Name Type Description
Low Number 512x512 shadow texture size.
Medium Number 1024x1024 shadow texture size.
High Number 2048x2048 shadow texture size.
Ultra Number 4096x4096 shadow texture size.
Source:

(constant) SideType :String

The side type.
Type:
  • String
Properties:
Name Type Description
Front String Draw front side only
Back String Draw back side only
Double String Draw front and back sides
Source:

(constant) SpaceType :String

The space type.
Type:
  • String
Properties:
Name Type Description
Self String Base on self space.
Local String Base on local space.
World String Base on world space.
Source:

(constant) TexelEncodingType :String

The texture element encoding type.
Type:
  • String
Properties:
Name Type Description
LINEAR String
SRGB String
RGBE String
RGBM7 String
RGBM16 String
RGBD String
GAMMA String
Source:

(constant) UVMode :String

The UV mode.
Type:
  • String
Properties:
Name Type Description
Tile String Fill UV as tile(s) repeatly.
Stretch String Fill UV as stretch image mode.
Source:

(constant) ViewMode :String

The view mode.
Type:
  • String
Properties:
Name Type Description
Top String Top
Bottom String Bottom
Left String Left
Right String Right
Front String Front
Back String Back
Source:

Type Definitions

Acceleration

The emitter's acceleration attribute.
Type:
  • Object
Properties:
Name Type Description
value Array.<Number> An array describing this emitter's base acceleration.
spread Array.<Number> An array describing this emitter's acceleration variance on a per-particle basis.
distribution Number A specific distribution to use when calculating a particle's acceleration. Overrides the `ParticleEmitterAttributeType.Distribution` option.
randomise Boolean When a particle is re-spawned, whether it's acceleration should be re-randomised or not.
Source:

ActionMessageData

The action message data.
Type:
  • Object
Properties:
Name Type Description
type String The action type.
target String The target to filer object what to process this action, if not provide then indicates use app's root as target object.
params Object The parameters what pass to action.
delay Number The delay to start performing the current action.
waitForComplete Boolean Wait for the current action to complete before executing the next action, The default is false.
Source:

ActionProcessor

Type:
  • Object
Properties:
Name Type Description
onStop OnActionProcessorStop
onRun OnActionProcessorRun
onEnable OnActionProcessorEnable
Source:

AnimationResult

Type:
  • Object
Properties:
Name Type Description
name String The name.
duration Number The duration in seconds.
speed Number The playing speed.
state PlayStateType The state type.
Source:

AppOptions

The app options.
Type:
  • Object
Properties:
Name Type Attributes Default Description
container? HTMLElement The dom element to render scene.
isEditor Boolean <optional>
 false True indicates it's running in editor env.
background? Number | String | Array.<Number> The background color.
envMap? String The environment map resource url.
Source:

Back

Type:
  • Object
Properties:
Name Type Description
In function
Out function
InOut function
Source:

BaseActionData

Type:
  • Object
Properties:
Name Type Description
object THING.BaseObject The object.
options Object The options.
Source:

BaseEvent

The base event.
Properties:
Name Type Description
type String The case-insensitive name identifying the type of the event.
object THING.BaseObject The object that triggered the event.
target THING.BaseObject A reference to the object to which the event was originally dispatched.
Source:

BaseObjectInitialOptions

Properties:
Name Type Attributes Default Description
name String <optional>
 '' The name.
id String <optional>
 '' The id.
Source:

Bloom

Configuration about bloom post effect
Type:
  • Object
Properties:
Name Type Description
enable Boolean True indicates enable it.
strength Number The intensity.
radius Number The radius.
threshold Number The threshold.
Source:

BlueprintComponentLoadArgs

Type:
  • Object
Properties:
Name Type Description
url String | Array.<String> The resource URL(s).
data Object | Array.<Object> The json data(s).
Source:

BlurEdge

Configuration about blur edge.
Type:
  • Object
Properties:
Name Type Description
enable Boolean True indicates enable it.
offset Number The offset.
Source:

Bounce

Type:
  • Object
Properties:
Name Type Description
In function
Out function
InOut function
Source:

BoundaryResult

Type:
  • Object
Properties:
Name Type Description
center Array.<Number> The center position.
halfSize Array.<Number> The half size.
Source:

BoundingBoxResult

Type:
  • Object
Properties:
Name Type Description
center Array.<Number> The center of box.
halfSize Array.<Number> The half size of box.
Source:

BoxHelperResult

Type:
  • Object
Properties:
Name Type Description
visible Boolean The visible state.
color Array.<Number> The color.
mode BoxHelperModeType The mode.
Source:

BoxInfo

Type:
  • Object
Properties:
Name Type Description
center Array.<Number> The center of box.
halfSize Array.<Number> The half size of box.
Source:

CameraGhostingEffect

Configuration about ghosting.
Type:
  • Object
Properties:
Name Type Description
enable Boolean True indicates enable it.
center Array.<Number> The center.
Source:

CameraGlowEffect

Configuration about glow.
Type:
  • Object
Properties:
Name Type Description
enable Boolean True indicates enable it.
strength Number The strength.
threshold Number The threshold.
radius Number True radius.
Source:

CameraInnerGlowEffect

Configuration about inner glow.
Type:
  • Object
Properties:
Name Type Description
enable Boolean True indicates enable it.
color Array.<Number> The color.
strength Number The strength.
stride Number True stride.
Source:

CameraLineBloomEffect

Configuration about line bloom.
Type:
  • Object
Properties:
Name Type Description
enable Boolean True indicates enable it.
blendRate Number The blend rate.
blurSize Number The blur size.
strength Number The strength.
Source:

CameraRadialEffect

Configuration about radial.
Type:
  • Object
Properties:
Name Type Description
enable Boolean True indicates enable it.
center Array.<Number> The center.
Source:

CameraTailingEffect

Configuration about tailing.
Type:
  • Object
Properties:
Name Type Description
enable Boolean True indicates enable it.
direction Array.<Number> The direction.
center Array.<Number> The center.
Source:

CanvasResource

The pixel buffer with size.
Type:
  • Object
Properties:
Name Type Description
resource HTMLElement The pixel buffer data.
Source:

ChromaticAberration

Chromatic aberration.
Type:
  • Object
Properties:
Name Type Description
enable Boolean True indicates enable it.
chromaFactor Number
Source:

Circular

Type:
  • Object
Properties:
Name Type Description
In function
Out function
InOut function
Source:

ClippingPlaneResult

Type:
  • Object
Properties:
Name Type Description
direction Array.<Number> The direction in world space.
height Number The height.
Source:

ColorCorrection

Configuration about color correction.
Type:
  • Object
Properties:
Name Type Description
enable Boolean True indicates enable it.
exposure Number
brightness Number
contrast Number
saturation Number
gamma Number
Source:

Cubic

Type:
  • Object
Properties:
Name Type Description
In function
Out function
InOut function
Source:

Dof

Configuration about dof.
Type:
  • Object
Properties:
Name Type Description
enable Boolean True indicates enable it.
focalDepth Number
focalLength Number
fstop Number
maxblur Number
threshold Number
gain Number
bias Number
dithering Number
Source:

Drag

The emitter's drag attribute.
Type:
  • Object
Properties:
Name Type Description
value Number A number between 0 and 1 describing the amount of drag to apply to all particles.
spread Number A number describing the drag variance on a per-particle basis.
randomise Boolean When a particle is re-spawned, whether it's drag should be re-randomised or not.
Source:

Elastic

Type:
  • Object
Properties:
Name Type Description
In function
Out function
InOut function
Source:

EventCallback(ev) → {any}

The Event interface represents an event trigger.
Parameters:
Name Type Description
ev MouseEvent | KeyboardEvent The case-insensitive name identifying the type of the event.
Source:
Returns:
Type
any

Exponential

Type:
  • Object
Properties:
Name Type Description
In function
Out function
InOut function
Source:

FXAA

Configuration about FXAA.
Type:
  • Object
Properties:
Name Type Description
enable Boolean True indicates enable it.
Source:

Film

Configuration about film effect.
Type:
  • Object
Properties:
Name Type Description
enable Boolean True indicates enable it.
grayscale Boolean
noiseIntensity Number
scanlinesIntensity Number
scanlinesCount Number
Source:

FilterLevelPathCallback(path) → {Array.<THING.BaseObject>}

The function to call when start to get object level path.
Parameters:
Name Type Description
path Array.<THING.BaseObject> The level path.
Source:
Returns:
The new level path, null or undefined indicates use the current level path.
Type
Array.<THING.BaseObject>

FitBodyScaleInfo

Type:
  • Object
Properties:
Name Type Description
object THING.Marker The object.
image Object The image.
Source:

FogInfo

Type:
  • Object
Properties:
Name Type Description
enable Boolean Enable/Disable fog.
type FogType The type.
near Number The near value(for 'Linear' type).
far Number The far value(for 'Linear' type).
density Number The density(for 'Exp2' type).
color Number | String | Array.<String> The color.
Source:

GetCenterFunction(target) → {Array.<Number>}

Get the center position.
Parameters:
Name Type Description
target Array.<Number> The target to save result.
Source:
Returns:
The reference of target.
Type
Array.<Number>

InheritData

Type:
  • Object
Properties:
Name Type Description
style? InheritType The style attributes inherit type (default value is InheritType.Normal).
visible? InheritType The visible attributes inherit type (default value is InheritType.Normal).
pickable? InheritType The pickable attributes inherit type (default value is InheritType.Normal).
Source:

KeyboardEvent

The KeyboardEvent objects describe a user interaction with the keyboard.
Type:
Properties:
Name Type Description
keyCode Number Returns a number representing the key value of the key represented by the event.
code String Returns a string representing the key value of the key represented by the event.
ctrlKey Boolean Returns a boolean value that is true if the Ctrl key was active when the key event was generated.
shiftKey Boolean Returns a boolean value that is true if the Shift key was active when the key event was generated.
altKey Boolean Returns a boolean value that is true if the Alt key was active when the key event was generated.
Source:

LensflareElement

The lensflare element.
Type:
  • Object
Properties:
Name Type Description
imageTexture ImageTexture The element image texture resource.
color Array.<Number> The element color.
scale Number The element scale.
offset Number The element offset.
Source:

LerpArgs

Properties:
Name Type Attributes Default Description
from Object The source attributes.
to Object The target attributes.
loop Number <optional>
 -1 The loop times, -1 indicates unlimited, and set the loop type to repeat.
times Number <optional>
 -1 The loop times, -1 indicates unlimited.
duration Number <optional>
 1000 The time in milliseconds.
delayTime Number <optional>
 0 The delay time in milliseconds.
lerpType? LerpType The lerp type.
loopType? LoopType The loop type.
orientToPath? Boolean Whether to face the path when moving.
onRepeat function The callback function to trigger repeat action.
onStart function The callback function to trigger start action.
onStop function The callback function to trigger stop action.
onUpdate function The callback function to trigger update action.
onComplete function The callback function to trigger complete action.
Source:

LerpFlyToArgs

Type:
  • Object
Properties:
Name Type Description
position Array.<Number> The position where to fly.
target Array.<Number> | THING.BaseObject The target where to fly, if it's object then auto select the best position from its bounding box.
duration Number The action time in milliseconds.
delayTime Number The delay time in milliseconds.
distance Number The distance(only works for object target mode).
horzAngle Number The horz angle(only works for object target mode).
vertAngle Number The vert angle(only works for object target mode).
lerpType LerpType The lerp type.
positionLerpType LerpType The position lerp type.
targetLerpType LerpType The target lerp type.
upLerpType LerpType The lerp type.
onStart function The start callback function.
onStop function The stop callback function.
onUpdate function The update callback function.
onComplete function The complete callback function.
Source:

LerpToResult

Type:
  • Object
Properties:
Name Type Description
start function The start function.
stop function The stop function.
times function The repeat times setting function.
easing function The lerp setting function.
looping function The looping setting function.
onRepeat function When repeat callback function.
onStart function When start callback function.
onStop function When start callback function.
onUpdate function When update callback function.
onComplete function When complete callback function.
Source:

LerpType

Type:
  • Object
Properties:
Name Type Description
Linear Linear
Quadratic Quadratic
Cubic Cubic
Quartic Quartic
Quintic Quintic
Sinusoidal Sinusoidal
Exponential Exponential
Circular Circular
Elastic Elastic
Back Back
Bounce Bounce
Source:
Example
http://sole.github.io/tween.js/examples/03_graphs.html

LerpWithSpaceTypeArgs

The position/rotate/scale lerp args.
Type:
Source:

LevelChangeOptions

Type:
  • Object
Source:

LevelChangedCallback(ev)

The function to call when level changed.
Parameters:
Name Type Description
ev Object The event info.
Properties
Name Type Description
current THING.BaseObject The current level.
prev THING.BaseObject The previous level.
path Array.<THING.BaseObject> The path from start to target object.
Source:

LevelConfig

The level configuration object.
Type:
  • Object
Properties:
Name Type Description
ignoreVisible Boolean Flag indicating whether to ignore the visibility of level setting objects.
ignoreEvent Boolean Flag indicating whether mouse events for level objects are ignored.
ignoreStyle Boolean Flag indicating whether to ignore the style of level setting objects.
Source:

LevelEventInfo

The level event info.
Type:
  • Object
Properties:
Name Type Description
path Array.<THING.BaseObject> The level path.
origin THING.BaseObject The original level object.
prev THING.BaseObject The previous level object.
current THING.BaseObject The current level object.
next THING.BaseObject The next level object (only for leave operation).
options Object The level options.
Source:

LightSphereInfo

Type:
  • Object
Properties:
Name Type Description
center Array.<Number> The center of light sphere.
radius Number The radius of light sphere, 0 indicates use the radius of bounding box.
shadowRadius Number The shadow's radius of light sphere, 0 indicates use the radius or radius of bounding box.
Source:

Linear

Type:
  • Object
Properties:
Name Type Description
None function
Source:

ListAngle

The emitter's angle attribute.
Type:
  • Object
Properties:
Name Type Description
value Number Either a number, or an array of numbers to describe the angle of a particle over it's lifetime.
spread Number Either a number, or an array of numbers to describe the angle variance of a particle over it's lifetime.
randomise Boolean When a particle is re-spawned, whether it's angle should be re-randomised or not.
Source:

ListColor

The emitter's color attribute.
Type:
  • Object
Properties:
Name Type Description
value Array.<Number> Either an array, or multiple arrays to describe the color of a particle over it's lifetime.
spread Array.<Number> Either an array, or multiple arrays to describe the color variance of a particle over it's lifetime.
randomise Boolean When a particle is re-spawned, whether it's color should be re-randomised or not.
Source:

ListOpacity

The emitter's opacity attribute.
Type:
  • Object
Properties:
Name Type Description
value Number Either a number, or an array of numbers to describe the opacity of a particle over it's lifetime.
spread Number Either a number, or an array of numbers to describe the opacity variance of a particle over it's lifetime.
randomise Boolean When a particle is re-spawned, whether it's opacity should be re-randomised or not.
Source:

ListSize

The emitter's size attribute.
Type:
  • Object
Properties:
Name Type Description
value Number Either a number, or an array of numbers to describe the size of a particle over it's lifetime.
spread Number Either a number, or an array of numbers to describe the size variance of a particle over it's lifetime.
randomise Boolean When a particle is re-spawned, whether it's size should be re-randomised or not.
Source:

LoadTextureResourceSamplerInfo

Properties:
Name Type Description
minFilter ImageFilterType The min filter type.
magFilter ImageFilterType The mag filter type.
wrapS ImageWrapType The horz wrap type.
wrapT ImageWrapType The vert wrap type.
Source:

LoadWasmFileOptions

Type:
  • Object
Properties:
Name Type Description
onGetWasmModule OnGetWasmModuleCallback
Source:

LoginOptions

Type:
  • Object
Properties:
Name Type Description
url String The auth resource url.
wasmRootPath String The wasm root path.
method String The request method.
requestHeaders String The request headers.
postFields String The post field when using 'POST' method.
maxWorkerNumber Number The max worker number, -1 indicates use as default.
onGetResourceType function The resource type callback function, we can set it to tell whether it's encrypted resource.
Source:

LookAtArgs

Type:
  • Object
Properties:
Name Type Attributes Default Description
up Array.<Number> The up direction.
lockAxis AxisType <optional>
 The lock axis type.
always Boolean <optional>
 false True indicates look at target always
lookOnPlane Boolean <optional>
 false True indicates look on target's plane by its forward.
Source:

MSAA

Configuration about MSAA.
Type:
  • Object
Properties:
Name Type Description
enable Boolean True indicates enable it.
Source:

MaxAge

The particle's maximum age attribute.
Type:
  • Object
Properties:
Name Type Description
value Number A number describing the amount of maxAge to apply to all particles.
spread Number A number describing the maxAge variance on a per-particle basis.
Source:

MeshResult

Type:
  • Object
Properties:
Name Type Description
position Array.<Number> The position.
normal Array.<Number> The normal.
uv Array.<Number> The uv.
index Array.<Number> The index of position.
Source:

MouseEvent

The MouseEvent interface represents events that occur due to the user interacting with a pointing device (such as a mouse).
Type:
Properties:
Name Type Description
x Number The X coordinate of the mouse pointer in local (screen) coordinates.
y Number The Y coordinate of the mouse pointer in local (screen) coordinates.
button Number The button number that was pressed when the mouse event was fired.
buttonType String The button type that was pressed when the mouse event was fired.
ctrlKey Boolean Returns true if the ctrl key was down when the mouse event was fired.
shiftKey Boolean Returns true if the shift key was down when the mouse event was fired.
altKey Boolean Returns true if the alt key was down when the mouse event was fired.
Source:

MouseEventData

Type:
  • Object
Properties:
Name Type Description
type String The event type in lowercase.
altKey Boolean Check whether press alt key.
ctrlKey Boolean Check whether press control key.
shiftKey Boolean Check whether press shift key.
deltaX Number The delta-x of mouse cursor in pixel.
deltaY Number The delta-y of mouse cursor in pixel.
x Number The x position of mouse cursor in pixel.
y Number The y position of mouse cursor in pixel.
object THING.BaseObject The picked object(could be null).
pickedPosition Array.<Number> The picked position in world space.
normal Array.<Number> The normal direction in world space.
Source:

MovePathLerpArgs

Type:
Source:

Object3DInitialOptions

Type:
Properties:
Name Type Description
localPosition? Array.<Number> The local position.
localScale? Array.<Number> The local scale.
localAngels? Array.<Number> The local angles.
position? Array.<Number> The world position.
scale? Array.<Number> The world scale.
angels? Array.<Number> The world angles.
Source:

ObjectEventOptions

Type:
  • Object
Properties:
Name Type Description
useCapture Boolean True indicates capture all same events from children.
Source:

ObjectListenerInfo

Type:
  • Object
Properties:
Name Type Description
type String The event type.
condition String The condition to select objects.
callback function The event callback.
tag String The event tag.
priority Number The event priority.
once Boolean True indicates it's trigger only once event.
paused Boolean True indicates it had paused.
Source:

ObjectQueryOptions

Type:
  • Object
Properties:
Name Type Description
recursive Boolean True indicates query in recursive mode.
includeSelf Boolean True indicates including self.
Source:

OnActionProcessorEnable(value)

The function to call when run action.
Parameters:
Name Type Description
value Boolean The value.
Source:

OnActionProcessorRun(options) → {Promise.<any>}

The function to call when run action.
Parameters:
Name Type Description
options Object The options.
Source:
Returns:
Type
Promise.<any>

OnActionProcessorStop()

The function to call when stop action.
Source:

OnActiveChangeComponentCallback(value)

When active state change.
Parameters:
Name Type Description
value Boolean The active state.
Source:

OnAddChildComponentCallback(object)

When add child object.
Parameters:
Name Type Description
object THING.BaseObject The child object.
Source:

OnAfterAddComponentCallback()

When after add component.
Source:

OnAfterRemoveComponentCallback()

When after remove component.
Source:

OnBeforeAddComponentCallback(object)

When before add component.
Parameters:
Name Type Description
object THING.BaseObject The child object.
Source:

OnBeforeRemoveComponentCallback()

When before remove component.
Source:

OnCopyComponentCallback(component)

When copy component.
Parameters:
Name Type Description
component THING.BaseComponent The component.
Source:

OnEnterLevelAsyncCallback(ev, resolve, reject)

When enter self level in async mode.
Parameters:
Name Type Description
ev LevelEventInfo The event info.
resolve function The promise resolve callback function.
reject function The promise reject callback function.
Source:

OnEnterLevelCallback(ev)

When enter self level.
Parameters:
Name Type Description
ev LevelEventInfo The event info.
Source:

OnExportComponentCallback() → {Object}

When export data.
Source:
Returns:
Type
Object

OnFilterObjectsInSelector(object, index, objects) → {Boolean}

The function to call when to get objects by filter.
Parameters:
Name Type Description
object THING.BaseObject The object.
index Number The index of objects.
objects Array.<THING.BaseObject> The objects.
Source:
Returns:
Type
Boolean

OnFinishedEnterLevelCallback(ev)

When enter self level finished.
Parameters:
Name Type Description
ev LevelEventInfo The event info.
Source:

OnFitBodyScaleCallback(info)

The function to call when fit body scale.
Parameters:
Name Type Description
info FitBodyScaleInfo The info.
Source:

OnGetWasmModuleCallback(url) → {Object}

The function to call when get the module name.
Parameters:
Name Type Description
url String The url.
Source:
Returns:
Type
Object

OnImportComponentCallback(param)

When import data.
Parameters:
Name Type Description
param Object The parameters.
Source:

OnInitComponentCallback()

When initialize component.
Source:

OnLateUpdateComponentCallback(deltaTime)

When update before render.
Parameters:
Name Type Description
deltaTime Number The delta time in seconds.
Source:

OnLeaveLevelAsyncCallback(ev, resolve, reject)

When leave self level in async mode.
Parameters:
Name Type Description
ev LevelEventInfo The event info.
resolve function The promise resolve callback function.
reject function The promise reject callback function.
Source:

OnLeaveLevelCallback(ev)

When leave self level.
Parameters:
Name Type Description
ev LevelEventInfo The event info.
Source:

OnLoadResourceComponentCallback()

When load resource.
Source:

OnMapObjectsInSelector(object, index, objects) → {THING.BaseObject}

The function to call when to get objects by map.
Parameters:
Name Type Description
object THING.BaseObject The object.
index Number The index of objects.
objects Array.<THING.BaseObject> The objects.
Source:
Returns:
Type
THING.BaseObject

OnParentChangeComponentCallback(parent)

When parent change.
Parameters:
Name Type Description
parent THING.BaseObject The new parent.
Source:

OnPrefabBundleCreateObject(options, load) → {THING.Object3D}

Create 3D object.
Parameters:
Name Type Description
options BaseObjectInitialOptions The options.
load function The load complete callback function.
Source:
Returns:
Type
THING.Object3D

OnPrefabBundleCreatePrefabObject(options, load) → {THING.Entity}

Create prefab object.
Parameters:
Name Type Description
options BaseObjectInitialOptions The options.
load function The load complete callback function.
Source:
Returns:
Type
THING.Entity

OnReduceObjectsInSelector(accumulator, currentValue, currentIndex, objects) → {Number}

The function to call when to reduce in selector.
Parameters:
Name Type Description
accumulator Number The accumulate value.
currentValue Number The current value.
currentIndex Number The current index.
objects Array.<THING.BaseObject> The objects.
Source:
Returns:
Type
Number

OnRefreshComponentCallback()

When refresh component.
Source:

OnRemoveChildComponentCallback(object)

When remove child object.
Parameters:
Name Type Description
object THING.BaseObject The child object.
Source:

OnResizeComponentCallback(width, height)

When resize component.
Parameters:
Name Type Description
width Number The width in pixel.
height Number The height in pixel.
Source:

OnSortObjectsInSelector(obj1, obj2) → {Number}

The function to call when to sort objects.
Parameters:
Name Type Description
obj1 THING.BaseObject The first object.
obj2 THING.BaseObject The second object.
Source:
Returns:
< 0: obj1 < obj2 == 0: obj1 == obj2 > 0: obj1 > obj2
Type
Number

OnStartAsyncComponentCallback(param) → {Promise.<any>}

When start to active component(just only once) in async mode.
Parameters:
Name Type Description
param Object The initial parameters.
Source:
Returns:
Type
Promise.<any>

OnTraverseActionProcessorCallback()

The function to call when traverse action processor.
Source:

OnTraverseObjectsInSelector(object, index, objects)

The function to call when to get objects by forEach.
Parameters:
Name Type Description
object THING.BaseObject The object.
index Number The index of objects.
objects Array.<THING.BaseObject> The objects.
Source:

OnUnloadResourceComponentCallback()

When unload resource.
Source:

OnUpdateComponentCallback(deltaTime)

When update component.
Parameters:
Name Type Description
deltaTime Number The delta time in seconds.
Source:

OnVisibleChangeComponentCallback(value)

When (body) visible change.
Parameters:
Name Type Description
value Boolean The visible state.
Source:

OrientedBoxResult

Type:
  • Object
Properties:
Name Type Description
angles Array.<Number> The angles base on center.
center Array.<Number> The center world position.
size Array.<Number> The bounding box size.
halfSize Array.<Number> The bounding box half size.
radius Number The bounding box radius.
Source:

PickResult

Type:
  • Object
Properties:
Name Type Description
object THING.BaseObject The object.
position Array.<Number> The picked position.
pickedId Number The picked Id.
external Object The external info.
Source:

PixelBuffer

The pixel buffer with size.
Type:
  • Object
Properties:
Name Type Description
data Object The pixel buffer data.
width Number The buffer width.
height Number The buffer height.
Source:

PlayAnimationArgs

Type:
  • Object
Properties:
Name Type Attributes Default Description
name String The animation name.
times? Number The loop times.
loopType? LoopType The loop type.
speed Number <optional>
 1 The playing speed.
reverse Boolean <optional>
 false True indicates to play in reverse mode.
onComplete function <optional>
 null The callback function to receive complete event.
Source:

Position

The emitter's position attribute.
Type:
  • Object
Properties:
Name Type Description
value Array.<Number> An array describing this emitter's base position.
spread Array.<Number> An array describing this emitter's position variance on a per-particle basis.
spreadClamp Array.<Number> An array describing the numeric multiples the particle's should be spread out over.
radius Number This emitter's base radius.
radiusScale Array.<Number> An array describing the radius's scale in all three axes.
distribution Number A specific distribution to use when radiusing particles. Overrides the `ParticleEmitterAttributeType.Distribution` option.
randomise Boolean When a particle is re-spawned, whether it's position should be re-randomised or not.
Source:

PostEffectInfo

Configuration about post effect.
Type:
  • Object
Properties:
Name Type Description
enable Boolean True indicates enable it.
bloom Bloom The bloom effect.
screenSpaceAmbientOcclusion ScreenSpaceAmbientOcclusion The screen space ambient occlusion effect.
screenSpaceReflection ScreenSpaceReflection The screen space reflection effect.
colorCorrection ColorCorrection The color correction effect.
dof Dof The dof effect.
vignetting Vignetting The vignetting effect.
blurEdge BlurEdge The blur edge effect.
film Film The film effect.
chromaticAberration ChromaticAberration The chromatic aberration effect.
FXAA FXAA The FXAA effect.
MSAA MSAA The MSAA effect.
temporalSuperSampling TemporalSuperSampling The temporal super sampling effect.
Source:

PrefabBundle

The prefab bundle.
Type:
  • Object
Properties:
Name Type Description
createObject OnPrefabBundleCreateObject Create 3D object.
createPrefabObject OnPrefabBundleCreatePrefabObject Create prefab object.
Source:

PrefabEntrance

Type:
  • Object
Properties:
Name Type Description
getBlueprintClasses function Get the blueprint classes.
getExportProperties function Get the export properties.
getExportFunctions function Get the export functions.
Source:

ProcessObjectCallback(object) → {Boolean}

The function to call when start to process some action with object(s).
Parameters:
Name Type Description
object Object3D The object.
Source:
Returns:
False indicates reject to set attribute, otherwise continue to set attribute.
Type
Boolean

Quadratic

Type:
  • Object
Properties:
Name Type Description
In function
Out function
InOut function
Source:

Quartic

Type:
  • Object
Properties:
Name Type Description
In function
Out function
InOut function
Source:

Quintic

Type:
  • Object
Properties:
Name Type Description
In function
Out function
InOut function
Source:

RaycastInfo

Type:
  • Object
Properties:
Name Type Description
origin Array.<Number> The start position.
direction Array.<Number> The direction in world space.
Source:

RaycastResult

Type:
  • Object
Properties:
Name Type Description
object THING.Object3D The picked object.
position Array.<Number> The picked position.
distance Number The distance to ray origin.
Source:

RegisterControlOptions

Type:
  • Object
Source:

RenderSettingsInfo

Configuration about app renderSettings.
Type:
  • Object
Properties:
Name Type Description
background background The camera's background.
environment environment The scene's global environmentMap.
light lights The lights config(lights under app.root.children).
PostEffectInfo postEffects The camera postEffect info.
cameraEffectInfo cameraEffects The camera effect info.
Source:

RenderableNodeGeometryInfo

Type:
  • Object
Properties:
Name Type Description
vertices Number The number of vertices.
triangles Number The number of triangles.
materials Number The number of materials.
textures Number The number of textures.
Source:

ResourceResult

Type:
  • Object
Properties:
Name Type Description
url String The url.
localPosition? Array.<Number> The local position.
localAngles? Array.<Number> The local angles.
localScale? Array.<Number> The local scale.
children? Array.<ResourceResult> The children.
Source:

Rotation

The emitter's rotation attribute.
Type:
  • Object
Properties:
Name Type Description
axis Array.<Number> An array describing this emitter's axis of rotation.
axisSpread Array.<Number> An array describing the amount of variance to apply to the axis of rotation on a per-particle basis.
angle Number The angle of rotation, given in radians. If `Rotation.static` is true, the emitter will start off rotated at this angle, and stay as such. Otherwise, the particles will rotate from 0radians to this value over their lifetimes.
angleSpread Number The amount of variance in each particle's rotation angle.
static Boolean Whether the rotation should be static or not.
center Array.<Number> An array describing the center point of rotation.
randomise Boolean When a particle is re-spawned, whether it's rotation should be re-randomised or not.
Source:

SceneObjectExporterOptions

Type:
  • Object
Properties:
Name Type Description
rootPath String The root path.
includeSelf Boolean True indicates export self info, default is false.
externalComponents Boolean Check whether export external components, default is true.
lights Boolean Check whether export lights, default is false.
camera Boolean Check whether export camera, default is false.
Source:

ScreenSpaceAmbientOcclusion

Configuration about screen space ambient occulusion (SSAO).
Type:
  • Object
Properties:
Name Type Description
enable Boolean True indicates enable it.
radius Number The radius. Sampling radius in work space. Larger will produce more soft concat shadow. But also needs higher quality or it will have more obvious artifacts
quality String Quality of SSAO. 'low'|'medium'|'high'|'ultra'.
intensity Number The intensity.
temporalFilter Boolean The temporal filter in temporal super sampling mode.
ignoreTransparent Boolean if ignore transparent objects.
Source:

ScreenSpaceReflection

Configuration about screen space reflection.
Type:
  • Object
Properties:
Name Type Description
enable Boolean True indicates enable it.
maxRayDistance Number
pixelStride Number
pixelStrideZCutoff Number
screenEdgeFadeStart Number
eyeFadeStart Number
eyeFadeEnd Number
minGlossiness Number
Source:

SelfToWorldFunction(position, ignoreScale, target) → {Array.<Number>}

Convert self position to world position.
Parameters:
Name Type Description
position Array.<Number> The world position.
ignoreScale Boolean True indicates to ignore scale.
target Array.<Number> The target to save result.
Source:
Returns:
The reference of target.
Type
Array.<Number>

ShadowRangeInfo

Type:
  • Object
Properties:
Name Type Description
width Number The width.
height Number The height.
near Number The near.
far Number The far.
Source:

Sinusoidal

Type:
  • Object
Properties:
Name Type Description
In function
Out function
InOut function
Source:

StyleColorOperationCallback(baseValue, style)

The function to call when update color.
Parameters:
Name Type Description
baseValue Array.<Number> The base color.
style THING.Style The style.
Source:

StyleEdgeResult

Type:
  • Object
Properties:
Name Type Description
enable Boolean True indicates enable it.
color Array.<Number> The color.
opacity Number The opacity.
glow Boolean True indicates enable glow effect.
Source:

StyleEffectResult

Type:
  • Object
Properties:
Name Type Description
glow Number The glow intensity (null indicates resume original effect).
innerGlow Boolean The inner glow effect (null indicates resume original effect).
lineBloom Boolean The line bloom effect (null indicates resume original effect).
tailing Boolean The tailing effect (null indicates resume original effect).
radial Boolean The radial effect (null indicates resume original effect).
ghosting Boolean The ghosting effect (null indicates resume original effect).
Source:

StyleImagesResult

Type:
  • Object
Properties:
Name Type Description
map Object
envMap Object
alphaMap Object
emissiveMap Object
normalMap Object
colorMapping Object
aoMap Object
Source:

StyleUVMatrixResult

Type:
  • Object
Properties:
Name Type Description
offset Array.<Number> The offset of UV matrix, default: [0, 0]
repeat Array.<Number> The repeat of UV matrix, default: [1, 1]
center Array.<Number> The center of UV matrix, default: [0, 0]
rotation Number The rotation in degree.
Source:

StyleValueOperationCallback(baseValue, style)

The function to call when update value.
Parameters:
Name Type Description
baseValue Number The base value.
style THING.Style The style.
Source:

TemporalSuperSampling

Temporal super sampling
Type:
  • Object
Properties:
Name Type Description
enable Boolean True indicates enable it.
size Number The max frames.
Source:

TextureAnimation

The texture's animation attribute.
Type:
  • Object
Properties:
Name Type Description
frames Array.<Number> The number of frames on the x- and y-axis of the given texture.
frameCount Number The total number of frames in the sprite-sheet.
loop Number The number of loops through the sprite-sheet that should be performed over the course of a single particle's lifetime.
Source:

TraverseComponentByTypeCallback(component, name)

The function to call when traverse component by type.
Parameters:
Name Type Description
component THING.BaseComponent The component.
name String The component name.
Source:

Velocity

The emitter's velocity attribute.
Type:
  • Object
Properties:
Name Type Description
value Array.<Number> An array describing this emitter's base velocity.
spread Array.<Number> An array describing this emitter's velocity variance on a per-particle basis.
distribution Number A specific distribution to use when calculating a particle's velocity. Overrides the `ParticleEmitterAttributeType.Distribution` option.
randomise Boolean When a particle is re-spawned, whether it's velocity should be re-randomised or not.
Source:

Viewpoint

The viewpoint.
Type:
  • Object
Properties:
Name Type Description
position Array.<Number> the camera position
target Array.<Number> the camera target position
Source:

Vignetting

Configuration about vignetting.
Type:
  • Object
Properties:
Name Type Description
enable Boolean True indicates enable it.
color Array.<Number> The color, only for color type
offset Number The offset.
Source:

WorldToScreenFunction(position, target) → {Array.<Number>}

Convert world position to screen position.
Parameters:
Name Type Description
position Array.<Number> The world position.
target Array.<Number> The target to save result.
Source:
Returns:
The reference of target.
Type
Array.<Number>

background

Configuration about background
Type:
  • ImageTexture | CubeTexture | Array.<Number>
Source:

environment

Configuration about environment
Type:
  • Object
Properties:
Name Type Description
envMap ImageTexture | CubeTexture The scene's envMap.
diffuseIntensity Number The envMap light Intensity
Source:

onCreateTextureAsyncCallback(url, sampler) → {Promise.<any>}

When create texture in async mode.
Parameters:
Name Type Description
url String The url.
sampler LoadTextureResourceSamplerInfo The sampler info.
Source:
Returns:
Type
Promise.<any>

onCreateTextureCallback(url, sampler) → {THING.BaseTexture}

When create texture.
Parameters:
Name Type Description
url String The url.
sampler LoadTextureResourceSamplerInfo The sampler info.
Source:
Returns:
Type
THING.BaseTexture

onFocusChangeCallback(ev)

When focus change.
Parameters:
Name Type Description
ev FocusEvent The event info.
Source:

onPickObjectCallback(object) → {THING.Object3D}

The function to call when pick object.
Parameters:
Name Type Description
object THING.Object3D The object.
Source:
Returns:
The latest picked object, if it's null indicates pick nothing
Type
THING.Object3D