org.spongepowered.api.command

Class CommandMessageFormatting

java.lang.Object

org.spongepowered.api.command.CommandMessageFormatting

public class CommandMessageFormatting
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static Text	ELLIPSIS_TEXT
static Text	GT_TEXT
static Text	LT_TEXT
static Text	PIPE_TEXT
static Text	SPACE_TEXT
static Text	STAR_TEXT

Method Summary

Modifier and Type	Method and Description
static Text	debug(Text debug) Format text to be output as a debug message directly to a sender.
static Text	error(Text error) Format text to be output as an error directly to a sender.

Methods inherited from class java.lang.Object

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

Field Detail

PIPE_TEXT

public static final Text PIPE_TEXT

SPACE_TEXT

public static final Text SPACE_TEXT

STAR_TEXT

public static final Text STAR_TEXT

LT_TEXT

public static final Text LT_TEXT

GT_TEXT

public static final Text GT_TEXT

ELLIPSIS_TEXT

public static final Text ELLIPSIS_TEXT

Method Detail

error

public static Text error(Text error)

Format text to be output as an error directly to a sender. Not necessary when creating an exception to be thrown

Parameters:

error - The error message

Returns:

The formatted error message.

debug

public static Text debug(Text debug)

Format text to be output as a debug message directly to a sender.

Parameters:

debug - The debug message

Returns:

The formatted debug message.