Package de.robingrether.idisguise.disguise

Class Disguise

java.lang.Object

de.robingrether.idisguise.disguise.Disguise

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

MobDisguise, ObjectDisguise, PlayerDisguise

public abstract class Disguise
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

Represents a disguise.

Since:

2.1.3

Author:

RobinGrether

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Disguise.Visibility	This enum represents the different visibility modes.

Method Summary

Modifier and Type	Method	Description
Disguise	clone()	Creates and returns a copy of this object.
boolean	equals(java.lang.Object object)	Indicates whether some other object is "equal to" this one.
static Disguise	fromString(java.lang.String string)	Recreates a disguise from its string representation.
DisguiseType	getType()	Returns the disguise type
Disguise.Visibility	getVisibility()	Gets the visibility mode.
java.lang.String[]	getVisibilityParameter()	Gets the visibility parameters.
int	hashCode()	Returns a hash code value for this object. The hash code is obtained by executing disguise.toString().hashCode()
boolean	isVisibleTo(org.bukkit.entity.Player player)	Indicates whether this disguise is visible to a certain player.
void	setVisibility(Disguise.Visibility visibility)	Sets the visibility mode. Calling this function will reset the visibility parameters.
void	setVisibilityParameter(java.lang.String... visibilityParameter)	Sets the visibility parameters.
java.lang.String	toString()	Returns a string representation of the object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getType

public DisguiseType getType()

Returns the disguise type

Returns:

the disguise type

Since:

2.1.3

getVisibility

public Disguise.Visibility getVisibility()

Gets the visibility mode.

Returns:

the visibility mode

Since:

5.6.1

setVisibility

public void setVisibility(Disguise.Visibility visibility)

Sets the visibility mode.
Calling this function will reset the visibility parameters.

Parameters:

visibility - the visibility mode

Since:

5.6.1

getVisibilityParameter

public java.lang.String[] getVisibilityParameter()

Gets the visibility parameters.

Returns:

the visibility parameters

Since:

5.6.1

setVisibilityParameter

public void setVisibilityParameter(java.lang.String... visibilityParameter)

Sets the visibility parameters.

Parameters:

visibilityParameter - the visibility parameters

Since:

5.6.1

isVisibleTo

public boolean isVisibleTo(org.bukkit.entity.Player player)

Indicates whether this disguise is visible to a certain player.

Parameters:

player - the viewer to indicate for

Returns:

true in case this disguise is visible to the given player, false otherwise

Since:

5.6.1

clone

public final Disguise clone()

Creates and returns a copy of this object.

Overrides:

clone in class java.lang.Object

Returns:

a clone of this instance

Since:

3.0.1

equals

public final boolean equals(java.lang.Object object)

Indicates whether some other object is "equal to" this one.

Overrides:

equals in class java.lang.Object

Returns:

true if this object is the same as the object argument; false otherwise

Since:

3.0.1

hashCode

public final int hashCode()

Returns a hash code value for this object.
The hash code is obtained by executing disguise.toString().hashCode()

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code value for this instance

Since:

5.6.1

toString

public java.lang.String toString()

Returns a string representation of the object.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of the object

Since:

5.3.1

fromString

public static Disguise fromString(java.lang.String string)
                           throws java.lang.IllegalArgumentException,
                                  OutdatedServerException

Recreates a disguise from its string representation.

Parameters:

string - the exact string representation of the disguise

Returns:

the recreated disguise object

Throws:

java.lang.IllegalArgumentException - in case the given string cannot be evaluated to a valid disguise

OutdatedServerException - in case the Minecraft server does not support the disguise type

Since:

5.5.1