Parameter

class Parameter<T : Any>(val name: String, val required: Boolean, val default: T?, val vararg: Boolean, val verifier: Parameter.Verificator<T>?, val autocompletionHandler: AutoCompletionProvider?)

Constructors

Link copied to clipboard
constructor(name: String, required: Boolean, default: T?, vararg: Boolean, verifier: Parameter.Verificator<T>?, autocompletionHandler: AutoCompletionProvider?)

Types

Link copied to clipboard
fun interface Verificator<T : Any>

Properties

Link copied to clipboard
Link copied to clipboard
val default: T?

Default value if optional.

Link copied to clipboard
val description: MutableComponent
Link copied to clipboard
var index: Int
Link copied to clipboard

Name of the parameter.

Link copied to clipboard

Whether the parameter is required.

Link copied to clipboard

Whether the parameter is a vararg. Parsed result will be an Array if true.

Link copied to clipboard

Functions

Link copied to clipboard
context(context: Command.Handler.Context)
fun <T : Any> Parameter<T>.cast(): T
Link copied to clipboard
context(context: Command.Handler.Context)
fun <T : Any> Parameter<T>.castNotRequired(): T?
Link copied to clipboard
context(context: Command.Handler.Context)
fun <T : Any> Parameter<T>.castVararg(): List<T>
Link copied to clipboard
Link copied to clipboard
fun nameAsText(): Component