Package de.robingrether.idisguise.disguise

Class PlayerDisguise

java.lang.Object

de.robingrether.idisguise.disguise.Disguise

de.robingrether.idisguise.disguise.PlayerDisguise

public class PlayerDisguise
extends Disguise

Represents a disguise as a player.

Since:

2.1.3

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
PlayerDisguise(java.lang.String skinName)	Creates an instance.
PlayerDisguise(java.lang.String skinName, boolean ghost)	Deprecated. ghost disguise is no longer available
PlayerDisguise(java.lang.String skinName, java.lang.String displayName)	Creates an instance.
PlayerDisguise(java.lang.String skinName, java.lang.String displayName, boolean ghost)	Deprecated. ghost disguise is no longer available

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDisplayName()	Returns the display name.
java.lang.String	getName()	Deprecated. replaced by getSkinName()
java.lang.String	getSkinName()	Returns the skin name. This is always lower case as of 5.5.2.
boolean	isGhost()	Deprecated. ghost disguise is no longer available
void	setDisplayName(java.lang.String displayName)	Sets the display name.
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

PlayerDisguise

public PlayerDisguise(java.lang.String skinName)

Creates an instance.

Parameters:

skinName - the player skin

Throws:

java.lang.IllegalArgumentException - the given skin name is not valid

Since:

2.1.3

PlayerDisguise

public PlayerDisguise(java.lang.String skinName,
                      java.lang.String displayName)

Creates an instance.

Parameters:

skinName - the player skin

displayName - the display name (above player's head and player list)

Throws:

java.lang.IllegalArgumentException - the given skin name is not valid

Since:

5.6.3

PlayerDisguise

@Deprecated
public PlayerDisguise(java.lang.String skinName,
                      boolean ghost)

Deprecated. ghost disguise is no longer available

Creates an instance.

Parameters:

skinName - the player skin

ghost - false for a normal player, otherwise UnsupportedOperationException will be thrown

Throws:

java.lang.IllegalArgumentException - the given skin name is not valid

Since:

2.3.1

PlayerDisguise

@Deprecated
public PlayerDisguise(java.lang.String skinName,
                      java.lang.String displayName,
                      boolean ghost)

Deprecated. ghost disguise is no longer available

Creates an instance.

Parameters:

skinName - the player skin

displayName - the display name (above player's head and player list)

ghost - false for a normal player, otherwise UnsupportedOperationException will be thrown

Throws:

java.lang.IllegalArgumentException - the given skin name is not valid

Since:

5.2.2

Method Detail

getName

@Deprecated
public java.lang.String getName()

Deprecated. replaced by getSkinName()

Returns the name.

Returns:

the skin name

Since:

2.1.3

getSkinName

public java.lang.String getSkinName()

Returns the skin name.
This is always lower case as of 5.5.2.

Returns:

the skin name

Since:

5.2.2

getDisplayName

public java.lang.String getDisplayName()

Returns the display name.

Returns:

the display name (above player's head and player list)

Since:

5.2.2

setDisplayName

public void setDisplayName(java.lang.String displayName)

Sets the display name.

Parameters:

displayName - the display name (above player's head and player list)

Since:

5.2.2

isGhost

@Deprecated
public boolean isGhost()

Deprecated. ghost disguise is no longer available

Checks whether this disguise is a ghost.

Returns:

false

Since:

2.3.1

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