Annotation Interface EmitterInfo

@Target(TYPE) @Retention(RUNTIME) @Inherited public @interface EmitterInfo
This annotation contains default values for the initialization of an emitter.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    activateOnInit
    Indicates whether the emitter should be activated on initialization.
    int
    duration
    Specifies the duration of the emitter.
    int
    maxParticles
    Specifies the maximum number of particles the emitter can have.
    Align
    originAlign
    Specifies the horizontal alignment of the emitter's origin.
    Valign
    originValign
    Specifies the vertical alignment of the emitter's origin.
    int
    particleMaxTTL
    Specifies the maximum time-to-live (TTL) of particles.
    int
    particleMinTTL
    Specifies the minimum time-to-live (TTL) of particles.
    ParticleType
    particleType
    Specifies the type of particles emitted.
    int
    particleUpdateRate
    Specifies the update rate of particles.
    Quality
    requiredQuality
    Specifies the required quality level for the emitter.
    int
    spawnAmount
    Specifies the amount of particles to spawn.
    int
    spawnRate
    Specifies the rate at which particles are spawned.

  • Element Details

    • activateOnInit

      boolean activateOnInit
      Indicates whether the emitter should be activated on initialization.
      Returns:
      true if the emitter should be activated on initialization, false otherwise.
      Default:
      true

    • duration

      int duration
      Specifies the duration of the emitter.
      Returns:
      the duration of the emitter in milliseconds.
      Default:
      0

    • maxParticles

      int maxParticles
      Specifies the maximum number of particles the emitter can have.
      Returns:
      the maximum number of particles.
      Default:
      400

    • particleMaxTTL

      int particleMaxTTL
      Specifies the maximum time-to-live (TTL) of particles.
      Returns:
      the maximum TTL of particles in milliseconds.
      Default:
      1500

    • particleMinTTL

      int particleMinTTL
      Specifies the minimum time-to-live (TTL) of particles.
      Returns:
      the minimum TTL of particles in milliseconds.
      Default:
      400

    • particleUpdateRate

      int particleUpdateRate
      Specifies the update rate of particles.
      Returns:
      the update rate of particles in milliseconds.
      Default:
      40

    • spawnAmount

      int spawnAmount
      Specifies the amount of particles to spawn.
      Returns:
      the amount of particles to spawn.
      Default:
      20

    • spawnRate

      int spawnRate
      Specifies the rate at which particles are spawned.
      Returns:
      the spawn rate of particles in milliseconds.
      Default:
      100

    • originAlign

      Align originAlign
      Specifies the horizontal alignment of the emitter's origin.
      Returns:
      the horizontal alignment of the emitter's origin.
      Default:
      CENTER

    • originValign

      Valign originValign
      Specifies the vertical alignment of the emitter's origin.
      Returns:
      the vertical alignment of the emitter's origin.
      Default:
      MIDDLE

    • requiredQuality

      Quality requiredQuality
      Specifies the required quality level for the emitter.
      Returns:
      the required quality level.
      Default:
      VERYLOW

    • particleType

      ParticleType particleType
      Specifies the type of particles emitted.
      Returns:
      the type of particles emitted.
      Default:
      RECTANGLE