io.github.nucleuspowered.nucleus.api.placeholder

Interface NucleusPlaceholderService

public interface NucleusPlaceholderService

Provides a way to determine how Nucleus uses placeholders.

Method Summary

Modifier and Type	Method and Description
java.util.Optional<org.spongepowered.api.text.placeholder.PlaceholderParser>	getParser(java.lang.String token) Gets the parser associated with the provided token name, if any, prefixing un-namespaced tokens with the Nucleus prefix.
org.spongepowered.api.text.placeholder.PlaceholderParser	optionParser() Gets the Nucleus placeholder parser for displaying Subject.getOption(String)
org.spongepowered.api.text.TextRepresentable	parse(@Nullable org.spongepowered.api.command.CommandSource commandSource, java.lang.String input)
org.spongepowered.api.text.placeholder.PlaceholderText	textForSubjectAndOption(org.spongepowered.api.service.permission.Subject subject, java.lang.String option) Creates a PlaceholderText for displaying a Subjects option.

Method Detail

parse

org.spongepowered.api.text.TextRepresentable parse(@Nullable org.spongepowered.api.command.CommandSource commandSource,
                                                   java.lang.String input)

getParser

java.util.Optional<org.spongepowered.api.text.placeholder.PlaceholderParser> getParser(java.lang.String token)

Gets the parser associated with the provided token name, if any, prefixing un-namespaced tokens with the Nucleus prefix.

Parameters:

token - The token name

Returns:

The PlaceholderParser, if any

optionParser

org.spongepowered.api.text.placeholder.PlaceholderParser optionParser()

Gets the Nucleus placeholder parser for displaying Subject.getOption(String)

Returns:

The parser.

textForSubjectAndOption

org.spongepowered.api.text.placeholder.PlaceholderText textForSubjectAndOption(org.spongepowered.api.service.permission.Subject subject,
                                                                               java.lang.String option)

Creates a PlaceholderText for displaying a Subjects option.

Parameters:

subject - The Subject

option - The option to display

Returns:

The PlaceholderText