NameTagChanger (NameTagChanger JavaDocs)

java.lang.Object
- com.bringholm.nametagchanger.NameTagChanger

```
public class NameTagChanger
extends Object
```
Allows changing of a player's overhead name using packet manipulation

Author:

AlvinB

Field Summary

Fields
Modifier and Type	Field and Description
`static NameTagChanger`	`INSTANCE` The singleton instance to access all NameTagChanger methods
`static String`	`VERSION` The version of NameTagChanger

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`changePlayerName(org.bukkit.entity.Player player, String newName)` Changes the name displayed above the player's head.
`void`	`disable()` Disables NameTagChanger and restores all names to normal, and removes all packet handlers.
`void`	`enable()` Enables NameTagChanger and creates necessary packet handlers.
`String`	`getChangedName(org.bukkit.entity.Player player)` Gets a player's changed name
`Map<UUID,String>`	`getChangedPlayers()` Gets all players who currently have changed names.
`Skin`	`getChangedSkin(org.bukkit.entity.Player player)` Gets a player's changed skin
`Skin`	`getDefaultSkinFromPlayer(org.bukkit.entity.Player player)` Gets the default skin from a player, if one exists locally, otherwise Skin.EMPTY_SKIN is returned.
`void`	`getSkin(String username, SkinCallBack callBack)` Gets the skin for a username.
`void`	`getSkin(UUID uuid, SkinCallBack callBack)` Gets the skin for a UUID.
`Skin`	`getSkinFromGameProfile(GameProfileWrapper profile)` Gets the skin from a game profile, if one exists, otherwise Skin.EMPTY_SKIN is returned.
`void`	`init()` Empty method to call for initializing the class.
`boolean`	`isEnabled()` Checks if NameTagChanger is enabled.
`void`	`resetPlayerName(org.bukkit.entity.Player player)` Resets the player's name back to normal.
`void`	`resetPlayerSkin(org.bukkit.entity.Player player)` Resets a player's skin back to normal NOTE: This does not update the player's skin, so a call to updatePlayer() is needed for the changes to take effect.
`void`	`setPlayerSkin(org.bukkit.entity.Player player, Skin skin)` Sets a players skin.
`void`	`setPlugin(org.bukkit.plugin.Plugin plugin)` Sets the plugin instance to use for registering packet/event listeners.
`void`	`updatePlayer(org.bukkit.entity.Player player)` Sends packets to update a player to reflect any changes in skin or name.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - VERSION
```
public static final String VERSION
```
    The version of NameTagChanger
    
    See Also:
    
    Constant Field Values
  - INSTANCE
```
public static final NameTagChanger INSTANCE
```
    The singleton instance to access all NameTagChanger methods
- Method Detail
  - setPlayerSkin
```
public void setPlayerSkin(org.bukkit.entity.Player player,
                          Skin skin)
```
    Sets a players skin.
    NOTE: This does not update the player's skin, so a call to updatePlayer() is needed for the changes to take effect.
    
    Parameters:
    
    player - the player to set the skin of
    
    skin - the skin
  - resetPlayerSkin
```
public void resetPlayerSkin(org.bukkit.entity.Player player)
```
    Resets a player's skin back to normal
    NOTE: This does not update the player's skin, so a call to updatePlayer() is needed for the changes to take effect.
    
    Parameters:
    
    player - the player to reset
  - changePlayerName
```
public void changePlayerName(org.bukkit.entity.Player player,
                             String newName)
```
    Changes the name displayed above the player's head. Please note that these names must follow the regular rules of minecraft names (ie maximum 16 characters)
    
    Parameters:
    
    player - the player
    
    newName - the new name of the player
  - resetPlayerName
```
public void resetPlayerName(org.bukkit.entity.Player player)
```
    Resets the player's name back to normal.
    
    Parameters:
    
    player - the player
  - getChangedName
```
public String getChangedName(org.bukkit.entity.Player player)
```
    Gets a player's changed name
    
    Parameters:
    
    player - the player to get the changed name of
    
    Returns:
    
    the changed name
  - getChangedSkin
```
public Skin getChangedSkin(org.bukkit.entity.Player player)
```
    Gets a player's changed skin
    
    Parameters:
    
    player - the player to get the changed skin of
    
    Returns:
    
    the changed skin
  - getDefaultSkinFromPlayer
```
public Skin getDefaultSkinFromPlayer(org.bukkit.entity.Player player)
```
    Gets the default skin from a player, if one exists locally, otherwise Skin.EMPTY_SKIN is returned.
    
    Parameters:
    
    player - the player
    
    Returns:
    
    the player's default skin
  - getSkinFromGameProfile
```
public Skin getSkinFromGameProfile(GameProfileWrapper profile)
```
    Gets the skin from a game profile, if one exists, otherwise Skin.EMPTY_SKIN is returned.
    
    Parameters:
    
    profile - the profile
    
    Returns:
    
    the skin of the profile
  - updatePlayer
```
public void updatePlayer(org.bukkit.entity.Player player)
```
    Sends packets to update a player to reflect any changes in skin or name.
    NOTE: This is done automatically by #changePlayerName and #resetPlayerName, so the only real use for this is when changing skins, as those methods do not automatically update.
    
    Parameters:
    
    player - the player to update
  - getChangedPlayers
```
public Map<UUID,String> getChangedPlayers()
```
    Gets all players who currently have changed names.
    
    Returns:
    
    an unmodifiable map containing all the changed players
  - isEnabled
```
public boolean isEnabled()
```
    Checks if NameTagChanger is enabled.
    
    Returns:
    
    whether NameTagChanger is enabled or not.
  - disable
```
public void disable()
```
    Disables NameTagChanger and restores all names to normal, and removes all packet handlers.
  - enable
```
public void enable()
```
    Enables NameTagChanger and creates necessary packet handlers. Is done automatically by the constructor, so only use this method if the disable() method has previously been called.
  - setPlugin
```
public void setPlugin(org.bukkit.plugin.Plugin plugin)
```
    Sets the plugin instance to use for registering packet/event listeners. This is done automatically by the constructor, so this should only be used if the correct plugin is not found.
    
    Parameters:
    
    plugin - the plugin instance
  - getSkin
```
public void getSkin(String username,
                    SkinCallBack callBack)
```
    Gets the skin for a username.
    Since fetching this skin requires making asynchronous requests to Mojang's servers, a call back mechanism using the SkinCallBack class is implemented. This call back allows you to also handle any errors that might have occurred while fetching the skin. If no users with the specified username can be found, the skin passed to the callback will be Skin.EMPTY_SKIN.
    The call back will always be fired on the main thread.
    
    Parameters:
    
    username - the username to get the skin of
    
    callBack - the call back to handle the result of the request
  - getSkin
```
public void getSkin(UUID uuid,
                    SkinCallBack callBack)
```
    Gets the skin for a UUID.
    Since fetching this skin might require making asynchronous requests to Mojang's servers, a call back mechanism using the SkinCallBack class is implemented. This call back allows you to also handle any errors that might have occurred while fetching the skin.
    The call back will always be fired on the main thread.
    
    Parameters:
    
    uuid - the uuid to get the skin of
    
    callBack - the call back to handle the result of the request
  - init
```
public void init()
```
    Empty method to call for initializing the class. May be useful if you want packet/event listeners to be setup in an onEnable for example.

Class NameTagChanger

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

VERSION

INSTANCE

Method Detail

setPlayerSkin

resetPlayerSkin

changePlayerName

resetPlayerName

getChangedName

getChangedSkin

getDefaultSkinFromPlayer

getSkinFromGameProfile

updatePlayer

getChangedPlayers

isEnabled

disable

enable

setPlugin

getSkin

getSkin

init