me.ryandw11.ultrachat.api

Class UltraChatAPI

java.lang.Object

me.ryandw11.ultrachat.api.UltraChatAPI

public class UltraChatAPI
extends java.lang.Object

UltraChatAPI

Version:

2.1.0

Author:

Ryandw11

Constructor Summary

Constructors

Constructor and Description
UltraChatAPI(UltraChat plugin)

Method Summary

Modifier and Type	Method and Description
void	createChannel(java.lang.String channel, java.lang.String prefix, java.lang.String permission, boolean always_appear, java.lang.String format, java.util.ArrayList<java.lang.String> json) Create a channel.
java.util.Set<java.lang.String>	getActiveHooks() Get the current active hooks.
java.util.ArrayList<java.lang.String>	getChannelJson(java.lang.String channel) Get a channel's json.
int	getChatCount() Get the number of formats
java.util.ArrayList<java.lang.String>	getChatFormatJson(java.lang.String number) Get a format's json.
java.lang.String	getDefaultChannel() Get the servers default channel.
java.lang.String	getDefaultFormat() Get the default format.
java.lang.String	getFormat(java.lang.String number) Get a chat format.
java.lang.String	getFormattingType() Get the current formatting type.
static UltraChat	getInstance() Deprecated.
ChatMode	getMode() Get the current chat mode.
java.lang.String	getOpFormat() Get the op format.
java.lang.String	getPermission(java.lang.String number) Get the permission of a chat group.
java.lang.String	getPlayerChannel(org.bukkit.entity.Player player) Grab the player's current channel.
java.lang.String	getPlayerColor(org.bukkit.entity.Player player) Get a player's color.
PlayerFormatting	getPlayerFormatting(org.bukkit.entity.Player p) Grab the player's formatting.
static UltraChat	getPlugin() Grab the plugin.
java.util.ArrayList<java.lang.String>	getSwearWords() Get the swear word list.
boolean	isChannelEnabled() Deprecated. Use getMode()
boolean	isChannelJson() Get if the channel has json enabled or not.
boolean	isJsonEnabled() Deprecated. Use getMode()
boolean	isRangeJson() Get if range has json or not.
boolean	legitDefaultChannel(java.lang.String chan) See if default channel exists.
void	removeChannel(java.lang.String channel) Remove a channel.
void	setChannelJson(java.util.ArrayList<java.lang.String> json, java.lang.String channel) Set a channel's json.
void	setChatFormatJson(java.util.ArrayList<java.lang.String> json, java.lang.String number) Set a format's json.
void	setDefaultChannel(java.lang.String channel) Set the default channel
void	setMode(ChatMode cm) Set the chat mode.
void	setPlayerChannel(org.bukkit.entity.Player player, java.lang.String channel) Set the player's channel.
void	setPlayerColor(org.bukkit.entity.Player player, java.lang.String color) Set a player's color.
void	setSwearWords(java.util.ArrayList<java.lang.String> words) Set the swear word list.

Methods inherited from class java.lang.Object

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

Constructor Detail

UltraChatAPI

public UltraChatAPI(UltraChat plugin)

Method Detail

getInstance

public static UltraChat getInstance()

Deprecated.

Grab the Instance

Returns:

#getPlugin()

getPlayerChannel

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

Grab the player's current channel.

Parameters:

player -

Returns:

The player's current channel.

getDefaultChannel

public java.lang.String getDefaultChannel()

Get the servers default channel.

Returns:

Default Channel

setPlayerChannel

public void setPlayerChannel(org.bukkit.entity.Player player,
                             java.lang.String channel)

Set the player's channel.

Parameters:

player -

channel -

setDefaultChannel

public void setDefaultChannel(java.lang.String channel)

Set the default channel

Parameters:

channel -

getChannelJson

public java.util.ArrayList<java.lang.String> getChannelJson(java.lang.String channel)

Get a channel's json.

Parameters:

channel -

Returns:

Json array

getChatFormatJson

public java.util.ArrayList<java.lang.String> getChatFormatJson(java.lang.String number)

Get a format's json.

Parameters:

number -

Returns:

Json array

setChannelJson

public void setChannelJson(java.util.ArrayList<java.lang.String> json,
                           java.lang.String channel)

Set a channel's json.

Parameters:

json -

channel -

setChatFormatJson

public void setChatFormatJson(java.util.ArrayList<java.lang.String> json,
                              java.lang.String number)

Set a format's json.

Parameters:

json -

number -

isChannelEnabled

public boolean isChannelEnabled()

Deprecated. Use getMode()

Check to see if channels are enabled.

Returns:

boolean

isJsonEnabled

public boolean isJsonEnabled()

Deprecated. Use getMode()

Check to see if json is enabled.

Returns:

boolean

getMode

public ChatMode getMode()

Get the current chat mode.

Returns:

chat mode

setMode

public void setMode(ChatMode 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)

Grab the player's formatting.

Parameters:

p - The player.

Returns:

The player's formatting.

getFormat

public java.lang.String getFormat(java.lang.String number)

Get a chat format.

Parameters:

number -

Returns:

Chat format.

getOpFormat

public java.lang.String getOpFormat()

Get the op format.

Returns:

op format.

getDefaultFormat

public java.lang.String getDefaultFormat()

Get the default format.

Returns:

op format.

getPermission

public java.lang.String getPermission(java.lang.String number)

Get the permission of a chat group.

Parameters:

number -

Returns:

permission

getChatCount

public int getChatCount()

Get the number of formats

Returns:

Chat Count

getPlayerColor

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

Get a player's color. Example: &4

Parameters:

player -

Returns:

color code.

setPlayerColor

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

Set a player's color.

Parameters:

player -

color -

getSwearWords

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

Get the swear word list.

Returns:

Block swear words.

setSwearWords

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

Set the swear word list.

Parameters:

words -

createChannel

public void createChannel(java.lang.String channel,
                          java.lang.String prefix,
                          java.lang.String permission,
                          boolean always_appear,
                          java.lang.String format,
                          java.util.ArrayList<java.lang.String> json)

Create a channel.

Parameters:

channel -

prefix -

permission -

always_appear -

format -

json -

removeChannel

public void removeChannel(java.lang.String channel)

Remove a channel.

Parameters:

channel -

getPlugin

public static UltraChat getPlugin()

Grab the plugin.

Returns:

plugin. Don't worry about the return

getFormattingType

public java.lang.String getFormattingType()

Get the current formatting type.

Returns:

The value of the config.

isChannelJson

public boolean isChannelJson()

Get if the channel has json enabled or not.

Returns:

True or false.

legitDefaultChannel

public boolean legitDefaultChannel(java.lang.String chan)

See if default channel exists.

Parameters:

chan - - The channel in the config.

Returns:

True if it does, false if not.

isRangeJson

public boolean isRangeJson()

Get if range has json or not.

Returns:

True or False.

getActiveHooks

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

Get the current active hooks.

Returns:

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