Class AsyncElement

Base class for all PlayCanvas Web Components that initialize asynchronously.

Fires

ready - Fired once the element is fully initialized. Bubbles and is composed.

Hierarchy (View Summary)

HTMLElement
- AsyncElement

Index

Accessors

closestApp closestEntity

Methods

Accessors

closestApp

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.
- Defined in src/async-element.ts:28

closestEntity

get closestEntity(): EntityElement | null
The nearest ancestor <pc-entity> element, or null if this element has no <pc-entity> ancestor. The search starts at the parent, so an element never resolves to itself.

Returns EntityElement | null
The closest entity element, or null.
- Defined in src/async-element.ts:37

Methods

`Protected`_onReady

_onReady(): void
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.

Returns void
- Defined in src/async-element.ts:46

ready

ready(): Promise<AsyncElement>
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.

Returns Promise<AsyncElement>
A promise that resolves with this element when it's ready.
- Defined in src/async-element.ts:56