Package me.neznamy.tab.api

Interface TablistFormatManager

public interface TablistFormatManager

An interface allowing to modify tablist display names of players.

Instance can be obtained using TabAPI.getTablistFormatManager(). This requires the feature to be enabled in config, otherwise the method will return null.

Method Summary

Modifier and Type	Method	Description
String	getCustomName(TabPlayer player)	Returns custom name assigned using setName(TabPlayer, String) method.
String	getCustomPrefix(TabPlayer player)	Returns prefix assigned using setPrefix(TabPlayer, String) method.
String	getCustomSuffix(TabPlayer player)	Returns suffix assigned using setSuffix(TabPlayer, String) method.
String	getOriginalName(TabPlayer player)	Returns player's original name applied using plugin's internal logic.
String	getOriginalPrefix(TabPlayer player)	Returns player's original prefix applied using plugin's internal logic.
String	getOriginalSuffix(TabPlayer player)	Returns player's original suffix applied using plugin's internal logic.
void	resetName(TabPlayer player)	Resets player's custom name previously assigned using setName(TabPlayer, String) method.
void	resetPrefix(TabPlayer player)	Resets player's prefix previously assigned using setPrefix(TabPlayer, String) method.
void	resetSuffix(TabPlayer player)	Resets player's suffix previously assigned using setSuffix(TabPlayer, String) method.
void	setName(TabPlayer player, String customName)	Changes player's name to provided value.
void	setPrefix(TabPlayer player, String prefix)	Changes player's prefix to provided value.
void	setSuffix(TabPlayer player, String suffix)	Changes player's suffix to provided value.

Method Details

setPrefix

void setPrefix(TabPlayer player,
 String prefix)

Changes player's prefix to provided value. Supports placeholders, as well as any supported RGB formats.

Parameters:

player - player to change prefix of

prefix - new prefix value

See Also:

• resetPrefix(TabPlayer)
• getCustomPrefix(TabPlayer)
• getOriginalPrefix(TabPlayer)

setName

void setName(TabPlayer player,
 String customName)

Changes player's name to provided value. Supports placeholders, as well as any supported RGB formats.

Parameters:

player - player to change prefix of

customName - new customName value

See Also:

• resetName(TabPlayer)
• getCustomName(TabPlayer)
• getOriginalName(TabPlayer)

setSuffix

void setSuffix(TabPlayer player,
 String suffix)

Changes player's suffix to provided value. Supports placeholders, as well as any supported RGB formats.

Parameters:

player - player to change prefix of

suffix - new suffix value

See Also:

• resetSuffix(TabPlayer)
• getCustomSuffix(TabPlayer)
• getOriginalSuffix(TabPlayer)

resetPrefix

void resetPrefix(TabPlayer player)

Resets player's prefix previously assigned using setPrefix(TabPlayer, String) method. If nothing was set, this method will not do anything.

Parameters:

player - player to reset prefix of

See Also:

• setPrefix(TabPlayer, String)
• getCustomPrefix(TabPlayer)
• getOriginalPrefix(TabPlayer)

resetName

void resetName(TabPlayer player)

Resets player's custom name previously assigned using setName(TabPlayer, String) method. If nothing was set, this method will not do anything.

Parameters:

player - player to reset name of

See Also:

• setName(TabPlayer, String)
• getCustomName(TabPlayer)
• getOriginalName(TabPlayer)

resetSuffix

void resetSuffix(TabPlayer player)

Resets player's suffix previously assigned using setSuffix(TabPlayer, String) method. If nothing was set, this method will not do anything.

Parameters:

player - player to reset suffix of

See Also:

• setSuffix(TabPlayer, String)
• getCustomSuffix(TabPlayer)
• getOriginalSuffix(TabPlayer)

getCustomPrefix

String getCustomPrefix(TabPlayer player)

Returns prefix assigned using setPrefix(TabPlayer, String) method. If the method was not used, null is returned.

Parameters:

player - player to get custom prefix of

Returns:

player's custom prefix or null if not defined

See Also:

• setPrefix(TabPlayer, String)
• resetPrefix(TabPlayer)
• getOriginalPrefix(TabPlayer)

getCustomName

String getCustomName(TabPlayer player)

Returns custom name assigned using setName(TabPlayer, String) method. If the method was not used, null is returned.

Parameters:

player - player to get custom name of

Returns:

player's custom name or null if not defined

See Also:

• setName(TabPlayer, String)
• resetName(TabPlayer)
• getOriginalName(TabPlayer)

getCustomSuffix

String getCustomSuffix(TabPlayer player)

Returns suffix assigned using setSuffix(TabPlayer, String) method. If the method was not used, null is returned.

Parameters:

player - player to get custom suffix of

Returns:

player's custom suffix or null if not defined

See Also:

• setSuffix(TabPlayer, String)
• resetSuffix(TabPlayer)
• getOriginalSuffix(TabPlayer)

getOriginalPrefix

String getOriginalPrefix(TabPlayer player)

Returns player's original prefix applied using plugin's internal logic. This value is not affected by API calls in any way.

Parameters:

player - player to get original prefix of

Returns:

player's original prefix

See Also:

• setPrefix(TabPlayer, String)
• resetPrefix(TabPlayer)
• getCustomPrefix(TabPlayer)

getOriginalName

String getOriginalName(TabPlayer player)

Returns player's original name applied using plugin's internal logic. This value is not affected by API calls in any way.

Parameters:

player - player to get original name of

Returns:

player's original name

See Also:

• setName(TabPlayer, String)
• resetName(TabPlayer)
• getCustomName(TabPlayer)

getOriginalSuffix

String getOriginalSuffix(TabPlayer player)

Returns player's original suffix applied using plugin's internal logic. This value is not affected by API calls in any way.

Parameters:

player - player to get original suffix of

Returns:

player's original suffix

See Also:

• setSuffix(TabPlayer, String)
• resetSuffix(TabPlayer)
• getCustomSuffix(TabPlayer)