Particles

From Pragma
Jump to: navigation, search

Base Parameters

  • bloom_scale <scale>

The amount of bloom that should be applied to the particles in this system. The default is 0, which means bloom is turned off.

  • color <r> <g> <b> <alpha>

The base color of the particles.

  • emission_rate <particlesPerSecond>

The amount of particles that will be emitted per second, until the max particle count is reached.

  • loop <1/0>

The particle system will keep looping until it's stopped.

  • material <material>

The material to use for the particles within this system.

  • maxparticles <particleCount>

The amount of currently active particles cannot exceed this amount.
Be careful not to set this value too high or you will end up wasting memory and performance.

  • orientation_type <type>

The following types are available:

PARTICLE_ORIENTATION_TYPE_ALIGNED
Default. The particle will always face the screen.

PARTICLE_ORIENTATION_TYPE_UPRIGHT
Same as aligned, but the particle will only rotate around the y-axis.

PARTICLE_ORIENTATION_TYPE_STATIC
The orientation to the screen will have no effect on the particle's rotation.

  • origin <x> <y> <z>

The position offset local to the particle system.

  • sort_particles <1/0>

Very expensive. Only use if particles are incorrectly displayed behind other particles.

Initializers

alpha_random
Chooses a random alpha between the specified values for each new particle.

  • alpha_min <alpha>

Minimum alpha value.

  • alpha_max <alpha>

Maximum alpha value.

color_random
Every new particle will be assigned a random color between 'color1' and 'color2'.

  • color1 <r> <g> <b> <alpha>

Minimum color.

  • color2 <r> <g> <b> <alpha>

Maximum color.

initial_velocity
Allows you to set a starting velocity for all particles.

  • velocity <x> <y> <z>

The main direction and speed.

  • spread_min <spread>

Minimum spread about the direction of the specified velocity.

  • spread_max <spread>

Maximum spread about the direction of the specified velocity.

lifetime_random
The lifetime after which each particle will be removed.

  • lifetime_min <min>

The minimum time after which particles are removed.

  • lifetime_max <max>

The maximum time after which particles are removed.

position_random_box
Places each new particle in a random position within the bounds of the specified AABB.

  • min <x> <y> <z>

The minimum Vector of the AABB.

  • max <x> <y> <z>

The maximum Vector of the AABB.

position_random_sphere
Places each new particle within the radius of the sphere.

  • distance_min <distance>

The minimum radius.

  • distance_max <distance>

The maximum radius.

  • distance_bias <x> <y> <z>

Can be used to change the radius for specific axes. (e.g. Setting 'y' to 0 will place all particles on a flat sphere)

radius_random
Places the particle around a random radius around the origin of the particle system.

  • radius_min <radius>

Minimum radius.

  • radius_max <radius>

Maximum radius.

rotation_random
All particles will start with a random rotation between the specified values.

  • rotation_min <rot>

Minimum rotation.

  • rotation_max <rot>

Maximum rotation.

Operators

color_fade
Allows you to fade to a different color over the specified time.

  • color <r> <g> <alpha>

The color to fade to.

  • fade_start

The time after which it should start fading.

  • fade_end <time>

The time at which the fade should be complete.

physics
Use this initializer to activate particle physics. Use sparingly!

  • collision_group <collisionGroup>
  • collision_mask <collisionMask>
  • contact_offset <contactOffset>
  • damping <damping>
  • dynamic_friction <friction>
  • external_acceleration <x> <y> <z>
  • mass <mass>
  • max_speed <speed>
  • rest_offset <offset>
  • rest_offset_scale <scale>
  • restitution <restitution>
  • static_friction <friction>
  • use_dynamic_collision <1/0>
  • use_twoway_collision <1/0>



velocity
Applies the specified force constantly.

  • velocity <x> <y> <z>

The force to apply.

== Renderers ==