net.milkbowl.vault.chat

Class Chat

java.lang.Object

net.milkbowl.vault.chat.Chat

public abstract class Chat
extends Object

The main Chat API - allows for Prefix/Suffix nodes along with generic Info nodes if the linked Chat system supports them

Constructor Summary

Constructors

Constructor and Description
Chat(Permission perms)

Method Summary

Modifier and Type	Method and Description
abstract boolean	getGroupInfoBoolean(String world, String group, String node, boolean defaultValue) Get a groups informational node (Boolean) value
boolean	getGroupInfoBoolean(org.bukkit.World world, String group, String node, boolean defaultValue) Set a players informational node (Boolean) value
abstract double	getGroupInfoDouble(String world, String group, String node, double defaultValue) Get a groups informational node (Double) value
double	getGroupInfoDouble(org.bukkit.World world, String group, String node, double defaultValue) Get a groups informational node (Double) value
abstract int	getGroupInfoInteger(String world, String group, String node, int defaultValue) Get a groups informational node (Integer) value
int	getGroupInfoInteger(org.bukkit.World world, String group, String node, int defaultValue) Get a groups informational node (Integer) value
abstract String	getGroupInfoString(String world, String group, String node, String defaultValue) Get a groups informational node (String) value
String	getGroupInfoString(org.bukkit.World world, String group, String node, String defaultValue) Set a players informational node (String) value
abstract String	getGroupPrefix(String world, String group) Get group prefix
String	getGroupPrefix(org.bukkit.World world, String group) Get group prefix
String[]	getGroups() Returns a list of all known groups
abstract String	getGroupSuffix(String world, String group) Get group suffix
String	getGroupSuffix(org.bukkit.World world, String group) Get group suffix
abstract String	getName() Gets name of permission method
String[]	getPlayerGroups(org.bukkit.entity.Player player) Gets the list of groups that this player has
String[]	getPlayerGroups(String world, String player) Gets the list of groups that this player has
String[]	getPlayerGroups(org.bukkit.World world, String player) Gets the list of groups that this player has
boolean	getPlayerInfoBoolean(org.bukkit.entity.Player player, String node, boolean defaultValue) Get a players informational node (Boolean) value
abstract boolean	getPlayerInfoBoolean(String world, String player, String node, boolean defaultValue) Get a players informational node (Boolean) value
boolean	getPlayerInfoBoolean(org.bukkit.World world, String player, String node, boolean defaultValue) Get a players informational node (Boolean) value
double	getPlayerInfoDouble(org.bukkit.entity.Player player, String node, double defaultValue) Get a players informational node (Double) value
abstract double	getPlayerInfoDouble(String world, String player, String node, double defaultValue) Get a players informational node (Double) value
double	getPlayerInfoDouble(org.bukkit.World world, String player, String node, double defaultValue) Get a players informational node (Double) value
int	getPlayerInfoInteger(org.bukkit.entity.Player player, String node, int defaultValue) Get a players informational node (Integer) value
abstract int	getPlayerInfoInteger(String world, String player, String node, int defaultValue) Get a players informational node (Integer) value
int	getPlayerInfoInteger(org.bukkit.World world, String player, String node, int defaultValue) Get a players informational node (Integer) value
String	getPlayerInfoString(org.bukkit.entity.Player player, String node, String defaultValue) Get a players informational node (String) value
abstract String	getPlayerInfoString(String world, String player, String node, String defaultValue) Get a players informational node (String) value
String	getPlayerInfoString(org.bukkit.World world, String player, String node, String defaultValue) Get a players informational node (String) value
String	getPlayerPrefix(org.bukkit.entity.Player player) Get players prefix
abstract String	getPlayerPrefix(String world, String player) Get players prefix
String	getPlayerPrefix(org.bukkit.World world, String player) Get players prefix
String	getPlayerSuffix(org.bukkit.entity.Player player) Get players suffix
abstract String	getPlayerSuffix(String world, String player) Get players suffix
String	getPlayerSuffix(org.bukkit.World world, String player) Get players suffix
String	getPrimaryGroup(org.bukkit.entity.Player player) Get players primary group
String	getPrimaryGroup(String world, String player) Gets players primary group
String	getPrimaryGroup(org.bukkit.World world, String player) Gets players primary group
abstract boolean	isEnabled() Checks if permission method is enabled.
boolean	playerInGroup(org.bukkit.entity.Player player, String group) Check if player is member of a group.
boolean	playerInGroup(String world, String player, String group) Check if player is member of a group.
boolean	playerInGroup(org.bukkit.World world, String player, String group) Check if player is member of a group.
abstract void	setGroupInfoBoolean(String world, String group, String node, boolean value) Set a groups informational node (Boolean) value
void	setGroupInfoBoolean(org.bukkit.World world, String group, String node, boolean value) Set a players informational node (Boolean) value
abstract void	setGroupInfoDouble(String world, String group, String node, double value) Set a groups informational node (Double) value
void	setGroupInfoDouble(org.bukkit.World world, String group, String node, double value) Set a groups informational node (Double) value
abstract void	setGroupInfoInteger(String world, String group, String node, int value) Set a groups informational node (Integer) value
void	setGroupInfoInteger(org.bukkit.World world, String group, String node, int value) Set a groups informational node (Integer) value
abstract void	setGroupInfoString(String world, String group, String node, String value) Set a groups informational node (String) value
void	setGroupInfoString(org.bukkit.World world, String group, String node, String value) Set a groups informational node (String) value
abstract void	setGroupPrefix(String world, String group, String prefix) Set group prefix
void	setGroupPrefix(org.bukkit.World world, String group, String prefix) Set group prefix
abstract void	setGroupSuffix(String world, String group, String suffix) Set group suffix
void	setGroupSuffix(org.bukkit.World world, String group, String suffix) Set group suffix
void	setPlayerInfoBoolean(org.bukkit.entity.Player player, String node, boolean value) Set a players informational node (Boolean) value
abstract void	setPlayerInfoBoolean(String world, String player, String node, boolean value) Set a players informational node (Boolean) value
void	setPlayerInfoBoolean(org.bukkit.World world, String player, String node, boolean value) Set a players informational node (Boolean) value
void	setPlayerInfoDouble(org.bukkit.entity.Player player, String node, double value) Set a players informational node (Double) value
abstract void	setPlayerInfoDouble(String world, String player, String node, double value) Set a players informational node (Double) value
void	setPlayerInfoDouble(org.bukkit.World world, String player, String node, double value) Set a players informational node (Double) value
void	setPlayerInfoInteger(org.bukkit.entity.Player player, String node, int value) Set a players informational node (Integer) value
abstract void	setPlayerInfoInteger(String world, String player, String node, int value) Set a players informational node (Integer) value
void	setPlayerInfoInteger(org.bukkit.World world, String player, String node, int value) Set a players informational node (Integer) value
void	setPlayerInfoString(org.bukkit.entity.Player player, String node, String value) Set a players informational node (String) value
abstract void	setPlayerInfoString(String world, String player, String node, String value) Set a players informational node (String) value
void	setPlayerInfoString(org.bukkit.World world, String player, String node, String value) Set a players informational node (String) value
void	setPlayerPrefix(org.bukkit.entity.Player player, String prefix) Set players prefix
abstract void	setPlayerPrefix(String world, String player, String prefix) Set players prefix
void	setPlayerPrefix(org.bukkit.World world, String player, String prefix) Set players prefix
void	setPlayerSuffix(org.bukkit.entity.Player player, String suffix) Set players suffix
abstract void	setPlayerSuffix(String world, String player, String suffix) Set players suffix
void	setPlayerSuffix(org.bukkit.World world, String player, String suffix) Set players suffix

Methods inherited from class java.lang.Object

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

Constructor Detail

Chat

public Chat(Permission perms)

Method Detail

getName

public abstract String getName()

Gets name of permission method

Returns:

Name of Permission Method

isEnabled

public abstract boolean isEnabled()

Checks if permission method is enabled.

Returns:

Success or Failure

getPlayerPrefix

public abstract String getPlayerPrefix(String world,
                                       String player)

Get players prefix

Parameters:

world - World name

player - Player name

Returns:

Prefix

getPlayerPrefix

public String getPlayerPrefix(org.bukkit.World world,
                              String player)

Get players prefix

Parameters:

world - World Object

player - Player name

Returns:

Prefix

getPlayerPrefix

public String getPlayerPrefix(org.bukkit.entity.Player player)

Get players prefix

Parameters:

player - Player Object

Returns:

Prefix

setPlayerPrefix

public abstract void setPlayerPrefix(String world,
                                     String player,
                                     String prefix)

Set players prefix

Parameters:

world - World name

player - Player name

prefix - Prefix

setPlayerPrefix

public void setPlayerPrefix(org.bukkit.World world,
                            String player,
                            String prefix)

Set players prefix

Parameters:

world - World Object

player - Player name

prefix - Prefix

setPlayerPrefix

public void setPlayerPrefix(org.bukkit.entity.Player player,
                            String prefix)

Set players prefix

Parameters:

player - Player Object

prefix - Prefix

getPlayerSuffix

public abstract String getPlayerSuffix(String world,
                                       String player)

Get players suffix

Parameters:

world - World name

player - Player name

Returns:

Suffix

getPlayerSuffix

public String getPlayerSuffix(org.bukkit.World world,
                              String player)

Get players suffix

Parameters:

world - World Object

player - Player name

Returns:

Suffix

getPlayerSuffix

public String getPlayerSuffix(org.bukkit.entity.Player player)

Get players suffix

Parameters:

player - Player Object

Returns:

Suffix

setPlayerSuffix

public abstract void setPlayerSuffix(String world,
                                     String player,
                                     String suffix)

Set players suffix

Parameters:

world - World name

player - Player name

suffix - Suffix

setPlayerSuffix

public void setPlayerSuffix(org.bukkit.World world,
                            String player,
                            String suffix)

Set players suffix

Parameters:

world - World Object

player - Player name

suffix - Suffix

setPlayerSuffix

public void setPlayerSuffix(org.bukkit.entity.Player player,
                            String suffix)

Set players suffix

Parameters:

player - Player Object

suffix - Suffix

getGroupPrefix

public abstract String getGroupPrefix(String world,
                                      String group)

Get group prefix

Parameters:

world - World name

group - Group name

Returns:

Prefix

getGroupPrefix

public String getGroupPrefix(org.bukkit.World world,
                             String group)

Get group prefix

Parameters:

world - World Object

group - Group name

Returns:

Prefix

setGroupPrefix

public abstract void setGroupPrefix(String world,
                                    String group,
                                    String prefix)

Set group prefix

Parameters:

world - World name

group - Group name

prefix - Prefix

setGroupPrefix

public void setGroupPrefix(org.bukkit.World world,
                           String group,
                           String prefix)

Set group prefix

Parameters:

world - World Object

group - Group name

prefix - Prefix

getGroupSuffix

public abstract String getGroupSuffix(String world,
                                      String group)

Get group suffix

Parameters:

world - World name

group - Group name

Returns:

Suffix

getGroupSuffix

public String getGroupSuffix(org.bukkit.World world,
                             String group)

Get group suffix

Parameters:

world - World Object

group - Group name

Returns:

Suffix

setGroupSuffix

public abstract void setGroupSuffix(String world,
                                    String group,
                                    String suffix)

Set group suffix

Parameters:

world - World name

group - Group name

suffix - Suffix

setGroupSuffix

public void setGroupSuffix(org.bukkit.World world,
                           String group,
                           String suffix)

Set group suffix

Parameters:

world - World Object

group - Group name

suffix - Suffix

getPlayerInfoInteger

public abstract int getPlayerInfoInteger(String world,
                                         String player,
                                         String node,
                                         int defaultValue)

Get a players informational node (Integer) value

Parameters:

world - World name

player - Player name

node - Permission node

defaultValue - Default value

Returns:

Value

getPlayerInfoInteger

public int getPlayerInfoInteger(org.bukkit.World world,
                                String player,
                                String node,
                                int defaultValue)

Get a players informational node (Integer) value

Parameters:

world - World Object

player - Player name

node - Permission node

defaultValue - Default value

Returns:

Value

getPlayerInfoInteger

public int getPlayerInfoInteger(org.bukkit.entity.Player player,
                                String node,
                                int defaultValue)

Get a players informational node (Integer) value

Parameters:

player - Player Object

node - Permission node

defaultValue - Default value

Returns:

Value

setPlayerInfoInteger

public abstract void setPlayerInfoInteger(String world,
                                          String player,
                                          String node,
                                          int value)

Set a players informational node (Integer) value

Parameters:

world - World name

player - Player name

node - Permission node

value - Value to set

setPlayerInfoInteger

public void setPlayerInfoInteger(org.bukkit.World world,
                                 String player,
                                 String node,
                                 int value)

Set a players informational node (Integer) value

Parameters:

world - World Object

player - Player name

node - Permission node

value - Value to set

setPlayerInfoInteger

public void setPlayerInfoInteger(org.bukkit.entity.Player player,
                                 String node,
                                 int value)

Set a players informational node (Integer) value

Parameters:

player - Player Object

node - Permission node

value - Value to set

getGroupInfoInteger

public abstract int getGroupInfoInteger(String world,
                                        String group,
                                        String node,
                                        int defaultValue)

Get a groups informational node (Integer) value

Parameters:

world - World name

group - Group name

node - Permission node

defaultValue - Default value

Returns:

Value

getGroupInfoInteger

public int getGroupInfoInteger(org.bukkit.World world,
                               String group,
                               String node,
                               int defaultValue)

Get a groups informational node (Integer) value

Parameters:

world - World Object

group - Group name

node - Permission node

defaultValue - Default value

Returns:

Value

setGroupInfoInteger

public abstract void setGroupInfoInteger(String world,
                                         String group,
                                         String node,
                                         int value)

Set a groups informational node (Integer) value

Parameters:

world - World name

group - Group name

node - Permission node

value - Value to set

setGroupInfoInteger

public void setGroupInfoInteger(org.bukkit.World world,
                                String group,
                                String node,
                                int value)

Set a groups informational node (Integer) value

Parameters:

world - World Object

group - Group name

node - Permission node

value - Value to set

getPlayerInfoDouble

public abstract double getPlayerInfoDouble(String world,
                                           String player,
                                           String node,
                                           double defaultValue)

Get a players informational node (Double) value

Parameters:

world - World name

player - Group name

node - Permission node

defaultValue - Default value

Returns:

Value

getPlayerInfoDouble

public double getPlayerInfoDouble(org.bukkit.World world,
                                  String player,
                                  String node,
                                  double defaultValue)

Get a players informational node (Double) value

Parameters:

world - World Object

player - Player name

node - Permission node

defaultValue - Default value

Returns:

Value

getPlayerInfoDouble

public double getPlayerInfoDouble(org.bukkit.entity.Player player,
                                  String node,
                                  double defaultValue)

Get a players informational node (Double) value

Parameters:

player - Player Object

node - Permission node

defaultValue - Default value

Returns:

Value

setPlayerInfoDouble

public abstract void setPlayerInfoDouble(String world,
                                         String player,
                                         String node,
                                         double value)

Set a players informational node (Double) value

Parameters:

world - World name

player - Group name

node - Permission node

value - Value to set

setPlayerInfoDouble

public void setPlayerInfoDouble(org.bukkit.World world,
                                String player,
                                String node,
                                double value)

Set a players informational node (Double) value

Parameters:

world - World Object

player - Player name

node - Permission node

value - Value to set

setPlayerInfoDouble

public void setPlayerInfoDouble(org.bukkit.entity.Player player,
                                String node,
                                double value)

Set a players informational node (Double) value

Parameters:

player - Player Object

node - Permission node

value - Value to set

getGroupInfoDouble

public abstract double getGroupInfoDouble(String world,
                                          String group,
                                          String node,
                                          double defaultValue)

Get a groups informational node (Double) value

Parameters:

world - World name

group - Group name

node - Permission node

defaultValue - Default value

Returns:

Value

getGroupInfoDouble

public double getGroupInfoDouble(org.bukkit.World world,
                                 String group,
                                 String node,
                                 double defaultValue)

Get a groups informational node (Double) value

Parameters:

world - World Object

group - Group name

node - Permission node

defaultValue - Default value

Returns:

Value

setGroupInfoDouble

public abstract void setGroupInfoDouble(String world,
                                        String group,
                                        String node,
                                        double value)

Set a groups informational node (Double) value

Parameters:

world - World name

group - Group name

node - Permission node

value - Value to set

setGroupInfoDouble

public void setGroupInfoDouble(org.bukkit.World world,
                               String group,
                               String node,
                               double value)

Set a groups informational node (Double) value

Parameters:

world - World Object

group - Group name

node - Permission node

value - Value to set

getPlayerInfoBoolean

public abstract boolean getPlayerInfoBoolean(String world,
                                             String player,
                                             String node,
                                             boolean defaultValue)

Get a players informational node (Boolean) value

Parameters:

world - World name

player - Player name

node - Permission node

defaultValue - Default value

Returns:

Value

getPlayerInfoBoolean

public boolean getPlayerInfoBoolean(org.bukkit.World world,
                                    String player,
                                    String node,
                                    boolean defaultValue)

Get a players informational node (Boolean) value

Parameters:

world - World Object

player - Player name

node - Permission node

defaultValue - Default value

Returns:

Value

getPlayerInfoBoolean

public boolean getPlayerInfoBoolean(org.bukkit.entity.Player player,
                                    String node,
                                    boolean defaultValue)

Get a players informational node (Boolean) value

Parameters:

player - Player Object

node - Permission node

defaultValue - Default value

Returns:

Value

setPlayerInfoBoolean

public abstract void setPlayerInfoBoolean(String world,
                                          String player,
                                          String node,
                                          boolean value)

Set a players informational node (Boolean) value

Parameters:

world - World name

player - Player name

node - Permission node

value - Value to set

setPlayerInfoBoolean

public void setPlayerInfoBoolean(org.bukkit.World world,
                                 String player,
                                 String node,
                                 boolean value)

Set a players informational node (Boolean) value

Parameters:

world - World Object

player - Player name

node - Permission node

value - Value to set

setPlayerInfoBoolean

public void setPlayerInfoBoolean(org.bukkit.entity.Player player,
                                 String node,
                                 boolean value)

Set a players informational node (Boolean) value

Parameters:

player - Player Object

node - Permission node

value - Value to set

getGroupInfoBoolean

public abstract boolean getGroupInfoBoolean(String world,
                                            String group,
                                            String node,
                                            boolean defaultValue)

Get a groups informational node (Boolean) value

Parameters:

world - Name of World

group - Name of Group

node - Permission node

defaultValue - Default value

Returns:

Value

getGroupInfoBoolean

public boolean getGroupInfoBoolean(org.bukkit.World world,
                                   String group,
                                   String node,
                                   boolean defaultValue)

Set a players informational node (Boolean) value

Parameters:

world - World Object

group - Group name

node - Permission node

defaultValue - Default value

Returns:

Value

setGroupInfoBoolean

public abstract void setGroupInfoBoolean(String world,
                                         String group,
                                         String node,
                                         boolean value)

Set a groups informational node (Boolean) value

Parameters:

world - World name

group - Group name

node - Permission node

value - Value to set

setGroupInfoBoolean

public void setGroupInfoBoolean(org.bukkit.World world,
                                String group,
                                String node,
                                boolean value)

Set a players informational node (Boolean) value

Parameters:

world - World Object

group - Group name

node - Permission node

value - Value to set

getPlayerInfoString

public abstract String getPlayerInfoString(String world,
                                           String player,
                                           String node,
                                           String defaultValue)

Get a players informational node (String) value

Parameters:

world - World name

player - Player name

node - Permission node

defaultValue - Default value

Returns:

Value

getPlayerInfoString

public String getPlayerInfoString(org.bukkit.World world,
                                  String player,
                                  String node,
                                  String defaultValue)

Get a players informational node (String) value

Parameters:

world - World Object

player - Player name

node - Permission node

defaultValue - Default value

Returns:

Value

getPlayerInfoString

public String getPlayerInfoString(org.bukkit.entity.Player player,
                                  String node,
                                  String defaultValue)

Get a players informational node (String) value

Parameters:

player - Player Object

node - Permission node

defaultValue - Default value

Returns:

Value

setPlayerInfoString

public abstract void setPlayerInfoString(String world,
                                         String player,
                                         String node,
                                         String value)

Set a players informational node (String) value

Parameters:

world - World name

player - Player name

node - Permission node

value - Value to set

setPlayerInfoString

public void setPlayerInfoString(org.bukkit.World world,
                                String player,
                                String node,
                                String value)

Set a players informational node (String) value

Parameters:

world - World name

player - Player name

node - Permission node

value - Value to set

setPlayerInfoString

public void setPlayerInfoString(org.bukkit.entity.Player player,
                                String node,
                                String value)

Set a players informational node (String) value

Parameters:

player - Player Object

node - Permission node

value - Value ot set

getGroupInfoString

public abstract String getGroupInfoString(String world,
                                          String group,
                                          String node,
                                          String defaultValue)

Get a groups informational node (String) value

Parameters:

world - Name of World

group - Name of Group

node - Permission node

defaultValue - Default value

Returns:

Value

getGroupInfoString

public String getGroupInfoString(org.bukkit.World world,
                                 String group,
                                 String node,
                                 String defaultValue)

Set a players informational node (String) value

Parameters:

world - World Object

group - Group name

node - Permission node

defaultValue - Default value

Returns:

Value

setGroupInfoString

public abstract void setGroupInfoString(String world,
                                        String group,
                                        String node,
                                        String value)

Set a groups informational node (String) value

Parameters:

world - World name

group - Group name

node - Permission node

value - Value to set

setGroupInfoString

public void setGroupInfoString(org.bukkit.World world,
                               String group,
                               String node,
                               String value)

Set a groups informational node (String) value

Parameters:

world - World name

group - Group name

node - Permission node

value - Value to set

playerInGroup

public boolean playerInGroup(String world,
                             String player,
                             String group)

Check if player is member of a group.

Parameters:

world - World name

player - Player name

group - Group name

Returns:

Success or Failure

playerInGroup

public boolean playerInGroup(org.bukkit.World world,
                             String player,
                             String group)

Check if player is member of a group.

Parameters:

world - World Object

player - Player name

group - Group name

Returns:

Success or Failure

playerInGroup

public boolean playerInGroup(org.bukkit.entity.Player player,
                             String group)

Check if player is member of a group.

Parameters:

player - Player Object

group - Group name

Returns:

Success or Failure

getPlayerGroups

public String[] getPlayerGroups(String world,
                                String player)

Gets the list of groups that this player has

Parameters:

world - World name

player - Player name

Returns:

Array of groups

getPlayerGroups

public String[] getPlayerGroups(org.bukkit.World world,
                                String player)

Gets the list of groups that this player has

Parameters:

world - World Object

player - Player name

Returns:

Array of groups

getPlayerGroups

public String[] getPlayerGroups(org.bukkit.entity.Player player)

Gets the list of groups that this player has

Parameters:

player - Player Object

Returns:

Array of groups

getPrimaryGroup

public String getPrimaryGroup(String world,
                              String player)

Gets players primary group

Parameters:

world - World name

player - Player name

Returns:

Players primary group

getPrimaryGroup

public String getPrimaryGroup(org.bukkit.World world,
                              String player)

Gets players primary group

Parameters:

world - World Object

player - Player name

Returns:

Players primary group

getPrimaryGroup

public String getPrimaryGroup(org.bukkit.entity.Player player)

Get players primary group

Parameters:

player - Player Object

Returns:

Players primary group

getGroups

public String[] getGroups()

Returns a list of all known groups

Returns:

an Array of String of all groups