Component:CircleEmitter: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
add info
 
Line 3: Line 3:
|Name=Circle Emitter
|Name=Circle Emitter
}}
}}
{{stub}}
Circle emitters are used with [[Component:ParticleSystem|Particle Systems]] to emit new particles into the system from a circle shaped source.


== Usage ==
== Usage ==
{{Table ComponentFields
{{Table ComponentFields
|System|'''[[Component:ParticleSystem|ParticleSystem]]'''|TypeAdv0=true|
|System|'''[[Component:ParticleSystem|ParticleSystem]]'''|TypeAdv0=true| The system to emit particles into.
|Rate|Float|
|Rate|Float| How many particles per second this emitter should emit particles.
|BurstOnActivatedMin|Float|
|BurstOnActivatedMin|Float| The min value of a range of particles that emit at a random amount after activation of the component's hierarchy.
|BurstOnActivatedMax|Float|
|BurstOnActivatedMax|Float| The max value of a range of particles that emit at a random amount after activation of the component's hierarchy.
|BurstTimeStart|{{RootFieldType|SyncTime}}|TypeAdv4=true|
|BurstTimeStart|{{RootFieldType|SyncTime}}|TypeAdv4=true| how many seconds after activation of the component's hierarchy that the burst should happen.
|BurstTimePeriod|Double|
|BurstTimePeriod|Double| How long the burst emission should last.
|Bursts|{{RootFieldType|SyncLinear`1|[[Type:ParticleBurst|ParticleBurst]]}}|TypeAdv6=true|
|Bursts|{{RootFieldType|SyncLinear`1|[[Type:ParticleBurst|ParticleBurst]]}}|TypeAdv6=true| A list of bursts that's only modifiable using [[Mods]].
|Radius|Float|
|Radius|Float| How big the circle is.
|EmitFromShell|Bool|
|EmitFromShell|Bool| Emit only from the edge of the circle.
|RandomDirection|Float|
|RandomDirection|Float| How much velocity to randomly add to each particle from this emitter.
|ForceDirection|Bool|
|ForceDirection|Bool| Whether to force particles in <code>ForcedDirection</code> when they are emitted by this emitter.
|ForcedDirection|Float3|
|ForcedDirection|Float3| The initial force each particle should have emitted by this emitter.
}}
}}


Line 29: Line 29:
[[Category:Components:Rendering:Particle System:Emitters{{#translation:}}|Circle Emitter]]
[[Category:Components:Rendering:Particle System:Emitters{{#translation:}}|Circle Emitter]]
[[Category:Components{{#translation:}}|Circle Emitter]]
[[Category:Components{{#translation:}}|Circle Emitter]]
[[Category:ComponentStubs]]

Latest revision as of 17:02, 16 October 2024

Component image 
Circle Emitter component as seen in the Scene Inspector

Circle emitters are used with Particle Systems to emit new particles into the system from a circle shaped source.

Usage

Fields
Name Type Description
persistent Bool Determines whether or not this item will be saved to the server.
UpdateOrder Int Controls the order in which this component is updated.
Enabled Bool Controls whether or not this component is enabled.
System ParticleSystem The system to emit particles into.
Rate Float How many particles per second this emitter should emit particles.
BurstOnActivatedMin Float The min value of a range of particles that emit at a random amount after activation of the component's hierarchy.
BurstOnActivatedMax Float The max value of a range of particles that emit at a random amount after activation of the component's hierarchy.
BurstTimeStart direct SyncTime how many seconds after activation of the component's hierarchy that the burst should happen.
BurstTimePeriod Double How long the burst emission should last.
Bursts direct SyncLinear`1<ParticleBurst> A list of bursts that's only modifiable using Mods.
Radius Float How big the circle is.
EmitFromShell Bool Emit only from the edge of the circle.
RandomDirection Float How much velocity to randomly add to each particle from this emitter.
ForceDirection Bool Whether to force particles in ForcedDirection when they are emitted by this emitter.
ForcedDirection Float3 The initial force each particle should have emitted by this emitter.

Behavior

Examples

See Also