api-common/su.plo.slib.api.command.brigadier/CustomArgumentType

CustomArgumentType

interface CustomArgumentType<PARSED, NATIVE> : ArgumentType<PARSED>

An argument type that wraps a native argument type.

The native type is sent to the client for client-side completions and syntax validation, while the server uses custom parsing logic to produce the parsed type.

Parameters

PARSED

The custom type produced by server-side parsing

NATIVE

The native type sent to the client

Properties

examples

@get:ApiStatus.NonExtendable

open override val examples: Collection<String>

nativeType

abstract val nativeType: ArgumentType<NATIVE>

The native argument type sent to the client.

Functions

getExamples

@ApiStatus.NonExtendable

open override fun getExamples(): Collection<String>

This is controlled client-side and can't be changed server-side.

listSuggestions

open override fun <S> listSuggestions(context: CommandContext<S>, builder: SuggestionsBuilder): CompletableFuture<Suggestions>

Suggestions of the nativeType.

parse

abstract fun parse(p0: StringReader?): PARSED?

useNativeSuggestions

open fun useNativeSuggestions(): Boolean

Whether native suggestions should be used.