HomeWeb Components API Reference - v0.17.0
    Preparing search index...

    Class WasmElement

    The WasmElement interface provides properties and methods for manipulating <pc-wasm> elements. The WasmElement interface also inherits the properties and methods of the AsyncElement interface.

    The attributes are read once, when the module starts loading - on the element's first connection, or earlier if a containing <pc-app> boots first and collects it - so changing them later has no effect. The element becomes ready once the module has loaded. WebAssembly modules configure engine-global state that never unloads, so readiness is not re-armed by removing the element, and a re-inserted element does not load again.

    A <pc-wasm> without a name warns and never becomes ready; a containing <pc-app> still boots.

    name - The name of the WebAssembly module to configure, e.g. Basis or Ammo.

    glue - The URL of the module's glue script.

    wasm - The URL of the module's WebAssembly binary.

    fallback - The URL of the module's asm.js fallback script, used when WebAssembly is unavailable.

    Hierarchy (View Summary)

    Index
    • get closestApp(): AppElement | null

      The nearest ancestor <pc-app> element, or null if this element has no <pc-app> ancestor. The search starts at the parent, so an element never resolves to itself.

      Returns AppElement | null

      The closest app element, or null.

    • get closestEntity(): EntityBaseElement | null

      The nearest ancestor element that fronts an entity — <pc-entity>, <pc-model> or <pc-node> — or null if this element has no such ancestor. The search starts at the parent, so an element never resolves to itself.

      Returns EntityBaseElement | null

      The closest entity-fronting element, or null.

    • Called when the element is fully initialized and ready. Subclasses should call this when they're ready. Resolves the ready promise and dispatches a bubbling, composed ready event. Signals at most once per readiness cycle: a repeat call before _resetReady has re-armed the promise does nothing.

      Returns void

    • Returns the ready promise to its pending state. Subclasses should call this when the resource their readiness announced is torn down (typically from disconnectedCallback), so that a later re-initialization can signal readiness again. Does nothing while the promise is still pending — an in-flight waiter carries over to the next readiness cycle rather than being stranded on a promise nothing will ever resolve.

      Returns void

    • Returns a promise that resolves with this element when it's ready. This is the low-level primitive underlying whenReady, which is the recommended way to wait for elements.

      Readiness tracks the element's current lifecycle: once a ready element is torn down (for example by removing it from the document), this returns a fresh promise that resolves when the element is next ready. A promise obtained earlier stays resolved — call this again after re-inserting an element rather than reusing a promise from before its removal.

      Returns Promise<WasmElement>

      A promise that resolves with this element when it's ready.