Class AbstractCommandCollection

java.lang.Object

com.hypixel.hytale.server.core.command.system.AbstractCommand

com.hypixel.hytale.server.core.command.system.basecommands.AbstractAsyncCommand

com.hypixel.hytale.server.core.command.system.basecommands.AbstractCommandCollection

Direct Known Subclasses:

AmbienceCommands, AmbienceCommands.AmbienceEmitterCommands, AssetsCommand, AudioCommands, AudioMusicCommands, AudioStateCommands, AuthCommand, AuthLoginCommand, BeamCommand, BlockAnimationSpeedCommand, BlockBulkCommand, BlockCommand, BlockSpawnerCommand, BrushConfigCommand, CameraEffectCommand, CancelCommand, ChunkCommand, CommandsCommand, DebugCommand, DebugShapeSubCommand, DiscoveryCommand, EncounterCommand, EntityCommand, EntitySnapshotSubCommand, EntityStatsSubCommand, FluidCommand, GameFlagsCommand, HideCommand, HitboxCollisionAddCommand, HitboxCollisionCommand, HitboxCollisionRemoveCommand, HitboxCommand, InstancesCommand.InstancesEditCommand, InteractionCommand, InternationalizationCommands, InventoryCommand, KnockbackApplyCommand, KnockbackApplyCommand, KnockbackCommand, LightingCommand, LightingSendCommand, LocateCommand, MacroCommandCollection, MapMarkersOverrideSubCommand, MapMarkersSubCommand, MemoriesCommand, MountCommand, NetworkCommand, NetworkCommand.LatencySimulationCommand, NetworkCommand.StreamPriorityCommand, NPCAttackCommand, NPCBlackboardCommand, NPCCommand, NPCDebugCommand, NPCFlockCommand, NPCPathCommand, NPCTestCommand, ObjectiveCommand, ObjectiveCompleteCommand, ObjectiveLocationMarkerCommand, ObjectiveReachLocationMarkerCommand, ObjectiveStartCommand, OpCommand, PacksCommand, ParkourCommand, ParticleCommand, PermCommand, PermGroupCommand, PermUserCommand, PlayCommand, PlayerCameraDemoSubCommand, PlayerCameraSubCommand, PlayerCommand, PlayerEffectSubCommand, PlayerLivesSubCommand, PlayerStatsSubCommand, PlayerViewRadiusSubCommand, PluginCommand, PortalCommands, PrefabCommand, PrefabEditCommand, PrefabPathCommand, PrefabPathUpdateCommand, PrefabPreviewCommand, PrefabSpawnerCommand, RecipeCommand, RepulsionAddCommand, RepulsionCommand, RepulsionRemoveCommand, ReputationCommand, RotateCommand, ServerCommand, ServerStatsCommand, SetGroupCommand, SleepCommand, SpawnBeaconsCommand, SpawnCommand, SpawnMarkersCommand, SpawnSuppressionCommand, StartCommand, TeleportCommand, TriggerVolumeBenchmarkCommand, TriggerVolumeCommand, UpdateCommand, VoiceCommand, VoidEventCommands, WarpCommand, WeatherCommand, WhitelistCommand, WildernessCommand, WorldCommand, WorldConfigCommand, WorldEventCommand, WorldGenCommand, WorldGenCommand, WorldMapCommand, WorldMapViewRadiusSubCommand, WorldPathBuilderCommand, WorldPathCommand, WorldRocksDbCommand, WorldSettingsCommand

public abstract class AbstractCommandCollection
extends AbstractAsyncCommand

The command base for subcommands that don't execute anything if run on their own, and generally act as a category for other commands

Nested Class Summary

Nested classes/interfaces inherited from class AbstractCommand

AbstractCommand.SuggestionOverrideEntry

Field Summary

Fields inherited from class AbstractCommand

EMPTY_STRING_ARRAY, LOGGER

Constructor Summary

Constructors

Constructor	Description
AbstractCommandCollection(String name, String description)	Default Constructor for a AbstractCommandCollection instance.

Method Summary

Modifier and Type	Method	Description
Message	getFullUsage(CommandSender sender)	Called to fetch the full usage string for this command, including all subcommands.
Message	getUsageString(CommandSender sender)	Return the full help text that displays the command and all its parameters
boolean	isNoArgVariant()

Methods inherited from class AbstractAsyncCommand

runAsync

Methods inherited from class AbstractCommand

acceptCall, addAliases, addSubCommand, addUsageVariant, completeRegistration, countParents, getAliases, getDescription, getFullyQualifiedName, getName, getOptionalArgument, getOptionalArguments, getOwner, getPermission, getPermissionGroups, getPermissionGroupsRecursive, getRequiredArguments, getSubCommand, getSubCommands, getSuggestionOverrides, getUsageShort, getVariantByArgCount, getVariantCommands, hasBeenRegistered, hasPermission, isVariant, matches, putRecursivePermissionGroups, requireNoPermission, requirePermission, requirePermission, setAllowsExtraArguments, setOwner, withDefaultArg, withDefaultArg, withFlagArg, withListDefaultArg, withListOptionalArg, withListRequiredArg, withOptionalArg, withOptionalArg, withRequiredArg, withRequiredArg

Methods inherited from class Object

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

Constructor Details

AbstractCommandCollection

public AbstractCommandCollection(@Nonnull
 String name,
 @Nonnull
 String description)

Default Constructor for a AbstractCommandCollection instance.

Parameters:

name - The name of the command.

description - The description of the command.

Method Details

getFullUsage

@Nonnull
public Message getFullUsage(@Nonnull
 CommandSender sender)

Called to fetch the full usage string for this command, including all subcommands.

Parameters:

sender - The sender to fetch the usage for.

Returns:

the full usage string of this command.

getUsageString

@Nonnull
public Message getUsageString(@Nonnull
 CommandSender sender)

Description copied from class: AbstractCommand

Return the full help text that displays the command and all its parameters

Overrides:

getUsageString in class AbstractCommand

Parameters:

sender - The command sender that sent the command.

Returns:

the usage message to display.

isNoArgVariant

public boolean isNoArgVariant()