io.github.wysohn.triggerreactor.core.manager.trigger.command

Interface ITabCompleter

public interface ITabCompleter

The tab completer interface, which is responsible for handling tab completion process. Each tab completer must handle tab completion request per argument index. For example, 0th argument has its own ITabCompleter, 1st argument has another ITabCompleter, and so on.

Field Summary

Fields

Modifier and Type	Field and Description
static ITabCompleter	EMPTY
static ITabCompleter	PLAYER

Method Summary

Modifier and Type	Method and Description
List<String>	getCandidates(String part) Get possible candidates commands, which can fit into the current argument the player is about to enter.
List<String>	getHint() Get simple help string that will show up to the player.
static ITabCompleter	hint(String hint)
static List<String>	list(String... strings)
static ITabCompleter	simple(String... arg)

Field Detail

EMPTY

static final ITabCompleter EMPTY

PLAYER

static final ITabCompleter PLAYER

Method Detail

list

static List<String> list(String... strings)

hint

static ITabCompleter hint(String hint)

simple

static ITabCompleter simple(String... arg)

getCandidates

List<String> getCandidates(String part)

Get possible candidates commands, which can fit into the current argument the player is about to enter. This only works when player enters command at least 1 character, and naturally, the method is expected to return only the possible candidates that starts with the given character(s) to minimize the overhead.

For example, if a player enter `/mycmd abc def g' in the command line, the candidate commands at argument index 2 that are starting with `g` will show up to the user as tab completion selections.

Parameters:

part - the partially completed command.

Returns:

list of candidates which can fit

getHint

List<String> getHint()

Get simple help string that will show up to the player. Unlike getCandidates(String), this method will be called when there is no character exist in the place of current argument.

For example, you may decide to show simple String, [player], so the player can effectively know what to enter at the current argument index. If this method returns the same value as getCandidates(String), it will behave as same as the naive tab completer.

Returns:

list of String to be shown as hint.