Class PrefabArgumentType

java.lang.Object

com.hypixel.hytale.server.core.command.system.arguments.types.ArgumentType<String>

com.hypixel.hytale.server.core.command.system.arguments.types.SingleArgumentType<String>

com.hypixel.hytale.builtin.buildertools.commands.PrefabArgumentType

All Implemented Interfaces:

SuggestionProvider

public class PrefabArgumentType
extends SingleArgumentType<String>

Resolves a single prefab by key across all browsable locations (asset packs and the server directory). Suggests every prefab and validates that the key resolves to an existing file. The parsed value is the key as entered, which PrefabStore.findBrowsablePrefabPath(String) re-resolves later.

Field Summary

Fields inherited from class ArgumentType

EMPTY_EXAMPLES

Constructor Summary

Constructors

Constructor	Description
PrefabArgumentType(String name, String argumentUsage)

Method Summary

Modifier and Type	Method	Description
String	parse(String input, ParseResult parseResult)	Parses the input String and returns a value of Type DataType.
void	suggest(CommandSender sender, String textAlreadyEntered, int numParametersTyped, SuggestionResult result)	Override this method to provide ArgumentType-specific suggestions that don't rely on the context of the command.

Methods inherited from class SingleArgumentType

parse, withOverriddenUsage, withOverriddenUsage, withSharedSuggestions

Methods inherited from class ArgumentType

getArgumentUsage, getExamples, getName, getNumberOfParameters, getSuggestionTypeId, getSuggestionValueCount, isGreedyString, isListArgument, processedGet, toString

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

PrefabArgumentType

public PrefabArgumentType(@Nonnull
 String name,
 @Nonnull
 String argumentUsage)

Method Details

parse

@Nullable
public String parse(String input,
 ParseResult parseResult)

Description copied from class: SingleArgumentType

Parses the input String and returns a value of Type DataType. If anything goes wrong during parsing, you should use ParseResult.fail(Message, Message...) and then return null

Specified by:

parse in class SingleArgumentType<String>

Parameters:

input - The argument String from the Tokenizer

parseResult - The parseResult to fail if anything goes wrong

Returns:

the converted value

suggest

public void suggest(@Nonnull
 CommandSender sender,
 @Nonnull
 String textAlreadyEntered,
 int numParametersTyped,
 @Nonnull
 SuggestionResult result)

Description copied from class: ArgumentType

Override this method to provide ArgumentType-specific suggestions that don't rely on the context of the command. Use SuggestionResult.suggest(Object) or any other "suggest" methods of SuggestionResult to provide the suggestions.

Specified by:

suggest in interface SuggestionProvider

Overrides:

suggest in class ArgumentType<String>

Parameters:

sender - The sender who sent the command

textAlreadyEntered - The text already entered for this command

numParametersTyped - The number of parameters that have been typed, in relation to ArgumentType.numberOfParameters

result - The result of the suggestions, append suggestions to this in order to provide them