mirai-console/net.mamoe.mirai.console.command.descriptor

Package net.mamoe.mirai.console.command.descriptor

Types

AbstractCommandParameter

@ExperimentalCommandDescriptors

abstract class AbstractCommandParameter<T> : CommandParameter<T>

AbstractCommandSignature

@ExperimentalCommandDescriptors

abstract class AbstractCommandSignature : CommandSignature

AbstractCommandValueArgumentParser

abstract class AbstractCommandValueArgumentParser<T : Any> : CommandValueArgumentParser<T>

AbstractCommandValueParameter

@ExperimentalCommandDescriptors

sealed class AbstractCommandValueParameter<T> : AbstractCommandParameter<T> , CommandValueParameter<T>

ArgumentAcceptance

@ExperimentalCommandDescriptors

sealed class ArgumentAcceptance

BooleanValueArgumentParser

object BooleanValueArgumentParser : InternalCommandValueArgumentParserExtensions<Boolean>

当字符串内容为(不区分大小写) "true", "yes", "enabled", "on", "1"

ByteValueArgumentParser

object ByteValueArgumentParser : InternalCommandValueArgumentParserExtensions<Byte>

使用 String.toByte 解析

CommandArgumentContext

interface CommandArgumentContext

指令参数环境, 即 CommandValueArgumentParser 的集合, 用于 CompositeCommand 和 SimpleCommand.

CommandArgumentContextAware

interface CommandArgumentContextAware

拥有 buildCommandArgumentContext 的类

CommandArgumentContextBuilder

class CommandArgumentContextBuilder : MutableList<CommandArgumentContext.ParserPair<*>>

参考 buildCommandArgumentContext

CommandArgumentParserException

class CommandArgumentParserException @JvmOverloads constructor(message: String, cause: Throwable? = null) : IllegalCommandArgumentException

在解析参数时遇到的正常错误. 如参数不符合规范等.

CommandDeclarationClashException

@ExperimentalCommandDescriptors

open class CommandDeclarationClashException(val command: Command, val signatures: List<CommandSignature>) : CommandDeclarationException

CommandDeclarationException

open class CommandDeclarationException : RuntimeException

CommandParameter

@ExperimentalCommandDescriptors

interface CommandParameter<T>

Inherited instances must be CommandValueParameter or CommandReceiverParameter

CommandReceiverParameter

@ExperimentalCommandDescriptors

sealed class CommandReceiverParameter<T> : AbstractCommandParameter<T> , CommandParameter<T>

CommandResolutionException

open class CommandResolutionException : RuntimeException

CommandSignature

@ExperimentalCommandDescriptors

interface CommandSignature

指令签名. 表示指令定义的需要的参数.

CommandSignatureFromKFunction

@ConsoleExperimentalApi

@ExperimentalCommandDescriptors

interface CommandSignatureFromKFunction : CommandSignature

来自 KFunction 反射得到的 CommandSignature

CommandSignatureFromKFunctionImpl

@ConsoleExperimentalApi

@ExperimentalCommandDescriptors

open class CommandSignatureFromKFunctionImpl( val receiverParameter: CommandReceiverParameter<*>?, val valueParameters: List<AbstractCommandValueParameter<*>>, val originFunction: KFunction<*>, onCall: suspend CommandSignatureFromKFunctionImpl.(resolvedCommandCall: ResolvedCommandCall) -> Unit) : AbstractCommandSignature, CommandSignatureFromKFunction

CommandSignatureImpl

@ExperimentalCommandDescriptors

open class CommandSignatureImpl( val receiverParameter: CommandReceiverParameter<*>?, val valueParameters: List<AbstractCommandValueParameter<*>>, onCall: suspend CommandSignatureImpl.(resolvedCommandCall: ResolvedCommandCall) -> Unit) : AbstractCommandSignature, CommandSignature

CommandValueArgumentParser

interface CommandValueArgumentParser<out T : Any>

指令参数解析器. 用于解析字符串或 SingleMessage 到特定参数类型.

CommandValueParameter

@ExperimentalCommandDescriptors

interface CommandValueParameter<T> : CommandParameter<T>

Inherited instances must be AbstractCommandValueParameter.

ContentStringTypeVariant

@ExperimentalCommandDescriptors

object ContentStringTypeVariant : TypeVariant<String>

DoubleValueArgumentParser

object DoubleValueArgumentParser : InternalCommandValueArgumentParserExtensions<Double>

使用 String.toDouble 解析

EmptyCommandArgumentContext

object EmptyCommandArgumentContext : CommandArgumentContext

EnumValueArgumentParser

class EnumValueArgumentParser<T : Enum<T>>(type: Class<T>) : InternalCommandValueArgumentParserExtensions<T>

解析参数为枚举 T

ExistingBotValueArgumentParser

object ExistingBotValueArgumentParser : InternalCommandValueArgumentParserExtensions<Bot>

根据 Bot.id 解析一个登录后的 Bot

ExistingContactValueArgumentParser

object ExistingContactValueArgumentParser : InternalCommandValueArgumentParserExtensions<Contact>

ExistingFriendValueArgumentParser

object ExistingFriendValueArgumentParser : InternalCommandValueArgumentParserExtensions<Friend>

解析任意一个存在的好友.

ExistingGroupValueArgumentParser

object ExistingGroupValueArgumentParser : InternalCommandValueArgumentParserExtensions<Group>

解析任意一个存在的群.

ExistingMemberValueArgumentParser

object ExistingMemberValueArgumentParser : InternalCommandValueArgumentParserExtensions<Member>

解析任意一个群成员.

ExistingUserValueArgumentParser

object ExistingUserValueArgumentParser : InternalCommandValueArgumentParserExtensions<User>

ExperimentalCommandDescriptors

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.TYPEALIAS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.FIELD, AnnotationTarget.CONSTRUCTOR])

@ConsoleExperimentalApi

@ExperimentalCommandDescriptors

annotation class ExperimentalCommandDescriptors(val message: String = "Command descriptors are an experimental API.")

标记一个实验性的指令解释器 API.

FloatValueArgumentParser

object FloatValueArgumentParser : InternalCommandValueArgumentParserExtensions<Float>

使用 String.toFloat 解析

ImageValueArgumentParser

object ImageValueArgumentParser : InternalCommandValueArgumentParserExtensions<Image>

解析 String 通过 Image.

IntValueArgumentParser

object IntValueArgumentParser : InternalCommandValueArgumentParserExtensions<Int>

使用 String.toInt 解析

LongValueArgumentParser

object LongValueArgumentParser : InternalCommandValueArgumentParserExtensions<Long>

使用 String.toLong 解析

MappingCommandValueArgumentParser

class MappingCommandValueArgumentParser<T : Any, R : Any>(original: CommandValueArgumentParser<T>, mapper: MappingCommandValueArgumentParser<T, R>.(T) -> R) : AbstractCommandValueArgumentParser<R>

MessageChainTypeVariant

@ExperimentalCommandDescriptors

object MessageChainTypeVariant : TypeVariant<MessageChain>

MessageContentTypeVariant

@ExperimentalCommandDescriptors

object MessageContentTypeVariant : TypeVariant<MessageContent>

NoValueArgumentMappingException

@ExperimentalCommandDescriptors

open class NoValueArgumentMappingException(val argument: CommandValueArgument, val forType: KType) : CommandResolutionException

PermissionIdValueArgumentParser

object PermissionIdValueArgumentParser : InternalCommandValueArgumentParserExtensions<PermissionId>

PermitteeIdValueArgumentParser

object PermitteeIdValueArgumentParser : InternalCommandValueArgumentParserExtensions<PermitteeId>

PlainTextValueArgumentParser

object PlainTextValueArgumentParser : InternalCommandValueArgumentParserExtensions<PlainText>

RawContentValueArgumentParser

object RawContentValueArgumentParser : CommandValueArgumentParser<MessageContent>

直接返回原始参数 MessageContent

ShortValueArgumentParser

object ShortValueArgumentParser : InternalCommandValueArgumentParserExtensions<Short>

使用 String.toShort 解析

SimpleCommandArgumentContext

class SimpleCommandArgumentContext(val list: List<CommandArgumentContext.ParserPair<*>>) : CommandArgumentContext

自定义 buildCommandArgumentContext

StringValueArgumentParser

object StringValueArgumentParser : InternalCommandValueArgumentParserExtensions<String>

直接返回 String, 或取用 SingleMessage.contentToString

TemporalArgumentParser

@MiraiExperimentalApi

class TemporalArgumentParser<T : TemporalAccessor>( type: Class<T>, now: () -> T, parse: (CharSequence) -> T) : InternalCommandValueArgumentParserExtensions<T>

解析参数为时间 T

@ExperimentalCommandDescriptors

interface TypeVariant<out OutType>

Intrinsic variant of an CommandValueArgument.

Functions

buildCommandArgumentContext

fun buildCommandArgumentContext(block: CommandArgumentContextBuilder.() -> Unit): CommandArgumentContext

构建一个 buildCommandArgumentContext.

operator fun CommandArgumentContext.plus(replacer: List<CommandArgumentContext.ParserPair<*>>): CommandArgumentContext

合并 this 与 replacer, replacer 将会替换 this 中重复的 parser.

operator fun CommandArgumentContext.plus(replacer: CommandArgumentContext): CommandArgumentContext

合并两个 buildCommandArgumentContext, replacer 将会替换 this 中重复的 parser.