Profectus / features/particles/particles / Particles
Interface: Particles ​
An object that represents a feature that display particle effects on the screen. The config should typically be gotten by designing the effect using the online particle effect editor and passing it into the upgradeConfig from @pixi/particle-emitter.
Extends ​
Properties ​
[VueFeature] ​
[VueFeature]:
true
Used to identify Vue Features
Inherited from ​
Defined in ​
addEmitter() ​
addEmitter: (
config) =>Promise<Emitter>
A function to asynchronously add an emitter to the canvas. The returned emitter can then be positioned as appropriate and started.
Parameters ​
config ​
EmitterConfigV3
Returns ​
Promise<Emitter>
See ​
Defined in ​
profectus/src/features/particles/particles.tsx:43
app ​
app:
Ref<null|Application,null|Application>
The Pixi.JS Application powering this particles canvas.
Defined in ​
profectus/src/features/particles/particles.tsx:37
classes? ​
Dictionary of CSS classes to apply to this feature.
Inherited from ​
Defined in ​
components ​
components:
MaybeGetter<Renderable>[]
The components to render inside the vue feature
Inherited from ​
Defined in ​
id ​
id:
string
An auto-generated ID for identifying features that appear in the DOM. Will not persist between refreshes or updates.
Inherited from ​
Defined in ​
onContainerResized()? ​
optionalonContainerResized: (boundingRect) =>void
A function that is called when the particles canvas is resized.
Parameters ​
boundingRect ​
Returns ​
void
Defined in ​
profectus/src/features/particles/particles.tsx:33
onHotReload? ​
optionalonHotReload:VoidFunction
A function that is called whenever the particles element is reloaded during development. For restarting particle effects.
Defined in ​
profectus/src/features/particles/particles.tsx:35
style? ​
optionalstyle:MaybeRef<CSSProperties>
CSS to apply to this feature.
Inherited from ​
Defined in ​
type ​
type: typeof
ParticlesType
A symbol that helps identify features of the same type.
Defined in ​
profectus/src/features/particles/particles.tsx:45
visibility? ​
optionalvisibility:MaybeRef<boolean | Visibility>
Whether this feature should be visible.
Inherited from ​
Defined in ​
wrappers ​
wrappers:
Wrapper[]
The components to render wrapped around the vue feature