Class NPCWorldCommandBase

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

com.hypixel.hytale.server.npc.commands.NPCWorldCommandBase

Direct Known Subclasses:

NPCAppearanceCommand, NPCAttackCommand.ClearAttackCommand, NPCAttackCommand.SetAttackCommand, NPCDumpCommand, NPCGiveCommand, NPCGiveCommand.GiveNothingCommand, NPCMultiSelectCommandBase, NPCPathCommand.PolygonPathCommand, NPCPathCommand.SetPathCommand, NPCRoleCommand, NPCRoleCommand.GetRoleCommand

public abstract class NPCWorldCommandBase
extends AbstractWorldCommand

A command base that runs directly on the thread of the target world and provides access to an NPC entity.

The command will target an NPC entity based on the following priority:

1. If an entity argument is provided, it will target that entity (must be an NPC)
2. If the sender is a player, it will target the NPC entity in view (ray-cast)
3. Otherwise, an error message is sent

This command base ensures thread safety by executing on the world thread, and provides access to the NPC entity's NPCEntity, 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
NPCWorldCommandBase(String description)	This constructor is specifically only for variant commands, added with AbstractCommand.addUsageVariant(AbstractCommand).
NPCWorldCommandBase(String name, String description)	Default Constructor for an NPCWorldCommandBase instance.
NPCWorldCommandBase(String name, String description, boolean requiresConfirmation)	Constructor for an NPCWorldCommandBase 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

NPCWorldCommandBase

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

Default Constructor for an NPCWorldCommandBase instance.

Parameters:

name - The name of the command.

description - The description of the command.

NPCWorldCommandBase

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

Constructor for an NPCWorldCommandBase instance.

Parameters:

name - The name of the command.

description - The description of the command.

requiresConfirmation - Whether the command requires additional confirmation.

NPCWorldCommandBase

public NPCWorldCommandBase(@Nonnull
 String description)

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

Parameters:

description - The description of the command.