Package de.robingrether.idisguise.disguise

Class FallingBlockDisguise

java.lang.Object

de.robingrether.idisguise.disguise.Disguise

de.robingrether.idisguise.disguise.ObjectDisguise

de.robingrether.idisguise.disguise.FallingBlockDisguise

public class FallingBlockDisguise
extends ObjectDisguise

Represents a disguise as a falling block.

Since:

5.1.1

Author:

RobinGrether

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.robingrether.idisguise.disguise.Disguise

Disguise.Visibility

Field Summary

Fields

Modifier and Type	Field	Description
static java.util.Set<org.bukkit.Material>	INVALID_MATERIALS	A set containing all invalid materials. These materials are invalid because the associated disguise would be invisible.

Constructor Summary

Constructors

Constructor	Description
FallingBlockDisguise()	Creates an instance. The default material is Material.STONE
FallingBlockDisguise(org.bukkit.Material material)	Creates an instance.
FallingBlockDisguise(org.bukkit.Material material, int data)	Creates an instance.
FallingBlockDisguise(org.bukkit.Material material, int data, boolean onlyBlockCoordinates)	Creates an instance.

Method Summary

Modifier and Type	Method	Description
int	getData()	Gets the block data.
org.bukkit.Material	getMaterial()	Gets the material.
boolean	onlyBlockCoordinates()	Indicates whether this disguise may appear only on block coordinates.
void	setData(int data)	Sets the block data.
void	setMaterial(org.bukkit.Material material)	Sets the material. This also resets the data to 0.
void	setOnlyBlockCoordinates(boolean onlyBlockCoordinates)	Sets whether this disguise may appear only on block coordinates.
java.lang.String	toString()	Returns a string representation of the object.

Methods inherited from class de.robingrether.idisguise.disguise.Disguise

clone, equals, fromString, getType, getVisibility, getVisibilityParameter, hashCode, isVisibleTo, setVisibility, setVisibilityParameter

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from class de.robingrether.idisguise.disguise.ObjectDisguise

getCustomName, getTypeId, getTypeId, isCustomNameVisible, setCustomName, setCustomNameVisible

Field Detail

INVALID_MATERIALS

public static final java.util.Set<org.bukkit.Material> INVALID_MATERIALS

A set containing all invalid materials.
These materials are invalid because the associated disguise would be invisible.

Since:

5.7.1

Constructor Detail

FallingBlockDisguise

public FallingBlockDisguise()

Creates an instance.
The default material is Material.STONE

Since:

5.1.1

FallingBlockDisguise

public FallingBlockDisguise(org.bukkit.Material material)

Creates an instance.

Parameters:

material - the material

Throws:

java.lang.IllegalArgumentException - if the material is not a block

Since:

5.1.1

FallingBlockDisguise

public FallingBlockDisguise(org.bukkit.Material material,
                            int data)

Creates an instance.

Parameters:

material - the material

data - the block data

Throws:

java.lang.IllegalArgumentException - if the material is not a block, or if the data is negative

Since:

5.2.2

FallingBlockDisguise

public FallingBlockDisguise(org.bukkit.Material material,
                            int data,
                            boolean onlyBlockCoordinates)

Creates an instance.

Parameters:

material - the material

data - the block data

onlyBlockCoordinates - makes the disguise appear on block coordinates only, so it looks like an actual block that you can't target

Throws:

java.lang.IllegalArgumentException - if the material is not a block, or if the data is negative

Since:

5.4.1

Method Detail

getMaterial

public org.bukkit.Material getMaterial()

Gets the material.

Returns:

the material

Since:

5.1.1

setMaterial

public void setMaterial(org.bukkit.Material material)

Sets the material.
This also resets the data to 0.

Parameters:

material - the material

Throws:

java.lang.IllegalArgumentException - if the material is not a block

Since:

5.1.1

getData

public int getData()

Gets the block data.

Returns:

the block data

Since:

5.2.2

setData

public void setData(int data)

Sets the block data.

Parameters:

data - the block data

Since:

5.2.2

onlyBlockCoordinates

public boolean onlyBlockCoordinates()

Indicates whether this disguise may appear only on block coordinates.

Returns:

true, if this disguise may appear only on block coordinates

Since:

5.4.1

setOnlyBlockCoordinates

public void setOnlyBlockCoordinates(boolean onlyBlockCoordinates)

Sets whether this disguise may appear only on block coordinates.

Parameters:

onlyBlockCoordinates - makes this disguise appear on block coordinates only

Since:

5.4.1

toString

public java.lang.String toString()

Returns a string representation of the object.

Overrides:

toString in class ObjectDisguise

Returns:

a string representation of the object