net.tridentsdk.effect.particle

Interface ParticleEffect

All Superinterfaces:

Effect<ParticleEffectType>, RemoteEffect<ParticleEffectType>

All Known Implementing Classes:

TridentParticleEffect

public interface ParticleEffect
extends RemoteEffect<ParticleEffectType>

Represents a particle effect

Since:

0.4-alpha

Author:

The TridentSDK Team

Method Summary

Modifier and Type	Method and Description
int	count() Returns the count of how many particles will be spawned
int[]	data() Returns the data of the particle
boolean	longDistance() Returns whether the particle should be long distance
Vector	offset() Returns the offset for each particle
void	setCount(int count) Set the count how many of the effects should be spawned
void	setData(int[] data) Set the data of the particle Only used for ICON_CRACK, BLOCK_CRACK and BLOCK_DUST ICON_CRACK requires array of two integers BLOCK_CRACK and BLOCK_DUST requires an array of a single integer
void	setLongDistance(boolean longDistance) Set the particle to be long distance Increases distance from 256 to 65536
void	setOffset(Vector offset) The randomized offset for each particle If multiple particles are spawned, this will be re-run for each

Methods inherited from interface net.tridentsdk.effect.RemoteEffect

setPosition

Methods inherited from interface net.tridentsdk.effect.Effect

apply, apply, applyToEveryoneExcept, setType, type

Method Detail

setCount

void setCount(int count)

Set the count how many of the effects should be spawned

Parameters:

count - The count how many should be spawned

setLongDistance

void setLongDistance(boolean longDistance)

Set the particle to be long distance
Increases distance from 256 to 65536

Parameters:

longDistance - Whether the particle should be long distance

setData

void setData(int[] data)

Set the data of the particle
Only used for ICON_CRACK, BLOCK_CRACK and BLOCK_DUST
ICON_CRACK requires array of two integers
BLOCK_CRACK and BLOCK_DUST requires an array of a single integer

Parameters:

data - Data of the particle

setOffset

void setOffset(Vector offset)

The randomized offset for each particle
If multiple particles are spawned, this will be re-run for each

Parameters:

offset - The offset for each particle

count

int count()

Returns the count of how many particles will be spawned

Returns:

The count of how many particles will be spawned

longDistance

boolean longDistance()

Returns whether the particle should be long distance

Returns:

Whether the particle should be long distance

data

int[] data()

Returns the data of the particle

Returns:

The data of the particle

offset

Vector offset()

Returns the offset for each particle

Returns:

The offset for each particle