Class ContextRegistry

Use to register to various Needle Engine context events and to get access to all current instances
e.g. when being created in the DOM

Example

import { NeedleEngine } from "./engine/engine_context_registry.js";
NeedleEngine.addContextCreatedCallback((evt) => {
   console.log("Context created", evt.context);
});

Constructors

constructor

Properties

Registered

Accessors

All Current

Methods

addContextCreatedCallback addContextDestroyedCallback registerCallback unregisterCallback

Constructors

constructor

Properties

Static Registered

Registered: Context[] = []

All currently registered Needle Engine contexts. Do not modify

Accessors

Static All

  • get All(): Context[]

  • Returns the array of all registered Needle Engine contexts. Do not modify

    Returns Context[]

Static Current

  • get Current(): Context

  • The currently active (rendering) Needle Engine context

    Returns Context

Methods

Static addContextCreatedCallback

  • addContextCreatedCallback(callback): void

  • Register a callback to be called when a context is created

    Parameters

    • callback: ContextCallback

    Returns void

Static addContextDestroyedCallback

  • addContextDestroyedCallback(callback): void

  • Register a callback to be called when a context is registered

    Parameters

    • callback: ContextCallback

    Returns void

Static registerCallback

  • registerCallback(evt, callback): void

  • Register a callback to be called when the given event occurs

    Parameters

    Returns void

Static unregisterCallback

  • unregisterCallback(evt, callback): void

  • Unregister a callback

    Parameters

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorRegisteredAllCurrentaddContextCreatedCallbackaddContextDestroyedCallbackregisterCallbackunregisterCallback

Generated using TypeDoc