Skip to content
Hydex (Pre-release)

NPCWorldCommandBase

Package: com.hypixel.hytale.server.npc.commands

public abstract class NPCWorldCommandBase extends AbstractWorldCommand

Abstract base class for NPC commands that operate on a single NPC within a world context. Extends AbstractWorldCommand and adds automatic NPC target resolution: if an entity argument is provided, that entity is used; otherwise the player’s look-target is resolved via TargetUtil.getTargetEntity(). The resolved entity is validated to have an NPCEntity component before the subclass execute method is called.

Fields

Section titled “Fields”
@Nonnull
protected static final Message MESSAGE_COMMANDS_ERRORS_PLAYER_OR_ARG

Error message displayed when the sender is not a player and no entity argument is provided.

@Nonnull
protected static final Message MESSAGE_COMMANDS_ERRORS_NO_ENTITY_IN_VIEW

Error message displayed when no entity is found in the player’s view.

@Nonnull
protected final EntityWrappedArg entityArg

Optional entity argument for specifying the target NPC by entity ID.

Constructors

Section titled “Constructors”
public NPCWorldCommandBase(@Nonnull String name, @Nonnull String description)
public NPCWorldCommandBase(@Nonnull String name, @Nonnull String description, boolean requiresConfirmation)
public NPCWorldCommandBase(@Nonnull String description)

Methods

Section titled “Methods”
@Override
protected void execute(@Nonnull CommandContext context, @Nonnull World world, @Nonnull Store<EntityStore> store)

Resolves the target NPC and delegates to the abstract execute overload.

protected abstract void execute(@Nonnull CommandContext var1, @Nonnull NPCEntity var2, @Nonnull World var3, @Nonnull Store<EntityStore> var4, @Nonnull Ref<EntityStore> var5)

Subclasses implement this to define command behavior on the resolved NPC.

@Nullable
protected static NPCEntity ensureIsNPC(@Nonnull CommandContext context, @Nonnull Store<EntityStore> store, Ref<EntityStore> ref)

Validates that the given entity reference has an NPCEntity component. Returns the component on success, or null with an error message if the entity is not an NPC.

Known Subclasses

Section titled “Known Subclasses”
Section titled “Related Types”
Hydex is an independent community resource. Hytale is a trademark of Hypixel Studios. Hydex is not affiliated with or endorsed by Hypixel Studios.