Home

🍩 Sprinkle Wiki

v0.1.0 | 05-01-2022

A wrapper for GameMaker's native particle functions.

Adds syntactic sugar by using GML 2.3+ syntax to implement 'method-chaining', allowing code to be written faster and be more legible.

While this library contains extensive JSDoc documentation, this wiki will help you understand what this library covers and how to get the most out of using it.

Sprinkle is supported for all platforms.

Function Index

ParticleSystem()

Basic Methods

• .exists()
• .clear()
• .destroy()
• .clearParticles()
• .destroyEmitters()

Layers/Depth

• .createLayer(layerID,persistent)
• .getLayer()
• .setLayer(layerID)
• .setDepth(depth)
• .position(x,y)

Particles

• .createParticle(x,y,type,num)
• .getCount()

Update/Drawing

• .update()
• .draw()
• .autoUpdate()
• .autoDraw()
• .drawOrder(frontToBack)

ParticleEmitter()

Basic Methods

• .exists()
• .clear()
• .destroy()

Properties

• .burst(type, num)
• .region(x1, y1, x2, y2, shape, distrubtion)
• .stream(type, num)

ParticleType()

Basic Methods

• .exists()
• .clear()
• .destroy()

Properties

• .alpha(alpha1, [alpha2], [alpha3])*
• .blend(additive)*
• .color(color1, [color2], [color3]) / colour(colour1, [colour2], [colour3])*
• .direction(min, max, [increase], [wiggle]`*
• .gravity(amount, direction)*
• .life(min, max)*
• .orientation(min, max, [increase], [wiggle], [relative])*
• .scale(xscale, yscale)*
• .shape(shape)*
• .size(min, max, [increase], [wiggle])*
• .speed(min, max, [increase], [wiggle])*
• .sprite(sprite, anim, stretch, random)*

Stream/Burst

• .step(type, num)*
• .death(type, num)*