API Reference

The AnimateSprite component cycles through spritesheet tiles.

The Animate component is used to animate the transform of the entity over time.

The transform of the entity with the AudioListener component will be used to set the position and orientation of game.Audio's listener.

The AudioSource component is used to make entities play back audio. The sound data is defined by the AudioClip interface.

A utility mixin which runs arbitrary logic when an entity is created.

The Camera component makes the rendering system render the scene from the vantage point of the entity.

The Camera2D component makes the rendering system render the scene from the vantage point of the entity.

The Children component is used to group entities together under a common parent.

The Collide component allows detecting AABB collisions between entities.

The Collide2D component allows detecting AABB collisions between entities.

Stores movement, rotation, and animation that will be applied to the entity every frame by sys_move and sys_animate, respectively.

Stores movement and rotation that will be applied to the entity every frame by sys_move_2d.

Make the entity controllable by the player. Suitable for first-person and third-person 3D games, as well as some camera control schemes.

A utility mixin which disables a component mask when an entity is created.

The Draw component allows drawing 2D primitives like text and rectangles.

The EmitParticles component makes the entity emit particles.

The Follow component allows an entity to follow another entity. Only the position is followed, not the rotation.

The Lifespan component allows the entity to autodestruct after a certain time. Upon destruction, the entity can emit an Action.

The Light component allows an entity to emit light.

The LocalTransform2D component allows the entity to be positioned in 2D space.

The LookAt component allows an entity to look at another entity.

The Mimic component allows an entity to mimic another entity, i.e. match the target entity's position and rotation with a small lag.

The Move component allows the entity to move.

The Move2D component allows the entity to move in 2D space.

The Name component stores a name for the entity.

The Render component allows the entity to be rendered.

The Render2D component allows an entity to be rendered in 2D space.

The RigidBody component allows the entity to collide and interact with other rigid bodies

The RigidBody2D component allows the entity to collide and interact with other rigid bodies

The Shake component allows the entity to change its position randomly every frame.

The SpatialNode2D component allows the entity to be part of the 2D scene graph.

The Spawn component allows the entity to spawn other entities.

The Task component is used to schedule tasks to be executed at a later time.

The Toggle component allows to periodically enable and disable other components on the entity.

The Transform component stores the entity's position, rotation and scale in 3D space, as well as the entity's parent.

The Trigger component allows the entity's collider to trigger Actions.

Animate transforms of entities (position, rotation, scale) over time.

Update the position and orientation of game.Audio's listener.

Play audio clips from entities with AudioSource.

Update the PV matrix of the WebXR camera.

Update the PV matrix of the camera.

Update the PV matrix of the camera used for 2D rendering.

Detect collisions between static and dynamic colliders.

Detect collisions between static and dynamic colliders.

Update the entity's Move and Animate components every frame.

Update the entity's Move2D component every frame.

Handle keyboard input.

Handle mouse input when dragging with one of the buttons pressed. Good for cameras overlooking the scene.

Handle mouse input when the mouse is moving without any buttons pressed. Good for FPS and TPS camera controls.

Handle touch input when dragging with one finger. Good for cameras overlooking the scene.

Handle touch input using the "invisible joystick" approach. Good for FPS and TPS camera controls.

Handle gamepad input.

Render colored wireframes around colliders and invisible entities.

Draw 2D primitives in the 3D scene using the Context2D API.

Draw 2D primitives in the 2D scene using the Context2D API.

Update the entity's position to follow another entity.

Autodestruct entities after a given time.

Collect the lights in the scene and update the array of light positions and details to be passed to shaders in sys_render_forward.

Update the entity's position to look at another entity.

Update the entity's position and rotation to mimic another entity.

Move and rotate entities.

Move and rotate entities.

Update the instance arrays of particle emitters, to be passed to the shaders.

The first step of the physics simulation: integrate the rigid body's acceleration and velocity, and update the entity's transform.

Derive the velocity of kinematic rigid bodies from the change in their position.

The second step of the physics simulation: resolve the collisions between rigid bodies.

The first step of the physics simulation: integrate the rigid body's acceleration and velocity, and update the entity's transform.

The second step of the physics simulation: resolve the collisions between rigid bodies.

Complete tasks whose ready condition has been satisifed.

Render the world using the deferred rendering pipeline: the g-buffer pass.

Render the world to depth render targets.

Render the world using the forward rendering pipeline.

Render the world using the deferred rendering pipeline: the shading pass.

Render the world using an XR camera.

Animate sprites (WIP).

Render all sprites in the world using the WebGL renderer.

Resize the inner resolution of canvases when the browser's window is resized, resize render-to-texture targets, and update the projection matrices of cameras in the scene.

Resize the inner resolution of canvases when the browser's window is resized, and update the projection matrices of cameras in the scene.

Shake entities randomly.

Shake entities randomly.

Instantiate blueprints into the world periodically. Spawned entities inherit the spawner's position and rotation.

Instantiate blueprints into the world periodically. Spawned entities inherit the spawner's position and rotation.

Enable and disable the entity's other components periodically.

Apply changes to position, rotation, and scale to the entities' World transformation matrix, taking into account transforms of parents.

Apply changes to position, rotation, and scale, and update the instance array to be used by the shader.

Emit an Action when another entity collides with this entity.

Emit an Action when another entity collides with this entity.

Render the UI.

Convert Tiled's JSON map representation to a TypeScript source file, which can then be imported and used by the tiled.ts module to instantiate a map.

Convert a Tiled tileset JSON file to an atlas definition in TypeScript.