ArgumentString

open class ArgumentString(val suggestions: List<String> = emptyList(), val isGreedy: Boolean = false) : ArgumentComp<String>

ArgumentString is a parsable argument that represents a string.

Parameters

suggestions

A list of suggested string values for auto-completion.

isGreedy

If true, the argument will consume all remaining input as a single string. A greedy argument is always the last argument.

Constructors

Link copied to clipboard
constructor(suggestions: List<String> = emptyList(), isGreedy: Boolean = false)

Properties

Link copied to clipboard
open override val consumes: Int
Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
open override fun getParamFormat(isOptional: Boolean): String

Gets the usage string for this argument.

Link copied to clipboard
override fun parse(input: List<String>, sender: CommandSender): String

Parses the input strings into the desired type.

Link copied to clipboard
open override fun parseComplete(input: List<String>, sender: CommandSender): String

Parses the complete input strings into the desired type.

Link copied to clipboard
open override fun suggest(input: List<String>, sender: CommandSender): List<String>

Suggests possible completions for the input strings.