net.tridentsdk.server.effect.particle

Class TridentParticleEffect

java.lang.Object

net.tridentsdk.server.effect.TridentEffect<T>

net.tridentsdk.server.effect.TridentRemoteEffect<ParticleEffectType>

net.tridentsdk.server.effect.particle.TridentParticleEffect

All Implemented Interfaces:

Effect<ParticleEffectType>, ParticleEffect, RemoteEffect<ParticleEffectType>

public class TridentParticleEffect
extends TridentRemoteEffect<ParticleEffectType>
implements ParticleEffect

Represents a particle effect

Author:

The TridentSDK Team

Constructor Summary

Constructors

Constructor and Description
TridentParticleEffect(World world, ParticleEffectType type)

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
OutPacket	getPacket()
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
void	setPosition(Vector vector) Set the position of the effect
void	setType(ParticleEffectType type) Set the type of the effect
ParticleEffectType	type() The type of the effect

Methods inherited from class net.tridentsdk.server.effect.TridentEffect

apply, apply, applyToEveryoneExcept

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.tridentsdk.effect.Effect

apply, apply, applyToEveryoneExcept

Constructor Detail

TridentParticleEffect

public TridentParticleEffect(World world,
                             ParticleEffectType type)

Method Detail

type

public ParticleEffectType type()

Description copied from interface: Effect

The type of the effect

Specified by:

type in interface Effect<ParticleEffectType>

Returns:

The type of the effect

setType

public void setType(ParticleEffectType type)

Description copied from interface: Effect

Set the type of the effect

Specified by:

setType in interface Effect<ParticleEffectType>

Parameters:

type - The type of the effect

setPosition

public void setPosition(Vector vector)

Description copied from interface: RemoteEffect

Set the position of the effect

Specified by:

setPosition in interface RemoteEffect<ParticleEffectType>

Parameters:

vector - The vector of the effect

setCount

public void setCount(int count)

Description copied from interface: ParticleEffect

Set the count how many of the effects should be spawned

Specified by:

setCount in interface ParticleEffect

Parameters:

count - The count how many should be spawned

setLongDistance

public void setLongDistance(boolean longDistance)

Description copied from interface: ParticleEffect

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

Specified by:

setLongDistance in interface ParticleEffect

Parameters:

longDistance - Whether the particle should be long distance

setData

public void setData(int[] data)

Description copied from interface: ParticleEffect

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

Specified by:

setData in interface ParticleEffect

Parameters:

data - Data of the particle

setOffset

public void setOffset(Vector offset)

Description copied from interface: ParticleEffect

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

Specified by:

setOffset in interface ParticleEffect

Parameters:

offset - The offset for each particle

count

public int count()

Description copied from interface: ParticleEffect

Returns the count of how many particles will be spawned

Specified by:

count in interface ParticleEffect

Returns:

The count of how many particles will be spawned

longDistance

public boolean longDistance()

Description copied from interface: ParticleEffect

Returns whether the particle should be long distance

Specified by:

longDistance in interface ParticleEffect

Returns:

Whether the particle should be long distance

data

public int[] data()

Description copied from interface: ParticleEffect

Returns the data of the particle

Specified by:

data in interface ParticleEffect

Returns:

The data of the particle

offset

public Vector offset()

Description copied from interface: ParticleEffect

Returns the offset for each particle

Specified by:

offset in interface ParticleEffect

Returns:

The offset for each particle

getPacket

public OutPacket getPacket()

Specified by:

getPacket in class TridentEffect<ParticleEffectType>