Component:CylinderEmitter: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
update
 
(4 intermediate revisions by 2 users not shown)
Line 3: Line 3:
|Name=Cylinder Emitter
|Name=Cylinder Emitter
}}
}}
{{stub}}
The '''CylinderEmitter''' component is used to emit particles in PhotonDust.


== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|System|'''[[Component:ParticleSystem|ParticleSystem]]'''|TypeAdv0=true|
|System|'''[[Component:ParticleSystem|ParticleSystem]]'''|TypeAdv0=true| The Particle system this emitter is adding particles to.
|Rate|Float|
|Rate|Float| How fast to emit particles
|BurstOnActivatedMin|Float|
|BurstOnActivatedMin|Float| How many paricles to emit at minimum when activated.
|BurstOnActivatedMax|Float|
|BurstOnActivatedMax|Float| How many particles to emit at maximum when activayed
|BurstTimeStart|{{RootFieldType|SyncTime}}|TypeAdv4=true|
|BurstOnStart|Bool| Whether to make a burst when spawning in.
|BurstTimePeriod|Double|
|Radius|Float| The radius of the emitting cylinder shape
|Bursts|{{RootFieldType|SyncLinear`1|[[Type:ParticleBurst|ParticleBurst]]}}|TypeAdv6=true|
|Height|Float| The height of the emitting cylinder shape.
|Radius|Float|
|EmitFromShell|Bool| Whether to emit from the inside (false) or from the surface (true) of the cylinder shape.
|Height|Float|
|ExcludeCaps|Bool| Whether to exclude the ends of the cylinder when emitting particles.
|EmitFromShell|Bool|
|DirectionMode|CylinderEmitterDirection| How to emit particles from the cylinder.
|ExcludeCaps|Bool|
|CapsDirectionMode|CylinderEmitterCapsDirection| how to emit particles from the cylinder caps.
|RandomDirection|Float|
|RandomDirectionWeight|Float| How much randomness should be applied to Particle emission velocity direction.
|ForceDirection|Bool|
|Direction|Float3| The direction vector to emit all particles in.
|ForcedDirection|Float3|
|DirectionTransformMode|DirectionTransformMode| How to handle the direction when emitting particles.
|DirectionPostTransform|Float3x3| The direction particles should be when spawned post transform using a matrix.
}}
}}


== Behavior ==
== Usage ==
{{stub}}


== Examples ==
== Examples ==
Line 31: Line 33:
[[Category:Components:Rendering:Particle System:Emitters{{#translation:}}|Cylinder Emitter]]
[[Category:Components:Rendering:Particle System:Emitters{{#translation:}}|Cylinder Emitter]]
[[Category:Components{{#translation:}}|Cylinder Emitter]]
[[Category:Components{{#translation:}}|Cylinder Emitter]]
[[Category:ComponentStubs]]

Latest revision as of 20:35, 19 March 2025

Component image 
Cylinder Emitter component as seen in the Scene Inspector

The CylinderEmitter component is used to emit particles in PhotonDust.

Fields

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. Some components stop their functionality when this field is disabled, but some don't.
System ParticleSystem The Particle system this emitter is adding particles to.
Rate Float How fast to emit particles
BurstOnActivatedMin Float How many paricles to emit at minimum when activated.
BurstOnActivatedMax Float How many particles to emit at maximum when activayed
BurstOnStart Bool Whether to make a burst when spawning in.
Radius Float The radius of the emitting cylinder shape
Height Float The height of the emitting cylinder shape.
EmitFromShell Bool Whether to emit from the inside (false) or from the surface (true) of the cylinder shape.
ExcludeCaps Bool Whether to exclude the ends of the cylinder when emitting particles.
DirectionMode CylinderEmitterDirection How to emit particles from the cylinder.
CapsDirectionMode CylinderEmitterCapsDirection how to emit particles from the cylinder caps.
RandomDirectionWeight Float How much randomness should be applied to Particle emission velocity direction.
Direction Float3 The direction vector to emit all particles in.
DirectionTransformMode DirectionTransformMode How to handle the direction when emitting particles.
DirectionPostTransform Float3x3 The direction particles should be when spawned post transform using a matrix.

Usage

This article or section is a Stub. You can help the Resonite Wiki by expanding it.

Examples

See Also