Class ParticleSpec.Builder

java.lang.Object

net.ixdarklord.coolcatcanvas.api.client.vfx.ParticleSpec.Builder

Enclosing class:

ParticleSpec

public static final class ParticleSpec.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
ParticleSpec	build()
ParticleSpec.Builder	color(int rgb)	One colour for its whole life, as 0xRRGGBB.
ParticleSpec.Builder	color(int startRgb, int endRgb)	A colour that shifts over its life, as 0xRRGGBB.
ParticleSpec.Builder	colorEasing(Easing easing)
ParticleSpec.Builder	drag(float drag)	What its speed is multiplied by each tick: 1 keeps it, 0.9 slows it quickly.
ParticleSpec.Builder	gravity(float gravity)	Blocks a tick it speeds up downwards, each tick.
ParticleSpec.Builder	lifetime(int ticks)	How long it lives, in ticks.
ParticleSpec.Builder	lifetime(int minTicks, int maxTicks)	Each particle lives a random number of ticks in this range, so a burst doesn't vanish all at once.
ParticleSpec.Builder	opacity(Curve opacity)	Its opacity over its life, 0 to 1.
ParticleSpec.Builder	randomRoll()	Starts each particle at a random angle.
ParticleSpec.Builder	shape(ParticleSpec.Shape shape)
ParticleSpec.Builder	size(float size)
ParticleSpec.Builder	size(Curve size)	Half the width of its quad over its life, in blocks.
ParticleSpec.Builder	spin(Curve radiansPerTick)	How fast it turns over its life, in radians a tick.
ParticleSpec.Builder	stretch(float ticks)	For a ParticleSpec.Shape.SPARK: how many ticks of motion its length covers.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

shape

public ParticleSpec.Builder shape(ParticleSpec.Shape shape)

lifetime

public ParticleSpec.Builder lifetime(int ticks)

How long it lives, in ticks.

lifetime

public ParticleSpec.Builder lifetime(int minTicks,
 int maxTicks)

Each particle lives a random number of ticks in this range, so a burst doesn't vanish all at once.

size

public ParticleSpec.Builder size(Curve size)

Half the width of its quad over its life, in blocks. A ParticleSpec.Shape.SPARK's is its thickness.

size

public ParticleSpec.Builder size(float size)

opacity

public ParticleSpec.Builder opacity(Curve opacity)

Its opacity over its life, 0 to 1.

color

public ParticleSpec.Builder color(int rgb)

One colour for its whole life, as 0xRRGGBB.

color

public ParticleSpec.Builder color(int startRgb,
 int endRgb)

A colour that shifts over its life, as 0xRRGGBB. The shift runs around the colour wheel, so it stays vivid on the way instead of passing through grey.

colorEasing

public ParticleSpec.Builder colorEasing(Easing easing)

spin

public ParticleSpec.Builder spin(Curve radiansPerTick)

How fast it turns over its life, in radians a tick. Each particle turns one way or the other at random.

randomRoll

public ParticleSpec.Builder randomRoll()

Starts each particle at a random angle.

gravity

public ParticleSpec.Builder gravity(float gravity)

Blocks a tick it speeds up downwards, each tick. Negative to rise.

drag

public ParticleSpec.Builder drag(float drag)

What its speed is multiplied by each tick: 1 keeps it, 0.9 slows it quickly.

stretch

public ParticleSpec.Builder stretch(float ticks)

For a ParticleSpec.Shape.SPARK: how many ticks of motion its length covers.

build

public ParticleSpec build()