Automated: create new component page |
Add a bit of info |
||
(3 intermediate revisions by the same user not shown) | |||
Line 3: | Line 3: | ||
|Name=Box Emitter | |Name=Box Emitter | ||
}} | }} | ||
Box emitter is a component that is used in conjunction with [[Component:ParticleSystem|Particle System]] and [[Component:ParticleStyle|Particle Style]]. It allows for adding particles into a Particle system with a rate, and does them inside or along the outside of the box area specified. | |||
== Usage == | == Usage == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|System|'''[[Component:ParticleSystem|ParticleSystem]]'''|TypeAdv0=true| | |System|'''[[Component:ParticleSystem|ParticleSystem]]'''|TypeAdv0=true| The particle system to get data from like style and particle count limits | ||
|Rate|Float| | |Rate|Float| how fast to emit particles into the system. | ||
|BurstOnActivatedMin|Float| | |BurstOnActivatedMin|Float| the min value of the range of particles to be emitted when activated. | ||
|BurstOnActivatedMax|Float| | |BurstOnActivatedMax|Float| the max value of the range of particles to be emitted when activated. | ||
|BurstTimeStart|{{RootFieldType|SyncTime}}|TypeAdv4=true| | |BurstTimeStart|{{RootFieldType|SyncTime}}|TypeAdv4=true|Internal. | ||
|BurstTimePeriod|Double| | |BurstTimePeriod|Double|How long to emit the particles after activation for the burst effect. | ||
|Bursts|{{RootFieldType|SyncLinear`1|[[Type:ParticleBurst|ParticleBurst]]}}|TypeAdv6=true| | |Bursts|{{RootFieldType|SyncLinear`1|[[Type:ParticleBurst|ParticleBurst]]}}|TypeAdv6=true| A list of different bursts with times and amounts. This field is only editable with [[Mods]] | ||
|RandomDirection|Float| | |RandomDirection|Float| How much random velocity to add to the particles. | ||
|Size|Float3| | |Size|Float3| The size of this box emitter. | ||
|AlwaysForceDirection|Bool| | |AlwaysForceDirection|Bool| | ||
|Direction|Float3| | |Direction|Float3| Which direction in local space to shoot particles emitted by this emitter | ||
|EmitFromShell|Bool| | |EmitFromShell|Bool| Enable emitting particles on the outside of the box instead of from any point within the volume. | ||
|Color0|ColorX| | |Color0|ColorX| | ||
|Color1|ColorX| | |Color1|ColorX| | ||
Line 32: | Line 32: | ||
== Examples == | == Examples == | ||
Useful to make fireflies in an area, for a calming nighttime aura. It can also be used to make leaves fall from trees by making a box around the tree leaves, or as wind particles in a breezy field. | |||
== See Also == | == See Also == |
Latest revision as of 15:43, 7 November 2024
Component image
Box emitter is a component that is used in conjunction with Particle System and Particle Style. It allows for adding particles into a Particle system with a rate, and does them inside or along the outside of the box area specified.
Usage
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 particle system to get data from like style and particle count limits |
Rate
|
Float | how fast to emit particles into the system. |
BurstOnActivatedMin
|
Float | the min value of the range of particles to be emitted when activated. |
BurstOnActivatedMax
|
Float | the max value of the range of particles to be emitted when activated. |
BurstTimeStart
|
direct SyncTime | Internal. |
BurstTimePeriod
|
Double | How long to emit the particles after activation for the burst effect. |
Bursts
|
direct SyncLinear`1<ParticleBurst> | A list of different bursts with times and amounts. This field is only editable with Mods |
RandomDirection
|
Float | How much random velocity to add to the particles. |
Size
|
Float3 | The size of this box emitter. |
AlwaysForceDirection
|
Bool | |
Direction
|
Float3 | Which direction in local space to shoot particles emitted by this emitter |
EmitFromShell
|
Bool | Enable emitting particles on the outside of the box instead of from any point within the volume. |
Color0
|
ColorX | |
Color1
|
ColorX | |
Color2
|
ColorX | |
Color3
|
ColorX | |
Color4
|
ColorX | |
Color5
|
ColorX | |
Color6
|
ColorX | |
Color7
|
ColorX |
Behavior
Examples
Useful to make fireflies in an area, for a calming nighttime aura. It can also be used to make leaves fall from trees by making a box around the tree leaves, or as wind particles in a breezy field.