Skip to content

Particles

Auto-generated from src/stdlib/particles.mcrs — do not edit manually.

API


hearts_at

Spawns heart particles at a block position.

redscript
fn hearts_at(x: int, y: int, z: int)

Parameters

ParameterDescription
xX coordinate
yY coordinate
zZ coordinate

flames

Spawns flame particles at a block position.

redscript
fn flames(x: int, y: int, z: int)

Parameters

ParameterDescription
xX coordinate
yY coordinate
zZ coordinate

smoke

Spawns large smoke particles at a block position.

redscript
fn smoke(x: int, y: int, z: int)

Parameters

ParameterDescription
xX coordinate
yY coordinate
zZ coordinate

explosion_effect

Spawns an explosion particle at a block position.

redscript
fn explosion_effect(x: int, y: int, z: int)

Parameters

ParameterDescription
xX coordinate
yY coordinate
zZ coordinate

sparkles_at

Spawns enchantment sparkles at a block position.

redscript
fn sparkles_at(x: int, y: int, z: int)

Parameters

ParameterDescription
xX coordinate
yY coordinate
zZ coordinate

angry_at

Spawns angry villager particles at a block position.

redscript
fn angry_at(x: int, y: int, z: int)

Parameters

ParameterDescription
xX coordinate
yY coordinate
zZ coordinate

happy_at

Spawns happy villager particles at a block position.

redscript
fn happy_at(x: int, y: int, z: int)

Parameters

ParameterDescription
xX coordinate
yY coordinate
zZ coordinate

portal_effect

Spawns portal particles at a block position.

redscript
fn portal_effect(x: int, y: int, z: int)

Parameters

ParameterDescription
xX coordinate
yY coordinate
zZ coordinate

totem_at

Spawns totem particles at a block position.

redscript
fn totem_at(x: int, y: int, z: int)

Parameters

ParameterDescription
xX coordinate
yY coordinate
zZ coordinate

end_sparkles_at

Spawns end rod particles at a block position.

redscript
fn end_sparkles_at(x: int, y: int, z: int)

Parameters

ParameterDescription
xX coordinate
yY coordinate
zZ coordinate

particle_at_fx

Spawns a particle at a fixed-point position expressed as blocks ×100. This helper emits a raw command so sub-block coordinates are preserved.

redscript
fn particle_at_fx(x_fx: int, y_fx: int, z_fx: int, particle: string)

Parameters

ParameterDescription
x_fxX coordinate in blocks ×100
y_fxY coordinate in blocks ×100
z_fxZ coordinate in blocks ×100
particleParticle ID such as minecraft:flame

draw_line_2d

Draws a straight 2D particle line using linear interpolation. Coordinates are fixed-point blocks ×100; z is also passed in ×100.

redscript
fn draw_line_2d(x0: int, y0: int, x1: int, y1: int, steps: int, z: int, particle: string)

Parameters

ParameterDescription
x0Start X in blocks ×100
y0Start Y in blocks ×100
x1End X in blocks ×100
y1End Y in blocks ×100
stepsNumber of interpolation steps
zZ plane in blocks ×100
particleParticle ID such as minecraft:dust

draw_circle

Draws a circle in the XZ plane using cos_fixed and sin_fixed. Center coordinates are whole blocks; radius is blocks ×100.

redscript
fn draw_circle(cx: int, cy: int, cz: int, r: int, steps: int, particle: string)

Parameters

ParameterDescription
cxCenter X in blocks
cyCenter Y in blocks
czCenter Z in blocks
rRadius in blocks ×100
stepsNumber of particle samples around the circle
particleParticle ID such as minecraft:end_rod

draw_helix

Draws a helix spiral with configurable radius, height, and turns. Center coordinates are whole blocks; radius is blocks ×100.

redscript
fn draw_helix(cx: int, cy_start: int, cz: int, r: int, height: int, rotations: int, steps: int, particle: string)

Parameters

ParameterDescription
cxCenter X in blocks
cy_startStarting Y coordinate in blocks
czCenter Z in blocks
rRadius in blocks ×100
heightTotal helix height in blocks
rotationsNumber of full turns
stepsNumber of particle samples
particleParticle ID such as minecraft:portal

particle_dot

Spawns exactly one particle at integer block coordinates.

redscript
fn particle_dot(x: int, y: int, z: int, particle: string)

Parameters

ParameterDescription
xX coordinate in whole blocks
yY coordinate in whole blocks
zZ coordinate in whole blocks
particleParticle ID such as minecraft:flame

Released under the MIT License.