GPU Particles

self:set_sub_emitter

Client

Spawns the particles of another emitter wherever this emitter's particles are

Syntax

local status = self:set_sub_emitter(
    emitter,
    mode = particle.gpu.sub_emitter_mode.AT_COLLISION,
    amount = 1,
    frequency = 10
)

The sub-emitter only emits what its parent spawns for it.

Parameters

TypeNameDescription
particleemitterEmitter whose particles are spawned, must be another emitter
particle.gpu.sub_emitter_modemodeDetermines when the sub-emitter spawns
intamountNumber of particles spawned each time, at least 1
floatfrequencySpawns per second, only used by CONSTANT

Returns

TypeNameDescription
boolstatustrue on successful execution, false otherwise

Examples

Splash droplets where rain lands
particle.gpu.set_world_collision(true)

-- droplets thrown up from every landing
local splash = particle.gpu.create()
splash:set_amount(1500)
splash:set_lifetime(0.45)
splash:set_direction({0, 1, 0})
splash:set_spread(60)
splash:set_gravity({0, -9.8, 0})
splash:set_local_coords(false)

-- rain that disappears on contact and spawns 3 droplets
local rain = particle.gpu.create()
rain:set_amount(6000)
rain:set_lifetime(3.6)
rain:set_emission_shape(particle.gpu.emission_shape.BOX, {17, 0.2, 17})
rain:set_direction({0, -1, 0})
rain:set_gravity({0, 0, 0})
rain:set_local_coords(false)
rain:set_collision(particle.gpu.collision_mode.HIDE)
rain:set_sub_emitter(splash, particle.gpu.sub_emitter_mode.AT_COLLISION, 3)

On this page