Package org.spongepowered.api.command
Interface CommandCompletion
-
public interface CommandCompletionA potential completion of a command argument.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interfaceCommandCompletion.FactoryA factory for constructingCommandCompletions
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Modifier and Type Method Description Stringcompletion()The potential completion that this object represents.static CommandCompletionof(@NonNull String completion)Creates a basic completion that only containsStringthat a given input may be completed to.static CommandCompletionof(@NonNull String completion, @Nullable Component tooltip)Creates a completion that containsStringthat a given input may be completed to, and an associated tooltip.Optional<Component>tooltip()The tooltip that may be displayed by the client when hovering over this completion.
-
-
-
Method Detail
-
of
static CommandCompletion of(@NonNull String completion)
Creates a basic completion that only containsStringthat a given input may be completed to.- Parameters:
completion- The potential completion- Returns:
- The
CommandCompletionobject
-
of
static CommandCompletion of(@NonNull String completion, @Nullable Component tooltip)
Creates a completion that containsStringthat a given input may be completed to, and an associated tooltip.- Parameters:
completion- The potential completiontooltip- The tooltip- Returns:
- The
CommandCompletionobject
-
completion
String completion()
The potential completion that this object represents.- Returns:
- The completion
-
-