Class CommandSuggestionEvent

java.lang.Object

org.bukkit.event.Event

org.skriptlang.skript.bukkit.command.custom.ScriptCommandEvent

org.skriptlang.skript.bukkit.command.elements.structures.util.CommandSuggestionEvent

@Internal
public class CommandSuggestionEvent
extends ScriptCommandEvent

Internal event for managing context during "suggestions" entry evaluation in SubCommandEntryData.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	CommandSuggestionEvent.CommandSuggestion

Nested classes/interfaces inherited from class org.bukkit.event.Event

org.bukkit.event.Event.Result

Field Summary

Fields

Modifier and Type	Field	Description
ScriptSuggestionProvider.FilteringMode	filteringMode
final Map<String, List<CommandSuggestionEvent.CommandSuggestion>>	suggestions	Map keyed by argument name.

Constructor Summary

Constructors

Constructor	Description
CommandSuggestionEvent(com.mojang.brigadier.context.CommandContext<io.papermc.paper.command.brigadier.CommandSourceStack> context, List<ArgumentData<?>> previousArguments, ArgumentData<?> currentArgument, String fullInput, String input, int inputStartIndex)

Method Summary

Modifier and Type	Method	Description
ArgumentData<?>	getCurrentArgument()
String	getFullInput()
String	getInput()
int	getInputStartIndex()
Object	getPreviousArgument(ArgumentData<?> argument)	Obtains the value of an argument.

Methods inherited from class ScriptCommandEvent

getContext, getExecutor, getHandlers, getLocation, getSender

Methods inherited from class org.bukkit.event.Event

callEvent, getEventName, isAsynchronous

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

suggestions

public final Map<String, List<CommandSuggestionEvent.CommandSuggestion>> suggestions

Map keyed by argument name.

filteringMode

public ScriptSuggestionProvider.FilteringMode filteringMode

Constructor Details

CommandSuggestionEvent

public CommandSuggestionEvent(com.mojang.brigadier.context.CommandContext<io.papermc.paper.command.brigadier.CommandSourceStack> context,
 List<ArgumentData<?>> previousArguments,
 ArgumentData<?> currentArgument,
 String fullInput,
 String input,
 int inputStartIndex)

Method Details

getPreviousArgument

public Object getPreviousArgument(ArgumentData<?> argument)

Obtains the value of an argument.

Parameters:

argument - The argument to obtain the value of.

Returns:

The value associated with argument.

getCurrentArgument

public ArgumentData<?> getCurrentArgument()

Returns:

The argument currently being suggested for.

getFullInput

public String getFullInput()

Returns:

The full input entered so far.

getInput

public String getInput()

Returns:

The input representing the current argument (the one being suggested for).

getInputStartIndex

public int getInputStartIndex()

Returns:

Index representing the start of getInput() in getFullInput().