Package de.robingrether.idisguise.disguise

Class ObjectDisguise

java.lang.Object

de.robingrether.idisguise.disguise.Disguise

de.robingrether.idisguise.disguise.ObjectDisguise

Direct Known Subclasses:

AreaEffectCloudDisguise, ArmorStandDisguise, BoatDisguise, FallingBlockDisguise, ItemDisguise, MinecartDisguise

public class ObjectDisguise
extends Disguise

Represents a disguise as an object.

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

Constructor Summary

Constructors

Constructor	Description
ObjectDisguise(DisguiseType type)	Creates an instance.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getCustomName()	Gets the custom name of this entity. The default value is "".
int	getTypeId()	Gets the mob type id. This id is used in the client/server communication.
static int	getTypeId(DisguiseType type)	Gets the mob type id for a given DisguiseType. This id is used in the client/server communication.
boolean	isCustomNameVisible()	Indicates whether the custom name of this entity is visible all the time. The default value is true.
void	setCustomName(java.lang.String customName)	Sets the custom name of this entity. The default value is "".
void	setCustomNameVisible(boolean customNameVisible)	Sets whether the custom name of this entity is visible all the time. The default value is true.
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

Constructor Detail

ObjectDisguise

public ObjectDisguise(DisguiseType type)

Creates an instance.

Parameters:

type - the disguise type

Throws:

java.lang.IllegalArgumentException - if the given DisguiseType is not an object

Since:

5.1.1

Method Detail

getCustomName

public java.lang.String getCustomName()

Gets the custom name of this entity.
The default value is "".

Returns:

the custom name

Since:

5.6.1

setCustomName

public void setCustomName(java.lang.String customName)

Sets the custom name of this entity.
The default value is "".

Parameters:

customName - the custom name

Since:

5.6.1

isCustomNameVisible

public boolean isCustomNameVisible()

Indicates whether the custom name of this entity is visible all the time.
The default value is true.

Returns:

true, if the custom name is visible all the time

Since:

5.6.3

setCustomNameVisible

public void setCustomNameVisible(boolean customNameVisible)

Sets whether the custom name of this entity is visible all the time.
The default value is true. This value has no effect if the custom name is empty.

Parameters:

customNameVisible - true, if the custom name shall be visible all the time

Since:

5.6.3

toString

public java.lang.String toString()

Returns a string representation of the object.

Overrides:

toString in class Disguise

Returns:

a string representation of the object

getTypeId

public int getTypeId()

Gets the mob type id.
This id is used in the client/server communication.

Returns:

the type id for this disguise

Since:

5.1.1

getTypeId

public static int getTypeId(DisguiseType type)

Gets the mob type id for a given DisguiseType.
This id is used in the client/server communication.

Parameters:

type - the disguise type

Returns:

the type id for the given disguise type

Throws:

java.lang.IllegalArgumentException - if the given DisguiseType is not an object

Since:

5.1.1