Search Results for

    Show / Hide Table of Contents

    Class RateSpawn

    Spawns based on rate.

    Inheritance
    object
    BaseSpawn
    BaseSpawn<SpawnRateDescription>
    RateSpawn
    Inherited Members
    BaseSpawn<SpawnRateDescription>.Description
    BaseSpawn.firstEmit
    BaseSpawn.CreateFromDescription(SpawnDescription)
    Namespace: Evergine.Framework.Particles.Spawn
    Assembly: Evergine.Framework.dll
    Syntax
    public class RateSpawn : BaseSpawn<SpawnRateDescription>

    Constructors

    RateSpawn(SpawnRateDescription)

    Initializes a new instance of the RateSpawn class.

    Declaration
    public RateSpawn(SpawnRateDescription rateDescription)
    Parameters
    Type Name Description
    SpawnRateDescription rateDescription

    The emission rate description.

    Properties

    Duration

    Gets or sets the duration of the emission in seconds. If the value is 0, it doesn't stop emitting.

    Declaration
    [RenderProperty(Tooltip = "The time in seconds that the particle will be emitting.")]
    public float Duration { get; set; }
    Property Value
    Type Description
    float

    Rate

    Gets or sets the number of particles that are spawned per second by the emitter.

    Declaration
    [RenderProperty(Tooltip = "The number of particles per second that will be emitted.")]
    public float Rate { get; set; }
    Property Value
    Type Description
    float

    Methods

    Reset()

    Resets the spawning behavior.

    Declaration
    public override void Reset()
    Overrides
    BaseSpawn.Reset()

    SpawnParticles(TimeSpan, EmitterSimulator)

    Method that decides how many particles are spawned.

    Declaration
    public override uint SpawnParticles(TimeSpan ellapsedTime, EmitterSimulator emitter)
    Parameters
    Type Name Description
    TimeSpan ellapsedTime
    EmitterSimulator emitter

    The emitter simulator.

    Returns
    Type Description
    uint

    The number of new particles.

    Overrides
    BaseSpawn.SpawnParticles(TimeSpan, EmitterSimulator)

    Extension Methods

    ReflectionHelper.GetMemberAssembly(object)
    ReflectionHelper.GetTypeName(object)
    In this article
    Back to top
    Generated by DocFX