Class AbstractPlayerCommand

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.AbstractPlayerCommand

Direct Known Subclasses:

AbilitiesCommand, AmbienceEmitterAddCommand, BlockBulkFindHereCommand, BlockBulkReplaceCommand, BlockInspectFillerCommand, BlockInspectPhysicsCommand, BlockInspectRotationCommand, BlockRowCommand, BlockSelectCommand, BrushConfigClearCommand, BrushConfigDebugStepCommand, BrushConfigExitCommand, BrushConfigListCommand, BrushConfigLoadCommand, CheckpointAddCommand, CheckpointResetCommand, ChunkTintCommand, ClearBlocksCommand, ClearEditHistory, ClearEntitiesCommand, ContractSelectionCommand, CopyCommand, CutCommand, DamageCommand, DebugPlayerPositionCommand, DebugShapeArrowCommand, DebugShapeClearCommand, DebugShapeConeCommand, DebugShapeCubeCommand, DebugShapeCylinderCommand, DebugShapeSphereCommand, DeselectCommand, DismountCommand, EditLineCommand, EmoteCommand, EnvironmentCommand, EphemeralHeldItemCommand, ExpandCommand, ExtendFaceCommand, FillCommand, FlipCommand, FloodFillCommand, FluidCommand.GetCommand, FluidCommand.SetCommand, FluidCommand.SetRadiusCommand, GameModeCommand, GiveCommand, GlobalMaskCommand, HitboxCollisionRemoveCommand.HitboxCollisionRemoveSelfCommand, HollowCommand, HotbarSwitchCommand, HubCommand, ImageImportCommand, InstanceExitCommand, InstancesCommand, InstanceSpawnCommand, InteractionClearCommand, InteractionRunCommand, InteractionRunSpecificCommand, InventoryBackpackCommand, InventoryClearCommand, InventoryItemCommand, InventorySeeCommand, ItemStateCommand, KillCommand, KnockbackApplyCommand.KnockbackApplyAimedCommand, KnockbackApplyCommand.KnockbackApplyAimedCommand, KnockbackApplyCommand.KnockbackApplySelfCommand, KnockbackApplyCommand.KnockbackApplySelfCommand, LayerCommand, MapMarkersCreateCommand, MapMarkersInViewCommand, MapMarkersOverrideAddCommand, MapMarkersOverrideClearCommand, MapMarkersOverrideRemoveCommand, MemoriesCapacityCommand, ModelCommand, MoveCommand, NPCAllCommand, NPCBlackboardCommand.ReservationCommand, NPCBlackboardCommand.ReserveCommand, NPCFlockCommand.GrabCommand, NPCFlockCommand.JoinCommand, NPCFlockCommand.LeaveCommand, NPCFlockCommand.PlayerLeaveCommand, NPCMessageCommand, NPCRunTestsCommand, NPCSensorStatsCommand, NPCSpawnCommand, NPCSpawnCommand.SpawnPageCommand, NPCTestCommand.ProbeTestCommand, ObjectiveCompleteCommand.CompleteObjectiveCommand, ObjectiveCompleteCommand.CompleteTaskCommand, ObjectiveCompleteCommand.CompleteTaskSetCommand, ObjectiveHistoryCommand, ObjectiveLocationMarkerCommand.AddLocationMarkerCommand, ObjectivePanelCommand, ObjectiveReachLocationMarkerCommand.AddReachLocationMarkerCommand, ObjectiveStartCommand.StartObjectiveCommand, ObjectiveStartCommand.StartObjectiveLineCommand, ObjImportCommand, OpSelfCommand, PasteCommand, PlayerEffectApplyCommand, PlayerEffectClearCommand, PlayerRespawnCommand, PointCommand, Pos1Command, Pos2Command, PrefabEditInfoCommand, PrefabEditKillEntitiesCommand, PrefabEditModifiedCommand, PrefabEditSaveUICommand, PrefabEditSelectCommand, PrefabEditTeleportCommand, PrefabEditUpdateBoxCommand, PrefabPathAddCommand, PrefabPathEditCommand, PrefabPathMergeCommand, PrefabPathNewCommand, RedoCommand, RepairFillersCommand, ReplaceCommand, SelectChunkCommand, SelectChunkSectionCommand, SelectionHistoryCommand, ServersideUIDemoCommand, SetCommand, ShiftCommand, ShowBuilderToolsHudCommand, ShrinkCommand, SoundCommand, SpawnCommand, SpawnItemCommand, SpectateCommand, StackCommand, StashCommand, StopNetworkChunkSendingCommand, SubmergeCommand, TeleportBackCommand, TeleportForwardCommand, TeleportHistoryCommand, TeleportHomeCommand, TeleportToCoordinatesCommand, TeleportTopCommand, TeleportToPlayerCommand, TintCommand, ToggleBlockPlacementOverrideCommand, TpCinematicCommand, TriggerVolumeBrowseCommand, TriggerVolumeEffectsCommand, TriggerVolumeToolCommand, UndoCommand, UpdateSelectionCommand, ViewportCommand, WallsCommand, WarpGoCommand, WarpGoVariantCommand, WarpSetCommand, WhereAmICommand, WhoAmICommand, WorldMapClearMarkersCommand

public abstract class AbstractPlayerCommand
extends AbstractAsyncCommand

A command base that runs directly on the thread of the sending player's world.

This command base ensures thread safety by executing on the world thread, and provides access to the player's PlayerRef, Store, Ref, and World.

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
AbstractPlayerCommand(String description)	This constructor is specifically only for variant commands, added with AbstractCommand.addUsageVariant(AbstractCommand)
AbstractPlayerCommand(String name, String description)	Default Constructor for a AbstractPlayerCommand instance.
AbstractPlayerCommand(String name, String description, boolean requiresConfirmation)	Constructor for a AbstractPlayerCommand instance.

Method Summary

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, getUsageString, 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

AbstractPlayerCommand

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

Default Constructor for a AbstractPlayerCommand instance.

Parameters:

name - The name of the command.

description - The description of the command.

AbstractPlayerCommand

public AbstractPlayerCommand(@Nonnull
 String name,
 @Nonnull
 String description,
 boolean requiresConfirmation)

Constructor for a AbstractPlayerCommand instance.

Parameters:

name - The name of the command.

description - The description of the command.

requiresConfirmation - Whether the command requires additional confirmation.

AbstractPlayerCommand

public AbstractPlayerCommand(@Nonnull
 String description)

This constructor is specifically only for variant commands, added with AbstractCommand.addUsageVariant(AbstractCommand)

Parameters:

description - The description of the command.