me.ryandw11.ultrachat.api

Class UltraChatAPI

java.lang.Object

me.ryandw11.ultrachat.api.UltraChatAPI

public class UltraChatAPI
extends java.lang.Object

UltraChatAPI

Version:

2.5

Author:

Ryandw11

Constructor Summary

Constructors

Constructor and Description
UltraChatAPI()

Method Summary

Modifier and Type	Method and Description
java.util.Set<java.lang.String>	getActiveHooks() Get the current active hooks.
AddonManager	getAddonManager() Get the addon manager.
ChannelManager	getChannelManager()
ChatColorManager	getChatColorManager() Get the chat color manager.
ChatColorUtils	getChatColorUtil() Get the chat color utility interface.
ChatType	getChatType() Get the current chat type.
ChatType	getFormattingType() Get the current formatting type.
java.lang.String	getPlayerColor(org.bukkit.entity.Player player) Get a player's color.
ChatChannel	getPlayerCurrentChannel(java.util.UUID player) Deprecated. Use the channel manager instead.
PlayerFormatting	getPlayerFormatting(org.bukkit.entity.Player p) Deprecated. Construct the PlayerFormatting class yourself.
java.util.List<java.lang.String>	getSwearWords() Get the swear word list.
void	setPlayerColor(org.bukkit.entity.Player player, java.lang.String color) Set a player's color.
void	setSwearWords(java.util.List<java.lang.String> words) Set the swear word list.
void	setType(ChatType cm) Set the chat mode.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UltraChatAPI

public UltraChatAPI()

Method Detail

getPlayerCurrentChannel

public ChatChannel getPlayerCurrentChannel(java.util.UUID player)

Deprecated. Use the channel manager instead.

Get the current channel of a player.

Parameters:

player - The uuid of the player you want to get.

Returns:

The chat channel.

getAddonManager

public AddonManager getAddonManager()

Get the addon manager.

Returns:

The addon manager.

getChatType

public ChatType getChatType()

Get the current chat type.

Returns:

chat type

setType

public void setType(ChatType cm)

Set the chat mode. Can be disabled in the config.

Parameters:

cm - The chat manager

getPlayerFormatting

public PlayerFormatting getPlayerFormatting(org.bukkit.entity.Player p)

Deprecated. Construct the PlayerFormatting class yourself.

Grab the player's formatting.

Parameters:

p - The player.

Returns:

The player's formatting.

getPlayerColor

public java.lang.String getPlayerColor(org.bukkit.entity.Player player)

Get a player's color.

This will return a string Such as &4 or {#FFFFFF}.

Note: The colors interpreted are from the chatcolor.yml file. To also get color data from the use ChatUtil.translateColorCode(String)

Parameters:

player - The player to get the color for

Returns:

color code.

setPlayerColor

public void setPlayerColor(org.bukkit.entity.Player player,
                           java.lang.String color)

Set a player's color.

Parameters:

player - The player color to set

color - The color to set

Keep in mind that this color is interpreted from the chatcolor.yml file, not the default colors.

getSwearWords

public java.util.List<java.lang.String> getSwearWords()

Get the swear word list.

Returns:

Block swear words.

setSwearWords

public void setSwearWords(java.util.List<java.lang.String> words)

Set the swear word list.

Parameters:

words - The words to add

getFormattingType

public ChatType getFormattingType()

Get the current formatting type.

Returns:

The value of the config.

getChatColorUtil

public ChatColorUtils getChatColorUtil()

Get the chat color utility interface.

Note: Most methods from this interface are wrapped in the ChatUtil class.

Returns:

The chat color utility interface.

getChatColorManager

public ChatColorManager getChatColorManager()

Get the chat color manager.

Note: Most uses for this class is covered by the ChatUtil class.

This class is only available on 1.16+ servers. This WILL return null on any version below 1.16.

Returns:

The chat color manager.

getChannelManager

public ChannelManager getChannelManager()

getActiveHooks

public java.util.Set<java.lang.String> getActiveHooks()

Get the current active hooks.

Returns:

The set with the names of the plugins. Returns null if no hooks are active.