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.
The closest app element, or 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.
The closest entity-fronting element, or null.
Gets the underlying PlayCanvas screen component. null until the element is
ready — see ComponentElement.component.
The screen component, or null.
Gets the enabled state of the component.
The enabled state of the component.
Sets the enabled state of the component.
The enabled state of the component.
Gets the order in which the screen is drawn relative to other screens in the same layer, from 0 to 255, with higher values drawn on top.
The priority.
Sets the order in which the screen is drawn relative to other screens in the same layer, from 0 to 255, with higher values drawn on top. Defaults to 0.
The priority.
Gets the resolution the screen's layout was designed for, as a width and height in pixels.
The reference resolution.
Sets the resolution the screen's layout was designed for, as a width and height in pixels.
Used only when screenSpace is set and scaleMode is blend, when the contents scale from
this resolution to the actual canvas size, weighted by scaleBlend. Defaults to 640 by 320.
The reference resolution.
Gets the width and height of the screen in pixels, which a screen-space screen overrides with the canvas size.
The resolution.
Sets the width and height of the screen in pixels. A screen-space screen ignores this and always matches the canvas; a world-space screen uses it to size its contents. Defaults to 640 by 320.
The resolution.
Gets how the screen's resolutions are weighted against each other.
The scale blend factor.
Sets how the screen's resolution and referenceResolution are weighted against each other
when scaleMode is blend, from 0 (follow the resolution) to 1 (follow the reference
resolution). Ignored while scaleMode is none.
The scale blend factor.
Gets how the screen scales its contents.
The scale mode.
Sets how the screen scales its contents. none renders at resolution and ignores
referenceResolution; blend scales between the two, weighted by scaleBlend, which is what
keeps a UI laid out at one resolution usable at another. Requires screenSpace - the engine
forces none on a world-space screen, which does not support scaling.
The scale mode ('none' or 'blend').
Gets whether the screen renders its <pc-element> descendants in screen space rather than in
the world.
Whether the screen is in screen space.
Sets whether the screen renders its <pc-element> descendants in screen space, as a 2D
overlay on the canvas, rather than in the world. Defaults to false.
Whether the screen is in screen space.
Protected_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.
Protected_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.
ProtectedgetProtectedinitConfigures the newly added component. Overridden by subclasses whose setup goes beyond the initial data — child-element handling, asset resolution and the like.
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.
A promise that resolves with this element when it's ready.
The ScreenComponentElement interface provides properties and methods for manipulating
<pc-screen>elements. The ScreenComponentElement interface also inherits the properties and methods of the HTMLElement interface.Engine component: ScreenComponent (
screen).