com.comphenix.xp

Class ActionTypes

java.lang.Object

com.comphenix.xp.ActionTypes

public class ActionTypes
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BLOCK
static java.lang.String	BONUS
static java.lang.String	BREWING
static java.lang.String	CRAFTING
static java.lang.String	PLACE
static java.lang.String	SMELTING

Constructor Summary

Constructors

Constructor and Description
ActionTypes()

Method Summary

Methods

Modifier and Type	Method and Description
static ActionTypes	Default() Retrieves the default action registry.
java.lang.Integer	getType(java.lang.String name) Retrieves a registered action type by name, or NULL if no such type could be found.
java.util.Collection<java.lang.Integer>	getTypes() Retrieves a collection of every registered action type.
void	register(int id, java.lang.Iterable<java.lang.String> names) Registers additional names for a given action type.
int	register(java.lang.String... names) Registers an action type with a list of names.
void	unregister(int id) Unregisters a specified action type.

Methods inherited from class java.lang.Object

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

Field Detail

BLOCK

public static java.lang.String BLOCK

BONUS

public static java.lang.String BONUS

PLACE

public static java.lang.String PLACE

SMELTING

public static java.lang.String SMELTING

CRAFTING

public static java.lang.String CRAFTING

BREWING

public static java.lang.String BREWING

Constructor Detail

ActionTypes

public ActionTypes()

Method Detail

Default

public static ActionTypes Default()

Retrieves the default action registry.

Returns:

A default action registry.

getTypes

public java.util.Collection<java.lang.Integer> getTypes()

Retrieves a collection of every registered action type.

Returns:

Collection of every registered action type.

getType

public java.lang.Integer getType(java.lang.String name)

Retrieves a registered action type by name, or NULL if no such type could be found.

Parameters:

name - - name of the action type to find.

Returns:

Unique ID of the action type, or NULL if not found.

register

public int register(java.lang.String... names)

Registers an action type with a list of names. Names should use the ENUM naming convention.

Parameters:

names - - names of the given action type.

Returns:

Unique ID of the registered action type.

register

public void register(int id,
            java.lang.Iterable<java.lang.String> names)

Registers additional names for a given action type. Names should use the ENUM naming convention.

Parameters:

id - - unique action type id.

names - - additional list of synonyms/names for this action.

unregister

public void unregister(int id)

Unregisters a specified action type.

Parameters:

id - - id of the action type to remove.