Package baritone.api.command.helpers

Class TabCompleteHelper

java.lang.Object

baritone.api.command.helpers.TabCompleteHelper

public class TabCompleteHelper
extends Object

The TabCompleteHelper is a single-use object that helps you handle tab completion. It includes helper methods for appending and prepending streams, sorting, filtering by prefix, and so on.

The recommended way to use this class is:

• Create a new instance with the empty constructor
• Use append, prepend or add<something> methods to add completions
• Sort using sort(Comparator) or sortAlphabetically() and then filter by prefix using filterPrefix(String)
• Get the stream using stream()
• Pass it up to whatever's calling your tab complete function (i.e. ICommandManager.tabComplete(String) or IArgConsumer#tabCompleteDatatype(IDatatype)})

For advanced users: if you're intercepting TabCompleteEvents directly, use build() instead for an array.

Constructor Summary

Constructors

Constructor	Description
TabCompleteHelper()
TabCompleteHelper(String[] base)
TabCompleteHelper(List<String> base)

Method Summary

Modifier and Type	Method	Description
TabCompleteHelper	addCommands(ICommandManager manager)	Appends every command in the specified ICommandManager to this TabCompleteHelper
TabCompleteHelper	addModifiedSettings()	Appends every modified setting in the Settings to this TabCompleteHelper
TabCompleteHelper	addSettings()	Appends every setting in the Settings to this TabCompleteHelper
TabCompleteHelper	addToggleableSettings()	Appends every Boolean setting in the Settings to this TabCompleteHelper
TabCompleteHelper	append(Class<? extends Enum<?>> num)	Appends all values of the specified enum to this TabCompleteHelper and returns it for chaining
TabCompleteHelper	append(String... source)	Appends the specified strings to this TabCompleteHelper and returns it for chaining
TabCompleteHelper	append(Stream<String> source)	Appends the specified stream to this TabCompleteHelper and returns it for chaining
String[]	build()
TabCompleteHelper	filter(Predicate<String> filter)	Apply the specified filter to every element currently in this TabCompleteHelper and return this object for chaining
TabCompleteHelper	filterPrefix(String prefix)	Filter out any element that doesn't start with prefix and return this object for chaining
TabCompleteHelper	filterPrefixNamespaced(String prefix)	Filter out any element that doesn't start with prefix and return this object for chaining
TabCompleteHelper	map(Function<String,String> transform)	Apply the specified transform to every element currently in this TabCompleteHelper and return this object for chaining
TabCompleteHelper	prepend(Class<? extends Enum<?>> num)	Prepends all values of the specified enum to this TabCompleteHelper and returns it for chaining
TabCompleteHelper	prepend(String... source)	Prepends the specified strings to this TabCompleteHelper and returns it for chaining
TabCompleteHelper	prepend(Stream<String> source)	Prepends the specified stream to this TabCompleteHelper and returns it for chaining
TabCompleteHelper	sort(Comparator<String> comparator)	Apply the specified sort to every element currently in this TabCompleteHelper and return this object for chaining
TabCompleteHelper	sortAlphabetically()	Sort every element currently in this TabCompleteHelper alphabetically and return this object for chaining
Stream<String>	stream()

Methods inherited from class java.lang.Object

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

Constructor Details

TabCompleteHelper

public TabCompleteHelper(String[] base)

TabCompleteHelper

public TabCompleteHelper(List<String> base)

TabCompleteHelper

public TabCompleteHelper()

Method Details

append

public TabCompleteHelper append(Stream<String> source)

Appends the specified stream to this TabCompleteHelper and returns it for chaining

Parameters:

source - The stream to append

Returns:

This TabCompleteHelper after having appended the stream

See Also:

• append(String...)
• append(Class)

append

public TabCompleteHelper append(String... source)

Appends the specified strings to this TabCompleteHelper and returns it for chaining

Parameters:

source - The stream to append

Returns:

This TabCompleteHelper after having appended the strings

See Also:

• append(Stream)
• append(Class)

append

public TabCompleteHelper append(Class<? extends Enum<?>> num)

Appends all values of the specified enum to this TabCompleteHelper and returns it for chaining

Parameters:

num - The enum to append the values of

Returns:

This TabCompleteHelper after having appended the values

See Also:

• append(Stream)
• append(String...)

prepend

public TabCompleteHelper prepend(Stream<String> source)

Prepends the specified stream to this TabCompleteHelper and returns it for chaining

Parameters:

source - The stream to prepend

Returns:

This TabCompleteHelper after having prepended the stream

See Also:

• prepend(String...)
• prepend(Class)

prepend

public TabCompleteHelper prepend(String... source)

Prepends the specified strings to this TabCompleteHelper and returns it for chaining

Parameters:

source - The stream to prepend

Returns:

This TabCompleteHelper after having prepended the strings

See Also:

• prepend(Stream)
• prepend(Class)

prepend

public TabCompleteHelper prepend(Class<? extends Enum<?>> num)

Prepends all values of the specified enum to this TabCompleteHelper and returns it for chaining

Parameters:

num - The enum to prepend the values of

Returns:

This TabCompleteHelper after having prepended the values

See Also:

• prepend(Stream)
• prepend(String...)

map

public TabCompleteHelper map(Function<String,String> transform)

Apply the specified transform to every element currently in this TabCompleteHelper and return this object for chaining

Parameters:

transform - The transform to apply

Returns:

This TabCompleteHelper

filter

public TabCompleteHelper filter(Predicate<String> filter)

Apply the specified filter to every element currently in this TabCompleteHelper and return this object for chaining

Parameters:

filter - The filter to apply

Returns:

This TabCompleteHelper

sort

public TabCompleteHelper sort(Comparator<String> comparator)

Apply the specified sort to every element currently in this TabCompleteHelper and return this object for chaining

Parameters:

comparator - The comparator to use

Returns:

This TabCompleteHelper

sortAlphabetically

public TabCompleteHelper sortAlphabetically()

Sort every element currently in this TabCompleteHelper alphabetically and return this object for chaining

Returns:

This TabCompleteHelper

filterPrefix

public TabCompleteHelper filterPrefix(String prefix)

Filter out any element that doesn't start with prefix and return this object for chaining

Parameters:

prefix - The prefix to filter for

Returns:

This TabCompleteHelper

filterPrefixNamespaced

public TabCompleteHelper filterPrefixNamespaced(String prefix)

Filter out any element that doesn't start with prefix and return this object for chaining

Assumes every element in this TabCompleteHelper is a ResourceLocation

Parameters:

prefix - The prefix to filter for

Returns:

This TabCompleteHelper

build

public String[] build()

Returns:

An array containing every element in this TabCompleteHelper

See Also:

• stream()

stream

public Stream<String> stream()

Returns:

A stream containing every element in this TabCompleteHelper

See Also:

• build()

addCommands

public TabCompleteHelper addCommands(ICommandManager manager)

Appends every command in the specified ICommandManager to this TabCompleteHelper

Parameters:

manager - A command manager

Returns:

This TabCompleteHelper

addSettings

public TabCompleteHelper addSettings()

Appends every setting in the Settings to this TabCompleteHelper

Returns:

This TabCompleteHelper

addModifiedSettings

public TabCompleteHelper addModifiedSettings()

Appends every modified setting in the Settings to this TabCompleteHelper

Returns:

This TabCompleteHelper

addToggleableSettings

public TabCompleteHelper addToggleableSettings()

Appends every Boolean setting in the Settings to this TabCompleteHelper

Returns:

This TabCompleteHelper