Class ListenerComponentElement

The ListenerComponentElement interface provides properties and methods for manipulating <pc-listener> elements. The ListenerComponentElement interface also inherits the properties and methods of the HTMLElement interface.

Hierarchy (View Summary)

ComponentElement
- ListenerComponentElement

Index

Accessors

component enabled

Methods

Accessors

component

get component(): null | AudioListenerComponent
Gets the underlying PlayCanvas audio listener component.

Returns null | AudioListenerComponent
The audio listener component.
Overrides ComponentElement.component
- Defined in src/components/listener-component.ts:23

enabled

get enabled(): boolean
Gets the enabled state of the component.

Returns boolean
The enabled state of the component.
Inherited from ComponentElement.enabled
- Defined in src/components/component.ts:80
set enabled(value: boolean): void
Sets the enabled state of the component.
Parameters
- value: boolean
  The enabled state of the component.
Returns void
Inherited from ComponentElement.enabled
- Defined in src/components/component.ts:69

Methods

`Protected`_onReady

_onReady(): void
Called when the element is fully initialized and ready. Subclasses should call this when they're ready.

Returns void
Inherited from ComponentElement._onReady
- Defined in src/async-element.ts:32

ready

ready(): Promise<ListenerComponentElement>
Returns a promise that resolves with this element when it's ready.

Returns Promise<ListenerComponentElement>
A promise that resolves with this element when it's ready.
Inherited from ComponentElement.ready
- Defined in src/async-element.ts:41