Component:BoxEmitter

CollapseComponent image 

Box Emitter component as seen in the Scene Inspector

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. The particle starting colors are lerped based on what corner of the cube the particle generated is closest to.

Fields

Fields Collapse

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. Some components stop their functionality when this field is disabled, but some don't.
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 minimum value of the range of particle count to be emitted when activated as a burst.
BurstOnActivatedMax	Float	The maximum value of the range of particle count to be emitted when activated as a burst.
BurstOnStart	Bool	Whether or not particle bursts should be done on spawn.
Size	Float3	The size of this box emitter.
EmitFromShell	Bool	Enable emitting particles on the outside of the shape instead of from any point within the volume.
DirectionMode	BoxEmitterDirection	What direction to shoot the particles in from the box.
Direction	Float3	Which direction in local space to shoot particles emitted by this emitter.
DirectionTransformMode	DirectionTransformMode	How to determine the transform of the particles made by this emitter at start.
RandomDirectionWeight	Float	How much to randomize the velocity of new particles (this is a magnitude)
DirectionPostTransform	Float3x3	The direction the particles should face as an extra matrix transform after the final particle starting direction has been calculated.
Color0	ColorX	Color of the cube on corner (-x,-z,-y)
Color1	ColorX	Color of the cube on corner (+x,-z,-y)
Color2	ColorX	Color of the cube on corner (+x,+z,-y)
Color3	ColorX	Color of the cube on corner (-x,+z,-y)
Color4	ColorX	Color of the cube on corner (-x,-z,+y)
Color5	ColorX	Color of the cube on corner (+x,-z,+y)
Color6	ColorX	Color of the cube on corner (+x,+z,+y)
Color7	ColorX	Color of the cube on corner (-x,+z,+y)

Usage

Used in creations using particle systems as a source of particles.

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

• Component:ParticleSystem
• Photon Dust