ProfectusInterface: BaseParticles
features/particles/particles.BaseParticles
The properties that are added onto a processed ParticlesOptions to create an Particles.
Properties
[Component]
• [Component]: GenericComponent
The Vue component used to render this feature.
Defined in
profectus/src/features/particles/particles.tsx:45
[GatherProps]
• [GatherProps]: () => Record<string, unknown>
Type declaration
▸ (): Record<string, unknown>
A function to gather the props the vue component requires for this feature.
Returns
Record<string, unknown>
Defined in
profectus/src/features/particles/particles.tsx:47
addEmitter
• addEmitter: (config: EmitterConfigV3) => Promise<Emitter>
Type declaration
▸ (config): Promise<Emitter>
A function to asynchronously add an emitter to the canvas. The returned emitter can then be positioned as appropriate and started.
See
Parameters
| Name | Type |
|---|---|
config | EmitterConfigV3 |
Returns
Promise<Emitter>
Defined in
profectus/src/features/particles/particles.tsx:41
app
• app: Ref<null | Application>
The Pixi.JS Application powering this particles canvas.
Defined in
profectus/src/features/particles/particles.tsx:35
id
• id: string
An auto-generated ID for identifying features that appear in the DOM. Will not persist between refreshes or updates.
Defined in
profectus/src/features/particles/particles.tsx:33
type
• type: typeof ParticlesType
A symbol that helps identify features of the same type.