Docs
Getting Started
Updates
GitHub
search
homechevron_rightHelperschevron_rightVfx particles

Geometric Particle VFX Engine

The VFX engine generates particle commands for geometric shapes. Each shape is emitted as a generated function containing pre-computed positions.

This is especially useful when you want repeatable visual effects without manually writing dozens of particle commands. You describe the geometry once and then call the generated function wherever you need it.

Drawing shapes

drawCircle("fire_ring", Particles.FLAME, radius = 5.0, points = 16)

drawShape("soul_helix") {
	shape = Shape.HELIX
	particle = Particles.SOUL_FIRE_FLAME
	radius = 2.0
	points = 40
	height = 5.0
	turns = 4
}
Kotlin

Choosing between helpers

  • Use drawCircle(...) when you only need a quick single-purpose helper.
  • Use drawShape(...) when you want one DSL entry point that can switch shape types or expose more parameters.

Both approaches generate reusable functions, so you can keep expensive geometry decisions at generation time rather than recomputing them mentally for every particle command.

Available shapes

Shape Description
CIRCLE Flat circle on the XZ plane
LINE Straight line along a direction vector
SPHERE Fibonacci-distributed points on a sphere surface
SPIRAL Expanding spiral that rises along Y
HELIX Fixed-radius helix that rises along Y

VfxShape properties

Property Default Used by
particle - All shapes
radius 1.0 CIRCLE, SPHERE, SPIRAL, HELIX
points 20 All shapes
height 3.0 SPIRAL, HELIX
length 5.0 LINE
dx/dy/dz 1,0,0 LINE direction
turns 3 SPIRAL, HELIX

Example: arena intro effect

drawShape("arena_intro") {
	shape = Shape.SPIRAL
	particle = Particles.HAPPY_VILLAGER
	radius = 4.0
	points = 60
	height = 6.0
	turns = 5
}
Kotlin

This kind of effect works well for spawn platforms, ritual circles, victory moments, or waypoint markers.

Published03/03/2026Last updated31/03/2026
Edit this page on GitHub
← PreviousState DelegatesNext →Bindings