ParticleSystemComponent Class
Namespace: Stride.Particles.ComponentsAssembly: Stride.Particles.dll
Add a ParticleSystem to an Entity
[DataContract("ParticleSystemComponent")]
[Display("Particle system", null, Expand = ExpandRule.Once)]
[DefaultEntityComponentProcessor(typeof(ParticleSystemSimulationProcessor))]
[DefaultEntityComponentRenderer(typeof(ParticleSystemRenderProcessor))]
[ComponentOrder(10200)]
[ComponentCategory("Particles")]
public sealed class ParticleSystemComponent : ActivableEntityComponent, IIdentifiable
Name | Description | |
---|---|---|
Constructors | ||
ParticleSystemComponent() | ||
Fields | ||
Color | The color shade will be applied to all particles (via their materials) during rendering. The shade acts as a color scale multiplication, making the color darker. White shade is neutral. |
|
Control | ||
Properties | ||
ParticleSystem | The particle system associated with this component |
|
RenderGroup | The render group for this component. |
|
Speed | The speed scale at which the particle simulation runs. Increasing the scale increases the simulation speed, while setting it to 0 effectively pauses the simulation. |
|
Methods | ||
Finalize() |
Constructors
ParticleSystemComponent()
public ParticleSystemComponent()
Fields
Color
The color shade will be applied to all particles (via their materials) during rendering. The shade acts as a color scale multiplication, making the color darker. White shade is neutral.
[DataMember(4)]
[Display("Color shade", null)]
public Color4 Color
Field Value
Type | Description |
---|---|
Color4 |
Control
[DataMember(1)]
[Display("Editor control", null)]
public ParticleSystemControl Control
Field Value
Type | Description |
---|---|
ParticleSystemControl |
Properties
ParticleSystem
The particle system associated with this component
[DataMember(10)]
[Display("Source", null)]
public ParticleSystem ParticleSystem { get; }
Property Value
Type | Description |
---|---|
ParticleSystem |
RenderGroup
The render group for this component.
[DataMember(50)]
[Display("Render group", null)]
public RenderGroup RenderGroup { get; set; }
Property Value
Type | Description |
---|---|
RenderGroup |
Speed
The speed scale at which the particle simulation runs. Increasing the scale increases the simulation speed, while setting it to 0 effectively pauses the simulation.
[DataMember(5)]
[DataMemberRange(0, 10, 0.01, 1, 3)]
[Display("Speed scale", null)]
public float Speed { get; set; }
Property Value
Type | Description |
---|---|
System.Single |
Methods
Finalize()
protected void Finalize()