ecs

Entry point for Niantic Studio's Javascript API

Modules

Module	Description
assets	Utility functions related to assets.
CameraEvents	Handles camera events.
events	Handles GLTF events.
input	Handles input events.
math	Various math utility functions.
physics	Physics utility functions, properties, and events.

Functions

Function	Description
createStateMachine	Create a state machine.
defineQuery	Define a query.
defineState	Define a new state.
defineSystem	Define a system.
deleteStateMachine	Delete a state machine.
getAttribute	Returns an attribute that has been registered with a unique name.
getBehaviors	Returns behaviors.
listAttributes	List attributes.
registerBehavior	Register a function that runs on the world every tick.
registerComponent	Register a component.
unregisterBehavior	Deactivate a behavior.

Components

Component	Description
Audio	Defines the audio behavior of an entity.
BoxGeometry	Defines the geometry of an entity.
Camera	Defines the camera behavior.
CapsuleGeometry	Defines the geometry of an entity.
CircleGeometry	Defines the geometry of an entity.
Collider	Defines the physics collision behavior of an entity.
ConeGeometry	Defines the geometry of an entity.
CylinderGeometry	Defines the geometry of an entity.
GltfModel	Used to manage 3D models.
Hidden	Used to show and hide entities.
Light	Defines lighting behavior of an entity.
Material	Defines the material properties for an entity.
PlaneGeometry	Defines the geometry of an entity.
Position	Defines the position of an entity.
Quaternion	Defines the rotation of an entity.
Scale	Defines the scale of an entity.
Shadow	Defines the shadow behavior of an entity.
ShadowMaterial	Defines the shadow behavior of an entity.
SphereGeometry	Defines the geometry of an entity.
TetrahedronGeometry	Defines the geometry of an entity.
Ui	Allows you to create floating or screen overlay UI.
CustomPropertyAnimation	Animate a single number property on the attributes of a target object
PositionAnimation	Animate the position of a target object
ScaleAnimation	Animate the scale vector of a target object
RotateAnimation	Animate the rotation of a target object
RingGeometry	Defines the geometry of an entity.
CustomVec3Animation	Animate the named 3D vector attribute on a target object
FollowAnimation	Follow a target object at the given distance.
LookAtAnimation	Maintain orientation to face a given target or point.
ParticleEmitter	Add a particle system to an entity.