DiscordKt/me.jakejmattson.discordkt.arguments

Package me.jakejmattson.discordkt.arguments

Argument types for parsing command input.

Types

open class AnyArg(val name: String = "Any", val description: String = internalLocale.anyArgDescription) : StringArgument<String>

Accepts any (single) argument. Does not accept empty strings.

Argument

interface Argument<Input, Output> : Cloneable

An object that represents a type and contains the logic to convert string arguments to the desired type.

AttachmentArg

open class AttachmentArg(val name: String = "Attachment", val description: String = internalLocale.attachmentArgDescription) : AttachmentArgument<Attachment>

Accepts a message attachment.

AttachmentArgument

interface AttachmentArgument<Output> : EntityArgument<Attachment, Output>

An Argument that accepts an Attachment.

AutocompleteArg

open class AutocompleteArg<Input, Output>( val name: String, val description: String, val type: PrimitiveArgument<Input, Output>, autocomplete: suspend AutocompleteData.() -> List<Input>) : WrappedArgument<Input, Output, Input, Output>

Provides autocomplete options to slash input.

AutocompleteData

data class AutocompleteData(val interaction: AutoCompleteInteraction, val input: String)

The data provided to process autocomplete interactions.

BooleanArg

open class BooleanArg( val name: String = "Boolean", val truthValue: String = "true", val falseValue: String = "false", val description: String = internalLocale.booleanArgDescription.inject(truthValue, falseValue)) : BooleanArgument<Boolean>

Accepts either of two values. Defaults to true/false.

BooleanArgument

interface BooleanArgument<Output> : PrimitiveArgument<Boolean, Output>

An Argument that accepts a Boolean.

ChannelArg

open class ChannelArg<T : GuildChannel>( val name: String = "Channel", val description: String = internalLocale.channelArgDescription, allowsGlobal: Boolean = false) : ChannelArgument<T>

Accepts a Discord TextChannel entity as an ID or mention.

ChannelArgument

interface ChannelArgument<Output> : EntityArgument<Channel, Output>

An Argument that accepts a Channel.

CharArg

open class CharArg(val name: String = "Character", val description: String = internalLocale.charArgDescription) : StringArgument<Char>

Accepts a single character.

ChoiceArg

open class ChoiceArg<T>( val name: String, val description: String = internalLocale.choiceArgDescription, choices: T) : StringArgument<T>

Accepts a choice from the provided list.

CommandArg

open class CommandArg(val name: String = "Command", val description: String = internalLocale.commandArgDescription) : StringArgument<Command>

Accepts a DiscordKt command by name.

DoubleArg

open class DoubleArg(val name: String = "Double", val description: String = internalLocale.doubleArgDescription) : DoubleArgument<Double>

Accept a decimal number in the double range.

DoubleArgument

interface DoubleArgument<Output> : PrimitiveArgument<Double, Output>

An Argument that accepts a Double.

EntityArgument

interface EntityArgument<Input, Output> : Argument<Input, Output>

An Argument that accepts a discord entity.

Error

data class Error<T>(val error: String) : Result<T>

Result indicating that a conversion was failed.

EveryArg

open class EveryArg(val name: String = "Text", val description: String = internalLocale.everyArgDescription) : StringArgument<String>

Consumes all remaining arguments. Does not accept empty strings.

GuildArg

open class GuildArg(val name: String = "Guild", val description: String = internalLocale.guildArgDescription) : StringArgument<Guild>

Accepts a Discord Guild entity as an ID.

GuildEmojiArg

open class GuildEmojiArg( val name: String = "Guild Emoji", val description: String = internalLocale.guildEmojiArgDescription, allowsGlobal: Boolean = false) : StringArgument<GuildEmoji>

Accepts a guild emoji.

HexColorArg

open class HexColorArg(val name: String = "Color", val description: String = internalLocale.hexColorArgDescription) : StringArgument<Color>

Accepts a color in hexadecimal format. The '#' symbol is optional.

IntegerArg

open class IntegerArg(val name: String = "Integer", val description: String = internalLocale.integerArgDescription) : IntegerArgument<Int>

Accept a whole number in the int range.

IntegerArgument

interface IntegerArgument<Output> : PrimitiveArgument<Int, Output>

An Argument that accepts an Int.

IntegerRangeArg

open class IntegerRangeArg( min: Int, max: Int, val name: String = "Integer (", val description: String = internalLocale.integerRangeArgDescription.inject(min.toString(), max.toString())) : IntegerArgument<Int>

Accepts an integer within a pre-defined range.

MemberArg

open class MemberArg( val name: String = "Member", val description: String = internalLocale.memberArgDescription, allowsBot: Boolean = false) : UserArgument<Member>

Accepts a Discord Member entity as an ID or mention.

MessageArg

open class MessageArg( val name: String = "Message", val description: String = internalLocale.messageArgDescription, allowsGlobal: Boolean = false) : StringArgument<Message>

Accepts a Discord Message entity as an ID or a link.

MultipleArg

class MultipleArg<Input, Output>( val type: Argument<Input, Output>, val name: String = type.name, description: String = "") : WrappedArgument<Input, Output, List<Input>, List<Output>>

Accepts multiple arguments of the given type. Returns a list.

OptionalArg

class OptionalArg<I, O, O2>( val name: String, val type: Argument<I, O>, default: suspend DiscordContext.() -> O2) : WrappedArgument<I, O, I, O2>

An optional argument with a default value.

PrimitiveArgument

interface PrimitiveArgument<Input, Output> : Argument<Input, Output>

An Argument that accepts a primitive type.

QuoteArg

open class QuoteArg(val name: String = "Quote", val description: String = internalLocale.quoteArgDescription) : StringArgument<String>

Accepts a group of arguments surrounded by quotation marks.

Result

sealed class Result<T>

The result of some conversion.

RoleArg

open class RoleArg( val name: String = "Role", val description: String = internalLocale.roleArgDescription, guildId: Snowflake? = null, allowsGlobal: Boolean = false) : RoleArgument<Role>

Accepts a Discord Role entity as an ID, a mention, or by name.

RoleArgument

interface RoleArgument<Output> : EntityArgument<Role, Output>

An Argument that accepts a Role.

SplitterArg

open class SplitterArg( splitter: String = "|", val name: String = "TextWithSplitter", val description: String = internalLocale.splitterArgDescription.inject(splitter)) : StringArgument<List<String>>

Consumes all arguments and returns a list of the results (split by splitter character).

StringArgument

interface StringArgument<Output> : PrimitiveArgument<String, Output>

An Argument that accepts a String.

Success

data class Success<T>(val result: T) : Result<T>

Result indicating that a conversion was successful.

TimeArg

open class TimeArg(val name: String = "Time", val description: String = internalLocale.timeArgDescription) : StringArgument<Double>

Accepts a group of time elements and returns the number of seconds as a double.

UnicodeEmojiArg

open class UnicodeEmojiArg(val name: String = "Emoji", val description: String = internalLocale.unicodeEmojiArgDescription) : StringArgument<DiscordEmoji>

Accepts a unicode emoji.

UrlArg

open class UrlArg(val name: String = "URL", val description: String = internalLocale.urlArgDescription) : StringArgument<String>

Accepts a string that matches the URL regex.

UserArg

open class UserArg(val name: String = "User", val description: String = internalLocale.userArgDescription) : UserArgument<User>

Accepts a Discord User entity as an ID or mention.

UserArgument

interface UserArgument<Output> : EntityArgument<User, Output>

An Argument that accepts a User.

WrappedArgument

interface WrappedArgument<Input, Output, Input2, Output2> : Argument<Input2, Output2>

An Argument that wraps around another argument.

Functions

containsType

inline fun <T> WrappedArgument<*, *, *, *>.containsType(): Boolean

Perform a nested search on this wrapped argument to check for a certain type.