import{_ as e,c as t,o as a,N as r}from"./chunks/framework.0799945b.js";const b=JSON.parse('{"title":"Interface: BaseParticles","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/interfaces/features/particles/particles.BaseParticles.md","lastUpdated":null}'),o={name:"api/interfaces/features/particles/particles.BaseParticles.md"},i=r('

Interface: 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

Particles

Parameters ​
NameType
configEmitterConfigV3
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.

Defined in ​

profectus/src/features/particles/particles.tsx:43

',51),s=[i];function n(c,l,d,p,h,f){return a(),t("div",null,s)}const m=e(o,[["render",n]]);export{b as __pageData,m as default};