Package mindustry.entities.effect

Class ParticleEffect

java.lang.Object

mindustry.entities.Effect

mindustry.entities.effect.ParticleEffect

public class ParticleEffect
extends Effect

The most essential effect class. Can create particles in various shapes.

Nested Class Summary

Nested classes/interfaces inherited from class mindustry.entities.Effect

Effect.EffectContainer

Field Summary

Fields

Modifier and Type	Field	Description
float	baseLength
boolean	cap
boolean	casingFlip	Gives the effect flipping compatability like casing effects.
arc.graphics.Color	colorFrom	Particle color.
arc.math.Interp	colorInterp	Particle color interpolation.
arc.graphics.Color	colorTo	Particle color.
float	cone
float	heightChangeStart	Controls the amount of ticks the effect waits before changing height.
float	heightFrom	Particle width and height properties as a ratio of its radius.
arc.math.Interp	heightInterp	Particle height interpolation.
float	heightTo	Particle width and height properties as a ratio of its radius.
arc.math.Interp	interp	Particle size/length/radius interpolation.
float	lenFrom
float	length
float	lenTo
arc.graphics.Color	lightColor	Color of the light each particle emits.
float	lightOpacity	Particle light properties.
float	lightScl	Particle light properties.
boolean	line
float	offset	Rotation offset.
float	offsetX	Offset position of the particle.
float	offsetY	Offset position of the particle.
int	particles	Number of particles created.
boolean	randLength	If true, the particle's length is set in a random range from 0 to length.
String	region	Sprite to draw.
float	sizeChangeStart	Controls the amount of ticks the effect waits before changing size.
float	sizeFrom	Controls the initial and final sprite sizes.
arc.math.Interp	sizeInterp	Particle size interpolation.
float	sizeTo	Controls the initial and final sprite sizes.
float	spin	Spin in degrees per tick.
float	strokeFrom
float	strokeTo
boolean	useRotation	Whether the rotation adds with the parent
float	widthChangeStart	Controls the amount of ticks the effect waits before changing width.
float	widthFrom	Particle width and height properties as a ratio of its radius.
arc.math.Interp	widthInterp	Particle width interpolation.
float	widthTo	Particle width and height properties as a ratio of its radius.

Fields inherited from class mindustry.entities.Effect

all, baseRotation, clip, followParent, id, layer, layerDuration, lifetime, renderer, rotWithParent, startDelay

Constructor Summary

Constructors

Constructor	Description
ParticleEffect()

Method Summary

Modifier and Type	Method	Description
void	init()
void	render(Effect.EffectContainer e)

Methods inherited from class mindustry.entities.Effect

add, at, at, at, at, at, at, at, at, at, baseRotation, create, decal, decal, floorDust, floorDustAngle, followParent, get, layer, layer, render, rotWithParent, rubble, scorch, shake, shake, shockwaveDust, shockwaveDust, shouldCreate, startDelay, wrap, wrap

Methods inherited from class java.lang.Object

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

Field Details

colorFrom

public arc.graphics.Color colorFrom

Particle color.

colorTo

public arc.graphics.Color colorTo

Particle color.

particles

public int particles

Number of particles created.

randLength

public boolean randLength

If true, the particle's length is set in a random range from 0 to length.

casingFlip

public boolean casingFlip

Gives the effect flipping compatability like casing effects.

cone

public float cone

length

public float length

baseLength

public float baseLength

interp

public arc.math.Interp interp

Particle size/length/radius interpolation.

sizeInterp

@Nullable
public arc.math.Interp sizeInterp

Particle size interpolation. Null to use interp.

colorInterp

@Nullable
public arc.math.Interp colorInterp

Particle color interpolation. Null to use interp.

offsetX

public float offsetX

Offset position of the particle.

offsetY

public float offsetY

Offset position of the particle.

lightScl

public float lightScl

Particle light properties.

lightOpacity

public float lightOpacity

Particle light properties.

lightColor

@Nullable
public arc.graphics.Color lightColor

Color of the light each particle emits.

spin

public float spin

Spin in degrees per tick.

sizeFrom

public float sizeFrom

Controls the initial and final sprite sizes.

sizeTo

public float sizeTo

Controls the initial and final sprite sizes.

sizeChangeStart

public float sizeChangeStart

Controls the amount of ticks the effect waits before changing size.

widthChangeStart

public float widthChangeStart

Controls the amount of ticks the effect waits before changing width.

heightChangeStart

public float heightChangeStart

Controls the amount of ticks the effect waits before changing height.

useRotation

public boolean useRotation

Whether the rotation adds with the parent

offset

public float offset

Rotation offset.

region

public String region

Sprite to draw.

widthFrom

public float widthFrom

Particle width and height properties as a ratio of its radius. Does nothing to line particles.

widthTo

public float widthTo

Particle width and height properties as a ratio of its radius. Does nothing to line particles.

heightFrom

public float heightFrom

Particle width and height properties as a ratio of its radius. Does nothing to line particles.

heightTo

public float heightTo

Particle width and height properties as a ratio of its radius. Does nothing to line particles.

widthInterp

@Nullable
public arc.math.Interp widthInterp

Particle width interpolation. Null to use sizeInterp.

heightInterp

@Nullable
public arc.math.Interp heightInterp

Particle height interpolation. Null to use sizeInterp.

line

public boolean line

strokeFrom

public float strokeFrom

strokeTo

public float strokeTo

lenFrom

public float lenFrom

lenTo

public float lenTo

cap

public boolean cap

Constructor Details

ParticleEffect

public ParticleEffect()

Method Details

init

public void init()

Overrides:

init in class Effect

render

public void render(Effect.EffectContainer e)

Overrides:

render in class Effect