Class ArgumentTime
java.lang.Object
net.minestom.server.command.builder.arguments.Argument<UpdateOption>
net.minestom.server.command.builder.arguments.minecraft.ArgumentTime
public class ArgumentTime extends Argument<UpdateOption>
Represents an argument giving a time (day/second/tick).
Example: 50d, 25s, 75t
-
Field Summary
Fields Modifier and Type Field Description static int
INVALID_TIME_FORMAT
static int
NO_NUMBER
Fields inherited from class net.minestom.server.command.builder.arguments.Argument
SUCCESS, UNDEFINED_ERROR
-
Constructor Summary
Constructors Constructor Description ArgumentTime(java.lang.String id)
-
Method Summary
Modifier and Type Method Description int
getConditionResult(UpdateOption value)
Called afterArgument.parse(String)
meaning thatvalue
should already represent a valid representation of the input.int
getCorrectionResult(java.lang.String value)
First method called to check the validity of an input.UpdateOption
parse(java.lang.String value)
Called afterArgument.getCorrectionResult(String)
returnedArgument.SUCCESS
.Methods inherited from class net.minestom.server.command.builder.arguments.Argument
allowSpace, getCallback, getId, hasErrorCallback, setCallback, useRemaining
-
Field Details
-
INVALID_TIME_FORMAT
public static final int INVALID_TIME_FORMAT- See Also:
- Constant Field Values
-
NO_NUMBER
public static final int NO_NUMBER- See Also:
- Constant Field Values
-
-
Constructor Details
-
ArgumentTime
public ArgumentTime(java.lang.String id)
-
-
Method Details
-
getCorrectionResult
public int getCorrectionResult(@NotNull java.lang.String value)Description copied from class:Argument
First method called to check the validity of an input.If
Argument.allowSpace()
is enabled, the value will be incremented by the next word until it returnsArgument.SUCCESS
, meaning that you need to be sure to check the inexpensive operations first (eg the number of brackets, the first and last char, etc...).- Specified by:
getCorrectionResult
in classArgument<UpdateOption>
- Parameters:
value
- The received argument- Returns:
- the error code or
Argument.SUCCESS
-
parse
Description copied from class:Argument
Called afterArgument.getCorrectionResult(String)
returnedArgument.SUCCESS
.The correction being correct means that
value
shouldn't be verified again, you can assume that no exception will occur when converting it to the correct type.- Specified by:
parse
in classArgument<UpdateOption>
- Parameters:
value
- The correct argument which does not need to be verified again- Returns:
- The parsed argument
-
getConditionResult
Description copied from class:Argument
Called afterArgument.parse(String)
meaning thatvalue
should already represent a valid representation of the input.The condition result has for goal to check the optional conditions that are user configurable (eg min/max values for a number, a specific material for an item, etc...).
- Specified by:
getConditionResult
in classArgument<UpdateOption>
- Parameters:
value
- The parsed argument- Returns:
- the error code or
Argument.SUCCESS
-