Class ParticleSystemComponentElement

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

Hierarchy (View Summary)

ComponentElement
- ParticleSystemComponentElement

Index

Accessors

asset component enabled

Methods

_onReady pause play ready reset stop

Accessors

asset

get asset(): string
Gets the id of the pc-asset to use for the model.

Returns string
The asset ID.
- Defined in src/components/particlesystem-component.ts:94
set asset(value: string): void
Sets the id of the pc-asset to use for the model.
Parameters
- value: string
  The asset ID.
Returns void
- Defined in src/components/particlesystem-component.ts:83

component

get component(): null | ParticleSystemComponent
Gets the underlying PlayCanvas particle system component.

Returns null | ParticleSystemComponent
The particle system component.
Overrides ComponentElement.component
- Defined in src/components/particlesystem-component.ts:43

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

pause

pause(): void
Pauses the particle system

Returns void
- Defined in src/components/particlesystem-component.ts:111

play

play(): void
Starts playing the particle system

Returns void
- Defined in src/components/particlesystem-component.ts:102

ready

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

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

reset

reset(): void
Resets the particle system

Returns void
- Defined in src/components/particlesystem-component.ts:120

stop

stop(): void
Stops the particle system

Returns void
- Defined in src/components/particlesystem-component.ts:129