Enum BaseCommand.CommandResult
-
- All Implemented Interfaces:
public enum BaseCommand.CommandResultRepresents the success status of a command. Returned by runCommand.
- Since:
2.0
-
-
Enum Constant Summary
Enum Constants Enum Constant Description SUCCESSCommand ran successfully.
BAD_SYNTAXCommand had the wrong arguments passed in. Returning this will automatically display the syntax field from your commands.csv, so you usually don't need to include an error message.
WRONG_CONTEXTCommand was used in the wrong context (ex: entering a campaign-only command in a mission).
ERRORSomething went wrong while executing the command.
-
Method Summary
Modifier and Type Method Description static Array<BaseCommand.CommandResult>values()Returns an array containing the constants of this enum type, in the order they're declared. static BaseCommand.CommandResultvalueOf(String name)Returns the enum constant of this type with the specified name. -
-
Method Detail
-
values
static Array<BaseCommand.CommandResult> values()
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants.
- Returns:
an array containing the constants of this enum type, in the order they're declared
-
valueOf
static BaseCommand.CommandResult valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
- Returns:
the enum constant with the specified name
-
-
-
-