CommandAPI 9.6.0
An API for the command UI introduced in Minecraft 1.13
com.mojang.brigadier.exceptions.DynamicNCommandExceptionType Class Reference

A CommandExceptionType taking an arbitrary number of inputs and returning a message based on those. More...

+ Inheritance diagram for com.mojang.brigadier.exceptions.DynamicNCommandExceptionType:

Classes

interface  Function
 A simple Function to compute a Message based on the input arguments. More...
 

Public Member Functions

 DynamicNCommandExceptionType (final Function function)
 
CommandSyntaxException create (final Object a, final Object... args)
 Creates a CommandSyntaxException using the passed arguments. More...
 
CommandSyntaxException createWithContext (final ImmutableStringReader reader, final Object... args)
 Creates a CommandSyntaxException using the passed arguments and includes information about the position and input. More...
 

Detailed Description

A CommandExceptionType taking an arbitrary number of inputs and returning a message based on those.

The arguments can be used to e.g. format a message and display the input as well as why it did not match some criteria.

Member Function Documentation

◆ create()

CommandSyntaxException com.mojang.brigadier.exceptions.DynamicNCommandExceptionType.create ( final Object  a,
final Object...  args 
)

Creates a CommandSyntaxException using the passed arguments.

Parameters
athe first argument
argsthe other arguments
Returns
a constructed CommandSyntaxException

◆ createWithContext()

CommandSyntaxException com.mojang.brigadier.exceptions.DynamicNCommandExceptionType.createWithContext ( final ImmutableStringReader  reader,
final Object...  args 
)

Creates a CommandSyntaxException using the passed arguments and includes information about the position and input.

Parameters
readerthe ImmutableStringReader giving information about the input and the place the error occurred
argsthe arguments
Returns
a constructed CommandSyntaxException