Package org.spongepowered.api.command
Interface CommandCompletion
public interface CommandCompletion
A potential completion of a command argument.
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic interface
A factory for constructingCommandCompletion
s -
Method Summary
Modifier and TypeMethodDescriptionThe potential completion that this object represents.static CommandCompletion
Creates a basic completion that only containsString
that a given input may be completed to.static CommandCompletion
Creates a completion that containsString
that a given input may be completed to, and an associated tooltip.tooltip()
The tooltip that may be displayed by the client when hovering over this completion.
-
Method Details
-
of
Creates a basic completion that only containsString
that a given input may be completed to.- Parameters:
completion
- The potential completion- Returns:
- The
CommandCompletion
object
-
of
Creates a completion that containsString
that a given input may be completed to, and an associated tooltip.- Parameters:
completion
- The potential completiontooltip
- The tooltip- Returns:
- The
CommandCompletion
object
-
completion
String completion()The potential completion that this object represents.- Returns:
- The completion
-
tooltip
The tooltip that may be displayed by the client when hovering over this completion.- Returns:
- The tooltip, if any
-