Coming soon toSteam
Modding docsAPI 1

Module · Engine client only

effects

Particle effects — sparks, smoke, fire, glows. Start from a preset and tune it. Needs the "world" permission.

effects.burst(preset: string, position: vec3, options?: any)

client onlyneeds world

Plays an effect once at a place and cleans it up afterwards.

effects.burst("sparks", hit.point)
effects.burst("explosion", pos, { color = color("#80c0ff"), count = 300 })

effects.presets(): string[]

client only

The effect presets you can start from.

effects.start(preset: string, position: vec3, options?: any): Effect

client onlyneeds world

Starts an effect that keeps going until you stop or destroy it.

local flame = effects.start("fire", torch.position)
flame:follow(torch, vec3(0, 0.4, 0))