Package org.quiltmc.qkl.wrapper.minecraft.brigadier.argument

Types

Link copied to clipboard

ArgumentDescriptor for an EntityArgumentType allowing multiple entities to be selected.

Link copied to clipboard

ArgumentDescriptor for an EntityArgumentType allowing multiple players to be selected.

Link copied to clipboard

ArgumentDescriptor for an ScoreHolderArgumentType allowing multiple score holders to be selected.

Link copied to clipboard
object LiteralDescriptor : ArgumentDescriptor<ArgumentType<*>>

Descriptor for a literal argument.

Link copied to clipboard
class MappedStringEnumArgumentDescriptor<T>(val map: Map<String, T>) : ArgumentDescriptor<EnumArgumentType>

ArgumentDescriptor for EnumArgumentType allowing a set of specified strings, and containing values of T matching every allowed string.

Link copied to clipboard

ArgumentDescriptor for an EntityArgumentType allowing a single entity to be selected.

Link copied to clipboard

ArgumentDescriptor for an EntityArgumentType allowing a single player to be selected.

Link copied to clipboard

ArgumentDescriptor for an ScoreHolderArgumentType allowing a single score holder to be selected.

Link copied to clipboard
object StringEnumArgumentDescriptor : ArgumentDescriptor<EnumArgumentType>

ArgumentDescriptor for EnumArgumentType allowing a set of specified strings.

Link copied to clipboard
class TypedEnumArgumentDescriptor<T : Enum<T>>(val type: Class<T>) : ArgumentDescriptor<EnumArgumentType>

ArgumentDescriptor for EnumArgumentType allowing all enum constants of T.

Functions

Link copied to clipboard
@JvmName(name = "absoluteRotationArg")
fun ArgumentReader<ServerCommandSource, DefaultArgumentDescriptor<RotationArgumentType>>.absolute(): Vec2f

Reads the Vec2f value from the argument in the receiver ArgumentReader, converting the contained PosArgument to an absolute rotation.

Link copied to clipboard
fun <S> angle(name: String): DefaultArgumentConstructor<S, AngleArgumentType>

Creates an angle argument with name as the parameter name.

Link copied to clipboard

Reads the Identifier value from the argument in the receiver ArgumentReader as an Advancement.

Link copied to clipboard

Reads the Identifier value from the argument in the receiver ArgumentReader as a LootFunction.

Link copied to clipboard

Reads the Identifier value from the argument in the receiver ArgumentReader as a LootCondition.

Link copied to clipboard

Reads the Identifier value from the argument in the receiver ArgumentReader as a Recipe.

Link copied to clipboard
fun <S> blockPos(name: String): DefaultArgumentConstructor<S, BlockPosArgumentType>

Creates a block pos argument with name as the parameter name.

Link copied to clipboard

Creates a block predicate argument with name as the parameter name.

Link copied to clipboard
fun <S> blockState(name: String, context: CommandBuildContext): DefaultArgumentConstructor<S, BlockStateArgumentType>

Creates a block state argument with name as the parameter name.

Link copied to clipboard
fun <S> boolean(name: String): DefaultArgumentConstructor<S, BoolArgumentType>

Creates a boolean argument with name as the parameter name.

Link copied to clipboard
fun <S> color(name: String): DefaultArgumentConstructor<S, ColorArgumentType>

Creates a color argument with name as the parameter name.

Link copied to clipboard
fun <S> columnPos(name: String): DefaultArgumentConstructor<S, ColumnPosArgumentType>

Creates a column pos argument with name as the parameter name.

Link copied to clipboard

Creates a command function argument with name as the parameter name.

Link copied to clipboard
@JvmName(name = "defaultToAllKnownListScoreHolderArg")
fun ArgumentReader<ServerCommandSource, ListScoreHolderArgumentDescriptor>.defaultToAllKnown(): Collection<String>

Reads all score holder names from the argument in the receiver ArgumentReader.

Link copied to clipboard
fun <S> dimension(name: String): DefaultArgumentConstructor<S, DimensionArgumentType>

Creates a dimension argument with name as the parameter name.

Link copied to clipboard
fun <S> double(    name: String,     min: Double = -Double.MAX_VALUE,     max: Double = Double.MAX_VALUE): DefaultArgumentConstructor<S, DoubleArgumentType>

Creates a double argument with name as the parameter name.

Link copied to clipboard
fun <S> enchantment(name: String): DefaultArgumentConstructor<S, EnchantmentArgumentType>

Creates an enchantment argument with name as the parameter name.

Link copied to clipboard
fun <S> entities(name: String): RequiredArgumentConstructor<S, ListEntityArgumentDescriptor>

Creates entity argument allowing multiple entities with name as the parameter name.

Link copied to clipboard
fun <S> entity(name: String): RequiredArgumentConstructor<S, SingleEntityArgumentDescriptor>

Creates an entity selector argument with name as the parameter name.

Link copied to clipboard
fun <S> entityAnchor(name: String): DefaultArgumentConstructor<S, EntityAnchorArgumentType>

Creates an entity anchor argument with name as the parameter name.

Link copied to clipboard
fun <S> entitySummon(name: String): DefaultArgumentConstructor<S, EntitySummonArgumentType>

Creates an entity summon argument with name as the parameter name.

Link copied to clipboard
@JvmName(name = "enumAllowedSublist")
fun <S, T : Enum<T>> enum(name: String, values: List<T>): RequiredArgumentConstructor<S, MappedStringEnumArgumentDescriptor<T>>

Creates an enum argument allowing only values specified in values with name as the parameter name.

fun <S> enum(name: String, values: List<String>): RequiredArgumentConstructor<S, StringEnumArgumentDescriptor>

Creates a string argument allowing only values specified in values with name as the parameter name.

fun <S, T> enum(name: String, values: Map<String, T>): RequiredArgumentConstructor<S, MappedStringEnumArgumentDescriptor<T>>

Creates an enum argument allowing values specified by keys of values with name as the parameter name.

fun <S, T : Enum<T>> enum(name: String, type: KClass<T>): RequiredArgumentConstructor<S, TypedEnumArgumentDescriptor<T>>

Creates an enum argument allowing all values of the specified enum type with name as the parameter name.

Link copied to clipboard
fun <S> float(    name: String,     min: Float = -Float.MAX_VALUE,     max: Float = Float.MAX_VALUE): DefaultArgumentConstructor<S, FloatArgumentType>

Creates a float argument with name as the parameter name.

Link copied to clipboard

Creates a float range argument with name as the parameter name.

Link copied to clipboard
Link copied to clipboard

Reads the collection of CommandFunctions from the argument in the receiver ArgumentReader.

Link copied to clipboard
fun <S> gameProfile(name: String): DefaultArgumentConstructor<S, GameProfileArgumentType>

Creates a game profile argument with name as the parameter name.

Link copied to clipboard
fun <S> greedyString(name: String): DefaultArgumentConstructor<S, StringArgumentType>

Creates a greedy string argument with name as the parameter name.

Link copied to clipboard
fun <S> identifier(name: String): DefaultArgumentConstructor<S, IdentifierArgumentType>

Creates an identifier argument with name as the parameter name.

Link copied to clipboard
fun <S> integer(    name: String,     min: Int = -Int.MAX_VALUE,     max: Int = Int.MAX_VALUE): DefaultArgumentConstructor<S, IntegerArgumentType>

Creates an integer argument with name as the parameter name.

Link copied to clipboard

Creates an int range argument with name as the parameter name.

Link copied to clipboard

Creates an item predicate argument with name as the parameter name.

Link copied to clipboard
fun <S> itemSlot(name: String): DefaultArgumentConstructor<S, ItemSlotArgumentType>

Creates an item slot argument with name as the parameter name.

Link copied to clipboard
fun <S> itemStack(name: String, context: CommandBuildContext): DefaultArgumentConstructor<S, ItemStackArgumentType>

Creates an item slot argument with name as the parameter name.

Link copied to clipboard
fun <S> literal(name: String): ArgumentConstructor<S, LiteralArgumentBuilder<S>, LiteralDescriptor>

Creates a literal argument with name as the literal.

Link copied to clipboard
fun <S> long(    name: String,     min: Long = -Long.MAX_VALUE,     max: Long = Long.MAX_VALUE): DefaultArgumentConstructor<S, LongArgumentType>

Creates a long argument with name as the parameter name.

Link copied to clipboard
fun <S> message(name: String): DefaultArgumentConstructor<S, MessageArgumentType>

Creates a message argument with name as the parameter name.

Link copied to clipboard
fun <S> nbtCompound(name: String): DefaultArgumentConstructor<S, NbtCompoundArgumentType>

Creates a nbt compound argument with name as the parameter name.

Link copied to clipboard
fun <S> nbtElement(name: String): DefaultArgumentConstructor<S, NbtElementArgumentType>

Creates an NBT element argument with name as the parameter name.

Link copied to clipboard
fun <S> nbtPath(name: String): DefaultArgumentConstructor<S, NbtPathArgumentType>

Creates an NBT path argument with name as the parameter name.

Link copied to clipboard
fun <S> operation(name: String): DefaultArgumentConstructor<S, OperationArgumentType>

Creates an operation compound argument with name as the parameter name.

Link copied to clipboard
@JvmName(name = "optionalEntityArg")
fun ArgumentReader<ServerCommandSource, ListEntityArgumentDescriptor>.optional(): Collection<Entity>

Reads the collection of entities from the argument in the receiver ArgumentReader.

@JvmName(name = "optionalPlayerArg")
fun ArgumentReader<ServerCommandSource, ListPlayerArgumentDescriptor>.optional(): Collection<ServerPlayerEntity>

Reads the collection of players from the argument in the receiver ArgumentReader.

Link copied to clipboard

Creates a particle effect argument with name as the parameter name.

Link copied to clipboard
fun <S> player(name: String): RequiredArgumentConstructor<S, SinglePlayerArgumentDescriptor>

Creates a player selector argument with name as the parameter name.

Link copied to clipboard
fun <S> players(name: String): RequiredArgumentConstructor<S, ListPlayerArgumentDescriptor>

Creates a multiple player selector argument with name as the parameter name.

Link copied to clipboard
@JvmName(name = "posVec3Arg")
fun DefaultArgumentReader<Vec3ArgumentType>.posArgument(): PosArgument

Reads the raw PosArgument value from the argument in the receiver ArgumentReader.

Link copied to clipboard
@JvmName(name = "requiredEntityArg")
fun ArgumentReader<ServerCommandSource, ListEntityArgumentDescriptor>.required(): Collection<Entity>

Reads the collection of entities from the argument in the receiver ArgumentReader.

@JvmName(name = "requiredPlayerArg")
fun ArgumentReader<ServerCommandSource, ListPlayerArgumentDescriptor>.required(): Collection<ServerPlayerEntity>

Reads the collection of players from the argument in the receiver ArgumentReader.

Link copied to clipboard

Reads the BlockPos value from the argument in the receiver ArgumentReader.

Link copied to clipboard
fun <S> rotation(name: String): DefaultArgumentConstructor<S, RotationArgumentType>

Creates a rotation argument with name as the parameter name.

Link copied to clipboard

Creates a scoreboard criterion argument with name as the parameter name.

Link copied to clipboard

Creates a scoreboard objective argument with name as the parameter name.

Link copied to clipboard

Creates a scoreboard slot argument with name as the parameter name.

Link copied to clipboard

Creates a score holder argument with name as the parameter name.

Link copied to clipboard

Creates a multiple score holders argument with name as the parameter name.

Link copied to clipboard

Reads the SignedMessage value from the argument in the receiver ArgumentReader.

Link copied to clipboard
fun <S> statusEffect(name: String): DefaultArgumentConstructor<S, StatusEffectArgumentType>

Creates a status effect argument with name as the parameter name.

Link copied to clipboard
fun <S> string(name: String): DefaultArgumentConstructor<S, StringArgumentType>

Creates a string argument with name as the parameter name.

Link copied to clipboard
fun <S> swizzle(name: String): DefaultArgumentConstructor<S, SwizzleArgumentType>

Creates a swizzle argument with name as the parameter name.

Link copied to clipboard
fun <S> team(name: String): DefaultArgumentConstructor<S, TeamArgumentType>

Creates a team argument with name as the parameter name.

Link copied to clipboard
fun <S> testClass(name: String): DefaultArgumentConstructor<S, TestClassArgumentType>

Creates a test class argument with name as the parameter name.

Link copied to clipboard
fun <S> testFunction(name: String): DefaultArgumentConstructor<S, TestFunctionArgumentType>

Creates a test function argument with name as the parameter name.

Link copied to clipboard
fun <S> text(name: String): DefaultArgumentConstructor<S, TextArgumentType>

Creates a text argument with name as the parameter name.

Link copied to clipboard
fun <S> time(name: String): DefaultArgumentConstructor<S, TimeArgumentType>

Creates a time argument with name as the parameter name.

Link copied to clipboard

Creates a UUID argument with name as the parameter name.

Link copied to clipboard
@JvmName(name = "valueBoolArg")
fun DefaultArgumentReader<BoolArgumentType>.value(): Boolean
@JvmName(name = "valueDoubleArg")
fun DefaultArgumentReader<DoubleArgumentType>.value(): Double

Reads the boolean value from the argument in the receiver ArgumentReader.

@JvmName(name = "valueFloatArg")
fun DefaultArgumentReader<FloatArgumentType>.value(): Float
@JvmName(name = "valueAngleArg")
fun ArgumentReader<ServerCommandSource, DefaultArgumentDescriptor<AngleArgumentType>>.value(): Float

Reads the float value from the argument in the receiver ArgumentReader.

@JvmName(name = "valueIntArg")
fun DefaultArgumentReader<IntegerArgumentType>.value(): Int
@JvmName(name = "valueItemSlotArg")
fun DefaultArgumentReader<ItemSlotArgumentType>.value(): Int

Reads the integer value from the argument in the receiver ArgumentReader.

@JvmName(name = "valueLongArg")
fun DefaultArgumentReader<LongArgumentType>.value(): Long

Reads the long value from the argument in the receiver ArgumentReader.

@JvmName(name = "valueStringArg")
fun DefaultArgumentReader<StringArgumentType>.value(): String
@JvmName(name = "valueEnumStringArg")
fun ArgumentReader<*, StringEnumArgumentDescriptor>.value(): String

Reads the string value from the argument in the receiver ArgumentReader.

@JvmName(name = "valueBlockPredicateArg")
fun DefaultArgumentReader<BlockPredicateArgumentType>.value(): Predicate<CachedBlockPosition>

Reads the block predicate value of the argument in the receiver ArgumentReader.

@JvmName(name = "valueBlockStateArg")
fun DefaultArgumentReader<BlockStateArgumentType>.value(): BlockStateArgument

Reads the BlockStateArgument value of the argument in the receiver ArgumentReader.

@JvmName(name = "valueColorArg")
fun DefaultArgumentReader<ColorArgumentType>.value(): Formatting

Reads the selected color's Formatting value from the argument in the receiver ArgumentReader.

@JvmName(name = "valueEnchantmentArg")
fun DefaultArgumentReader<EnchantmentArgumentType>.value(): Enchantment

Reads the Enchantment value from the argument in the receiver ArgumentReader.

@JvmName(name = "valueEntityAnchorArg")
fun DefaultArgumentReader<EntityAnchorArgumentType>.value(): EntityAnchorArgumentType.EntityAnchor

Reads the entity anchor value of the argument in the receiver ArgumentReader.

@JvmName(name = "valueEntitySummonArg")
fun ArgumentReader<*, DefaultArgumentDescriptor<EntitySummonArgumentType>>.value(): Identifier

Reads the entity summon Identifier value of the argument in the receiver ArgumentReader.

@JvmName(name = "valueIdentifierArg")
fun DefaultArgumentReader<IdentifierArgumentType>.value(): Identifier

Reads the Identifier value from the argument in the receiver ArgumentReader.

@JvmName(name = "valueItemPredicateArg")
fun DefaultArgumentReader<ItemPredicateArgumentType>.value(): Predicate<ItemStack>

Reads the ItemStack predicate value from the argument in the receiver ArgumentReader.

@JvmName(name = "valueItemStackArg")
fun DefaultArgumentReader<ItemStackArgumentType>.value(): ItemStackArgument

Reads the ItemStackArgument value from the argument in the receiver ArgumentReader.

@JvmName(name = "valueNbtCompoundArg")
fun DefaultArgumentReader<NbtCompoundArgumentType>.value(): NbtCompound

Reads the NbtCompound value from the argument in the receiver ArgumentReader.

@JvmName(name = "valueNbtElementArg")
fun DefaultArgumentReader<NbtElementArgumentType>.value(): NbtElement

Reads the NbtElement value from the argument in the receiver ArgumentReader.

@JvmName(name = "valueNbtPathArg")
fun DefaultArgumentReader<NbtPathArgumentType>.value(): NbtPathArgumentType.NbtPath

Reads the NbtPath value from the argument in the receiver ArgumentReader.

@JvmName(name = "valueFloatRangeArg")
fun DefaultArgumentReader<NumberRangeArgumentType.FloatRangeArgumentType>.value(): NumberRange.FloatRange

Reads the NumberRange.FloatRange value from the argument in the receiver ArgumentReader.

@JvmName(name = "valueIntRangeArg")
fun DefaultArgumentReader<NumberRangeArgumentType.IntRangeArgumentType>.value(): NumberRange.IntRange

Reads the NumberRange.IntRange value from the argument in the receiver ArgumentReader.

@JvmName(name = "valueOperationArg")
fun DefaultArgumentReader<OperationArgumentType>.value(): OperationArgumentType.Operation

Reads the OperationArgumentType.Operation value from the argument in the receiver ArgumentReader.

@JvmName(name = "valueParticleEffectArg")
fun DefaultArgumentReader<ParticleEffectArgumentType>.value(): ParticleEffect

Reads the ParticleEffect value from the argument in the receiver ArgumentReader.

@JvmName(name = "valueRotationArg")
fun DefaultArgumentReader<RotationArgumentType>.value(): PosArgument

Reads the raw PosArgument value from the argument in the receiver ArgumentReader.

@JvmName(name = "valueScoreboardCriterionArg")
fun DefaultArgumentReader<ScoreboardCriterionArgumentType>.value(): ScoreboardCriterion

Reads the ScoreboardCriterion value from the argument in the receiver ArgumentReader.

@JvmName(name = "valueScoreboardSlotArg")
fun DefaultArgumentReader<ScoreboardSlotArgumentType>.value(): Int

Reads the integer slot value from the argument in the receiver ArgumentReader.

@JvmName(name = "valueStatusEffectArg")
fun DefaultArgumentReader<StatusEffectArgumentType>.value(): StatusEffect

Reads the StatusEffect value from the argument in the receiver ArgumentReader.

@JvmName(name = "valueSwizzleArg")
fun DefaultArgumentReader<SwizzleArgumentType>.value(): EnumSet<Direction.Axis>

Reads the set of Direction.Axis from the argument in the receiver ArgumentReader.

@JvmName(name = "valueTestClassArg")
fun DefaultArgumentReader<TestClassArgumentType>.value(): String

Reads the test class name from the argument in the receiver ArgumentReader.

@JvmName(name = "valueTestFunctionArg")
fun DefaultArgumentReader<TestFunctionArgumentType>.value(): TestFunction

Reads the TestFunction value from the argument in the receiver ArgumentReader.

@JvmName(name = "valueTextArg")
fun DefaultArgumentReader<TextArgumentType>.value(): Text

Reads the Text value from the argument in the receiver ArgumentReader.

@JvmName(name = "valueTimeArg")
fun DefaultArgumentReader<TimeArgumentType>.value(): Int

Reads the integer value in ticks from the argument in the receiver ArgumentReader.

@JvmName(name = "valueUuidArg")
fun DefaultArgumentReader<UuidArgumentType>.value(): UUID

Reads the UUID value from the argument in the receiver ArgumentReader.

@JvmName(name = "valueEnumMappedArg")
fun <T> ArgumentReader<*, MappedStringEnumArgumentDescriptor<T>>.value(): T

Reads the string value from the argument in the receiver ArgumentReader and converts it to a value of type T according to the map provided when creating the argument.

@JvmName(name = "valueEnumClassArg")
fun <T : Enum<T>> ArgumentReader<*, TypedEnumArgumentDescriptor<T>>.value(): T

Reads the enum value of type T from the argument in the receiver ArgumentReader.

@JvmName(name = "valueBlockPosArg")
fun ArgumentReader<ServerCommandSource, DefaultArgumentDescriptor<BlockPosArgumentType>>.value(): BlockPos

Reads the BlockPos value from the argument in the receiver ArgumentReader.

@JvmName(name = "valueColumnPosArg")
fun ArgumentReader<ServerCommandSource, DefaultArgumentDescriptor<ColumnPosArgumentType>>.value(): ColumnPos

Reads the ColumnPos value from the argument in the receiver ArgumentReader.

@JvmName(name = "valueDimensionArg")
fun ArgumentReader<ServerCommandSource, DefaultArgumentDescriptor<DimensionArgumentType>>.value(): ServerWorld

Reads the ServerWorld value for the selected dimension from the argument in the receiver ArgumentReader.

@JvmName(name = "valueGameProfileArg")
fun ArgumentReader<ServerCommandSource, DefaultArgumentDescriptor<GameProfileArgumentType>>.value(): Collection<GameProfile>

Reads the GameProfile value from the argument in the receiver ArgumentReader.

@JvmName(name = "valueMessageArg")
fun ArgumentReader<ServerCommandSource, DefaultArgumentDescriptor<MessageArgumentType>>.value(): Text

Reads the message's Text value from the argument in the receiver ArgumentReader.

@JvmName(name = "valueScoreboardObjectiveArg")
fun ArgumentReader<ServerCommandSource, DefaultArgumentDescriptor<ScoreboardObjectiveArgumentType>>.value(): ScoreboardObjective

Reads the ScoreboardObjective value from the argument in the receiver ArgumentReader.

@JvmName(name = "valueTeamArg")
fun ArgumentReader<ServerCommandSource, DefaultArgumentDescriptor<TeamArgumentType>>.value(): Team

Reads the Team value from the argument in the receiver ArgumentReader.

@JvmName(name = "valueVec2Arg")
fun ArgumentReader<ServerCommandSource, DefaultArgumentDescriptor<Vec2ArgumentType>>.value(): Vec2f

Reads the Vec2f value from the argument in the receiver ArgumentReader.

@JvmName(name = "valueVec3Arg")
fun ArgumentReader<ServerCommandSource, DefaultArgumentDescriptor<Vec3ArgumentType>>.value(): Vec3d

Reads the Vec3d value from the argument in the receiver ArgumentReader.

@JvmName(name = "valueListScoreHolderArg")
fun ArgumentReader<ServerCommandSource, ListScoreHolderArgumentDescriptor>.value(): Collection<String>

Reads all score holder names from the argument in the receiver ArgumentReader.

@JvmName(name = "valueSingleEntityArg")
fun ArgumentReader<ServerCommandSource, SingleEntityArgumentDescriptor>.value(): Entity

Reads the Entity value from the argument in the receiver ArgumentReader.

@JvmName(name = "valuePlayerArg")
fun ArgumentReader<ServerCommandSource, SinglePlayerArgumentDescriptor>.value(): ServerPlayerEntity

Reads the ServerPlayerEntity value from the argument in the receiver ArgumentReader.

@JvmName(name = "valueSingleScoreHolderArg")
fun ArgumentReader<ServerCommandSource, SingleScoreHolderArgumentDescriptor>.value(): String

Reads the score holder name from the argument in the receiver ArgumentReader.

Link copied to clipboard
fun <S> vec2(name: String, centerIntegers: Boolean = false): DefaultArgumentConstructor<S, Vec2ArgumentType>

Creates a vec2 argument with name as the parameter name.

Link copied to clipboard
fun <S> vec3(name: String, centerIntegers: Boolean = false): DefaultArgumentConstructor<S, Vec3ArgumentType>

Creates a vec3 argument with name as the parameter name.

Link copied to clipboard
fun <S> word(name: String): DefaultArgumentConstructor<S, StringArgumentType>

Creates a word argument with name as the parameter name.

Link copied to clipboard
@JvmName(name = "writableScoreboardObjectiveArg")
fun ArgumentReader<ServerCommandSource, DefaultArgumentDescriptor<ScoreboardObjectiveArgumentType>>.writable(): ScoreboardObjective

Reads the ScoreboardObjective value from the argument in the receiver ArgumentReader.