io.github.nucleuspowered.nucleus.api.text

Interface NucleusTextTemplate

All Superinterfaces:

org.spongepowered.api.text.TextElement, org.spongepowered.api.text.TextRepresentable

public interface NucleusTextTemplate
extends org.spongepowered.api.text.TextRepresentable

Represents a wrapped TextTemplate that Nucleus uses to create texts from templates.

Method Summary

Modifier and Type	Method and Description
boolean	containsTokens() Returns whether there are tokens to parse.
default org.spongepowered.api.text.Text	getForCommandSource(org.spongepowered.api.command.CommandSource source) Gets the Text where the tokens have been parsed from the viewpoint of the supplied CommandSource.
org.spongepowered.api.text.Text	getForCommandSource(org.spongepowered.api.command.CommandSource source, Map<String,Function<org.spongepowered.api.command.CommandSource,Optional<org.spongepowered.api.text.Text>>> tokensArray, Map<String,Object> variables) Gets the Text where the tokens have been parsed from the viewpoint of the supplied CommandSource.
Optional<org.spongepowered.api.text.Text>	getPrefix() Gets the static Text this message will be prefixed with, if any.
Optional<org.spongepowered.api.text.Text>	getSuffix() Gets the static Text this message will be suffixed with, if any.
org.spongepowered.api.text.TextTemplate	getTextTemplate() Gets the underlying TextTemplate
boolean	isEmpty() Whether the text is empty.

Methods inherited from interface org.spongepowered.api.text.TextRepresentable

applyTo, toText

Method Detail

isEmpty

boolean isEmpty()

Whether the text is empty.

Returns:

true if so.

getPrefix

Optional<org.spongepowered.api.text.Text> getPrefix()

Gets the static Text this message will be prefixed with, if any.

Returns:

The text

getSuffix

Optional<org.spongepowered.api.text.Text> getSuffix()

Gets the static Text this message will be suffixed with, if any.

Returns:

The text

getTextTemplate

org.spongepowered.api.text.TextTemplate getTextTemplate()

Gets the underlying TextTemplate

Returns:

The TextTemplate

getForCommandSource

default org.spongepowered.api.text.Text getForCommandSource(org.spongepowered.api.command.CommandSource source)

Gets the Text where the tokens have been parsed from the viewpoint of the supplied CommandSource. Any unknown tokens in the parsed text will be left blank.

Parameters:

source - The CommandSource that will influence what is displayed by the tokens.

Returns:

The parsed Text

containsTokens

boolean containsTokens()

Returns whether there are tokens to parse.

Returns:

true if there are tokens.

getForCommandSource

org.spongepowered.api.text.Text getForCommandSource(org.spongepowered.api.command.CommandSource source,
                                                    @Nullable
                                                    Map<String,Function<org.spongepowered.api.command.CommandSource,Optional<org.spongepowered.api.text.Text>>> tokensArray,
                                                    @Nullable
                                                    Map<String,Object> variables)

Gets the Text where the tokens have been parsed from the viewpoint of the supplied CommandSource.

By supplying a token array, these token identifiers act as additional tokens that could be encountered, and will be used above standard tokens. This is useful for having a token in a specific context, such as "displayfrom", which might only be used in a message, and is not worth registering in a NucleusMessageTokenService.TokenParser. They must not contain the token start or end delimiters.

The variables are items that might be used by tokens, and is generally best used with your own messages and tokens. NucleusMessageTokenService.TokenParsers are passed this map.

Parameters:

source - The CommandSource that will influence what is displayed by the tokens.

tokensArray - The extra tokens that can be used to parse a text.

variables - The variables.

Returns:

The parsed Text