Prompt and PromptQueue Arguments

Prompt and PromptQueue arguments are special sets of characters starting with a - and ending with a space that you put on a prompt to change how the prompt or the whole command behaves. Currently, there are two contexts for an argument: PromptQueue Arguments and Prompt Argument.

Prompt Argument

Prompt Arguments are only within the scope of a specific Prompt. Therefore, an argument will only modify how a specific prompt behaves.

Example:

/nick <Who do you want to change the nickname of?> <-ds -a what nick name do you want?>

For the command shown above, we can see that the first Prompt <Who do you want to change the nickname of?> does not have any argument at all. However the second prompt <-ds -a what nickname do you want?> has two Prompt arguments: -ds and -a. These two arguments are considered as a Prompt Argument since it will only modify that current prompt. -ds disables the input sanitation for that current prompt only. Disabling input sanitation allows for the color codes to be kept since by default, CommandPrompter’s input processing removes them. The argument -a changes that prompt to become an Anvil Prompt.

PromptQueue Argument

PromptQueue Arguments are within the scope of the whole PromptQueue (how a command is represented in CommandPrompter). This type of argument can be placed on any of the prompts and is only needed to be placed once. If placed multiple times, CommandPrompter will still process the argument but will essentially be useless since the first appearance of the argument has already modified the whole PromptQueue.

Example:

/ban <-pa Who do you want to ban?> <What is the reason for the ban?>

The first prompt contains the PromptQueue argument -pa. This argument is called Permission Attachmentand it essentially allows the executing player to have permissions specified in the configuration for a certain amount of ticks. To learn more about permission attachments, go to the Permission Attachment page. Permission Attachments are only required to be placed once on any of the prompts and they will be processed after the whole PromptQueue is completed.

Prompt and PromptQueue Arguments

Here is the list of all arguments that you can use so far:

Argument Name	Key	Scope	Description
Anvil Prompt	a	Prompt	Changes the prompt to become an Anvil Prompt
PlayerUI Prompt	p	Prompt	Changes the prompt to become a PlayerUI Prompt
SignUI Prompt	s	Prompt	Changes the prompt to become a SignUI Prompt
Disable Sanitation	ds	Prompt	Disables input sanitation for a specific prompt
Permission Attachment	pa	PromptQueue	Attach permissions set on the config.yml to the executing player. Permission Attachment
Post Command	exa	PromptQueue	Add a command to execute after completion. PostCommand