com.comphenix.xp.messages

Class HeroService

java.lang.Object

com.comphenix.xp.messages.HeroService

All Implemented Interfaces:

Service, ChannelService

public class HeroService
extends java.lang.Object
implements ChannelService

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Constructor Summary

Constructors

Constructor and Description
HeroService()

Method Summary

Methods

Modifier and Type	Method and Description
void	announce(java.lang.String channelID, java.lang.String message) Broadcast a message on a given channel.
void	emote(java.lang.String channelID, java.lang.String message, org.bukkit.entity.Player sender) Sends a message with a sender on a given channel.
static boolean	exists() Determines whether or not the HeroChat plugin is loaded AND enabled.
java.lang.String	getServiceName() Retrieves a unique string identifying this service.
boolean	hasChannel(java.lang.String channelID) Determines whether or not the channel with the given identifier exists.

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

HeroService

public HeroService()

Method Detail

exists

public static boolean exists()

Determines whether or not the HeroChat plugin is loaded AND enabled.

Returns:

TRUE if it is, FALSE otherwise.

hasChannel

public boolean hasChannel(java.lang.String channelID)

Description copied from interface: ChannelService

Determines whether or not the channel with the given identifier exists.

Specified by:

hasChannel in interface ChannelService

Parameters:

channelID - - channel identifier.

Returns:

TRUE if the channel exists, FALSE otherwise.

announce

public void announce(java.lang.String channelID,
            java.lang.String message)

Description copied from interface: ChannelService

Broadcast a message on a given channel.

Specified by:

announce in interface ChannelService

Parameters:

channelID - - channel identifier.

message - - message to broadcast.

emote

public void emote(java.lang.String channelID,
         java.lang.String message,
         org.bukkit.entity.Player sender)

Description copied from interface: ChannelService

Sends a message with a sender on a given channel.

Specified by:

emote in interface ChannelService

Parameters:

channelID - - channel identifier.

message - - message to broadcast.

sender - - sender to include in the message.

getServiceName

public java.lang.String getServiceName()

Description copied from interface: Service

Retrieves a unique string identifying this service. May also be used during parsing.

Note that this identifier must conform to an ENUM convention: upper case only, underscore for space.

A service MUST not alter its identifier once it has been registered.

Specified by:

getServiceName in interface Service

Returns:

A unique reward ID.