API reference

Every public class, method, and event in @codexo/exojs. Generated from source.

interfaceExtension

@codexo/exojs/extensions / extensions / stable

An ExoJS extension: an immutable descriptor that contributes renderer bindings, asset bindings, serializer bindings and/or app-level systems. Holds no Application, backend, GPU, or loader instances. Pass it to the application that should have it, via ApplicationOptions.extensions - that is the only way an extension takes effect, so what an application can do is readable at its construction rather than inferred from which modules were imported. The descriptor is a shared, frozen singleton: the same object equips any number of Applications. Per-application state therefore never belongs on it - it belongs in the closure Extension.install opens, which is also what the returned ExtensionDisposer closes over.

props

methods

events

Import

import { Extension } from '@codexo/exojs/extensions'

The descriptor is a shared, frozen singleton: the same object equips any number of Applications. Per-application state therefore never belongs on it - it belongs in the closure Extension.install opens, which is also what the returned ExtensionDisposer closes over.

Methods1

install?(app: ApplicationTop-level engine instance. Owns the canvas, render backend, scene-stack controller, the core systems (input, interaction, audio, coroutines, tweens, animations…): ExtensionDisposerUndoes one Extension.install call, for the one Application that call was made against. Returned by `install`, held by that Application, and invoked exactly onc… | void

Set this application up for whatever the binding arrays cannot express - an app-level System on Application.systems, a subscription on Application.onResize, a MutationObserver, a worker, a debug overlay appended next to the canvas. Runs once per Application, as the final construction step: every core system and every materialised binding already exists, and dependencies listed in Extension.dependencies are installed first. Return an ExtensionDisposer to undo it. The Application holds the disposers of everything it installed and runs them in reverse installation order - during Application.destroy, or, if a later construction step throws, during that constructor's rollback. Return nothing when there is nothing to undo. A disposer that throws is reported and the remaining ones still run. An extension's lifetime is its Application's lifetime: there is no uninstall at runtime, and no scene-level scope - extensions equip an application, not a scene. install throwing aborts construction, and whatever it had already done before throwing is its own to undo: the disposer it never returned cannot be run for it.

Properties5

assets?: readonly AnyAssetTypeAny AssetType, whatever its source, resource, option and stored types - the element type of an Extension's `assets` list. The source and stored types appear on…[]

dependencies?: readonly Extension[]

id: string

renderers?: readonly RendererBindingBinds one or more drawable constructors to a renderer factory. Pure descriptor - no active renderer, no GPU resources, no side effects until `create` is called…<DrawableBase class for every renderable scene object. Extends RenderNode with a per-object tint colour, blend mode, and the normalized `anchor` that derives SceneNode.…>[]

serializers?: readonly SerializerBindingBinds a SceneNode type to a NodeSerializer under a stable type name, so an extension's own node types participate in Scene.serialize/Scene.deserialize. Pure de…<SceneNodeTransform-bearing leaf in the scene-graph hierarchy. Carries position, rotation, scale, skew and origin. Implements Collidable so any node can participate dire…>[]

Source

src/extensions/Extension.ts