org.projectnyx.command

Interface UIText

All Known Implementing Classes:

StaticPlainText

public interface UIText

Method Summary

Modifier and Type	Method and Description
default String	asHTML(CommandIssuer issuer) Returns an HTML-encoded text for a specific command issuer.
String	get(CommandIssuer issuer) Returns a plain text preprocessed for a specific command issuer.
default String	toANSI(CommandIssuer issuer)
default String	toMinecraft(CommandIssuer issuer) Returns a text encoded with Minecraft color codes (§*).

Method Detail

get

String get(CommandIssuer issuer)

Returns a plain text preprocessed for a specific command issuer.

A common usage of the issuer parameter is to translate to that issuer's locale.

This method should return a consistent value if null is passed in.

Parameters:

issuer - the CommandIssuer whom this text will be preprocessed for. If null, a default value should be returned.

Returns:

unformatted text

asHTML

default String asHTML(CommandIssuer issuer)

Returns an HTML-encoded text for a specific command issuer.

The default implementation redirects to get(CommandIssuer) and escapes special HTML characters in it.

Parameters:

issuer - the CommandIssuer to preprocess for or null.

Returns:

HTML-encoded text

See Also:

get(CommandIssuer)

toMinecraft

default String toMinecraft(CommandIssuer issuer)

Returns a text encoded with Minecraft color codes (§*).

The default implementation redirects to get(CommandIssuer).

Parameters:

issuer - the CommandIssuer to preprocess for or null.

Returns:

A text formatted using MCPE color codes

See Also:

get(CommandIssuer)

toANSI

default String toANSI(CommandIssuer issuer)