Package com.booksaw.betterTeams.message

Class HelpMessage

java.lang.Object

com.booksaw.betterTeams.message.HelpMessage

All Implemented Interfaces:

Message

public class HelpMessage
extends Object
implements Message

Constructor Summary

Constructors

Constructor	Description
HelpMessage(SubCommand command, String label, ParentCommand parent)

Method Summary

Modifier and Type	Method	Description
String	createHelpMessage(String label, String commandPath, String description)	Used to create a formatted help message to explain what a command does to the user
void	sendMessage(Collection<? extends org.bukkit.command.CommandSender> senders)	Used to send the message to a Collection of Players.
void	sendMessage(org.bukkit.command.CommandSender sender)	Used to send the message.
void	sendTitle(Collection<org.bukkit.entity.Player> players)	Used to send a title to a Collection of Players.
void	sendTitle(org.bukkit.entity.Player player)	Used to send a title to a Player.

Methods inherited from class java.lang.Object

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

Constructor Details

HelpMessage

public HelpMessage(SubCommand command,
 String label,
 ParentCommand parent)

Method Details

sendMessage

public void sendMessage(org.bukkit.command.CommandSender sender)

Description copied from interface: Message

Used to send the message.

Specified by:

sendMessage in interface Message

Parameters:

sender - the CommandSender to send the message to.

sendTitle

public void sendTitle(org.bukkit.entity.Player player)

Description copied from interface: Message

Used to send a title to a Player.

A 'title' is a big text, centered on the recipient screen. It fades in and out and is only shortly visible.

This message is not logged in the chat. if you need this, use Message.sendMessage(CommandSender) instead.

Specified by:

sendTitle in interface Message

Parameters:

player - the Player to send the title to.

sendMessage

public void sendMessage(Collection<? extends org.bukkit.command.CommandSender> senders)

Description copied from interface: Message

Used to send the message to a Collection of Players.

Specified by:

sendMessage in interface Message

Parameters:

senders - the CommandSenders to send the message to

sendTitle

public void sendTitle(Collection<org.bukkit.entity.Player> players)

Description copied from interface: Message

Used to send a title to a Collection of Players.

A 'title' is a big text, centered on the recipient screen. It fades in and out and is only shortly visible.

This message is not logged in the chat. if you need this, use Message.sendMessage(Collection) instead.

Specified by:

sendTitle in interface Message

Parameters:

players - the Players to send the title to.

createHelpMessage

public String createHelpMessage(String label,
 String commandPath,
 String description)

Used to create a formatted help message to explain what a command does to the user

Parameters:

label - the base command

commandPath - the rest of the command (i.e. help [param])

description - the description of the command

Returns:

the created message relating to that command