com.github.fierioziy.api.types

Class ParticleTypeBlock

java.lang.Object

com.github.fierioziy.api.types.ParticleTypeBlock

public class ParticleTypeBlock
extends java.lang.Object

Class used to represent block particle type that needs a block type.

It provides a non-reflective of method overloads to construct ParticleType with selected block type.

All of methods does not validate parameters in any way.

See Also:

ParticleType

Constructor Summary

Constructors

Constructor and Description
ParticleTypeBlock()

Method Summary

Modifier and Type	Method and Description
boolean	isValid() Checks if this particle is supported by this Spigot version.
ParticleType	of(org.bukkit.Material block) Selects a block this particle should represents.
ParticleType	of(org.bukkit.Material block, byte meta) Selects a block this particle should represents.
ParticleType	of(org.bukkit.Material block, int meta) Selects a block this particle should represents.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParticleTypeBlock

public ParticleTypeBlock()

Method Detail

of

public ParticleType of(org.bukkit.Material block)

Selects a block this particle should represents.

Parameters are not validated in any way.

Parameters:

block - a Material object representing desired block type.

Returns:

a valid ParticleType object with selected block type.

of

public ParticleType of(org.bukkit.Material block,
                       int meta)

Selects a block this particle should represents.

Parameters are not validated in any way.

Parameters:

block - a Material object representing desired block type.

meta - a metadata used by certain blocks (it is ignored since 1.13).

Returns:

a valid ParticleType object with selected block type.

of

public ParticleType of(org.bukkit.Material block,
                       byte meta)

Selects a block this particle should represents.

Parameters are not validated in any way.

This method is overridden by dynamically generated subclasses.

Parameters:

block - a Material object representing desired block type.

meta - a metadata used by certain blocks (it is ignored since 1.13).

Returns:

a valid ParticleType object with selected block type.

isValid

public boolean isValid()

Checks if this particle is supported by this Spigot version.

This method is overridden by dynamically generated subclasses.

Returns:

true if this particle is supported by this Spigot version, false otherwise.