org.spongepowered.api.effect.particle

Interface ParticleEffect.Builder

All Superinterfaces:

DataBuilder<ParticleEffect>, ResettableBuilder<ParticleEffect,DataBuilder<ParticleEffect>>

Enclosing interface:

ParticleEffect

public static interface ParticleEffect.Builder
extends DataBuilder<ParticleEffect>

Represents a builder to create a ParticleEffect.

Method Summary

Modifier and Type	Method and Description
ParticleEffect	build() Builds an instance of a ParticleEffect.
ParticleEffect.Builder	from(ParticleEffect particleEffect) Resets this builder to the values of the given built object.
default ParticleEffect.Builder	offset(com.flowpowered.math.vector.Vector3d offset) Sets the offset of the particle effect.
<V> ParticleEffect.Builder	option(ParticleOption<V> option, V value) Sets the value of the specified ParticleOption.
default ParticleEffect.Builder	quantity(int quantity) Sets the amount of particles of the particle effect.
ParticleEffect.Builder	reset() Resets this builder to a "default" state such that there is no remaining data to set.
ParticleEffect.Builder	type(ParticleType particleType) Sets the particle type for the particle effect.
default ParticleEffect.Builder	velocity(com.flowpowered.math.vector.Vector3d velocity) Sets the velocity of the particle effect.

Methods inherited from interface org.spongepowered.api.data.persistence.DataBuilder

build

Method Detail

from

ParticleEffect.Builder from(ParticleEffect particleEffect)

Description copied from interface: ResettableBuilder

Resets this builder to the values of the given built object.

Specified by:

from in interface DataBuilder<ParticleEffect>

Specified by:

from in interface ResettableBuilder<ParticleEffect,DataBuilder<ParticleEffect>>

Parameters:

particleEffect - The built object

Returns:

This builder, for chaining

reset

ParticleEffect.Builder reset()

Description copied from interface: ResettableBuilder

Resets this builder to a "default" state such that there is no remaining data to set. This is to be the presumed "default" state.

Specified by:

reset in interface DataBuilder<ParticleEffect>

Specified by:

reset in interface ResettableBuilder<ParticleEffect,DataBuilder<ParticleEffect>>

Returns:

This builder, for chaining

type

ParticleEffect.Builder type(ParticleType particleType)

Sets the particle type for the particle effect.

Parameters:

particleType - The particle type

Returns:

This builder for chaining

option

<V> ParticleEffect.Builder option(ParticleOption<V> option,
                                  V value)
                           throws IllegalArgumentException

Sets the value of the specified ParticleOption.

Parameters:

option - The option

value - The value

Returns:

This builder for chaining

Throws:

IllegalArgumentException - If the specified value isn't valid

velocity

default ParticleEffect.Builder velocity(com.flowpowered.math.vector.Vector3d velocity)

Sets the velocity of the particle effect.

The default velocity is Vector3d.ZERO.

Parameters:

velocity - The velocity

Returns:

This builder for chaining

offset

default ParticleEffect.Builder offset(com.flowpowered.math.vector.Vector3d offset)

Sets the offset of the particle effect.

The default offset is Vector3d.ZERO.

Parameters:

offset - The offset

Returns:

This builder for chaining

quantity

default ParticleEffect.Builder quantity(int quantity)
                                 throws IllegalArgumentException

Sets the amount of particles of the particle effect.

The default quantity is 1.

Parameters:

quantity - The quantity particles

Returns:

This builder, for chaining

Throws:

IllegalArgumentException - If the quantity is less than one

build

ParticleEffect build()

Builds an instance of a ParticleEffect.

Returns:

A new instance of a ParticleEffect