com.hypixel.hytale.server.npc.commands

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

This package contains the 23 command classes (49 types including inner classes) that implement the /npc command tree. These commands are registered by NPCPlugin.setup() via NPCCommand and provide server operators with tools for spawning, inspecting, debugging, and controlling NPC entities at runtime.

All types in this package are internal (api_surface: false). They are not part of the public plugin API.

Command Tree

/npc
  all          -- Spawn all NPC roles in a grid
  appearance   -- Change NPC model
  attack       -- Override attack interactions
    (set)      -- Set attack overrides
    clear      -- Clear attack overrides
  benchmark    -- Start performance benchmarks
  blackboard   -- Inspect NPC perception data
    chunks     -- List blackboard chunk sections
    chunk      -- Inspect a specific chunk
    drop       -- Clear all blackboard data
    views      -- List block type views
    view       -- Inspect a specific block type view
    blockevents    -- Show block event subscriptions
    entityevents   -- Show entity event subscriptions
    resourceviews  -- List resource views
    resourceview   -- Inspect a specific resource view
    reserve    -- Add/remove player-NPC reservation
    reservation -- Check reservation status
  clean        -- Remove all NPCs from world
  debug        -- Manage debug flags
    show       -- Show current flags
    set        -- Replace flags
    toggle     -- Toggle individual flags
    defaults   -- Apply default preset
    clear      -- Remove all flags
    presets    -- List available presets
  dump         -- Dump NPC state to log
  freeze       -- Pause NPC behavior
  give         -- Give item to NPC
    nothing    -- Clear held item
  message      -- Send beacon message to NPC
  path         -- Assign transient paths
    (set)      -- Set path from rotation/distance pairs
    polygon    -- Set regular polygon path
  role         -- Change NPC role
    (get)      -- Display current role
  runtests     -- Run NPC behavior test suite
  sensorstats  -- Display sensor range statistics
  spawn        -- Spawn NPCs with options
    (page)     -- Open spawn UI page
  step         -- Step NPC behavior one tick
  test         -- Diagnostic tests
    probe      -- Test position validity
  thaw         -- Unfreeze NPCs

Base Classes

Type	Kind	Description
NPCWorldCommandBase	abstract class	Base for single-NPC world commands with automatic target resolution
NPCMultiSelectCommandBase	abstract class	Base for multi-NPC commands with spatial selection (cone, sphere, ray)
NPCCommandUtils	class	Static utility for resolving target NPC from command context

Top-Level Commands

Type	Kind	Sub-command	Description
NPCCommand	class	/npc	Root command collection
NPCDescriptorsCommand	class	descriptors	Generate and save NPC descriptors
NPCAllCommand	class	all	Spawn all roles in a grid
NPCAppearanceCommand	class	appearance	Change NPC model
NPCAttackCommand	class	attack	Override attack interactions
NPCBenchmarkCommand	class	benchmark	Performance benchmarking
NPCBlackboardCommand	class	blackboard	Inspect perception data
NPCCleanCommand	class	clean	Remove all NPCs
NPCDebugCommand	class	debug	Manage debug flags
NPCDumpCommand	class	dump	Dump NPC state
NPCFreezeCommand	class	freeze	Pause NPC behavior
NPCGiveCommand	class	give	Give item to NPC
NPCMessageCommand	class	message	Send beacon messages
NPCPathCommand	class	path	Assign transient paths
NPCRoleCommand	class	role	Change NPC role
NPCRunTestsCommand	class	runtests	Run behavior test suite
NPCSensorStatsCommand	class	sensorstats	Sensor range statistics
NPCSpawnCommand	class	spawn	Spawn NPCs
NPCStepCommand	class	step	Step behavior one tick
NPCTestCommand	class	test	Diagnostic tests
NPCThawCommand	class	thaw	Unfreeze NPCs

Inner Classes

Type	Kind	Parent	Description
NPCAttackCommand.SetAttackCommand	class	NPCAttackCommand	Sets attack overrides
NPCAttackCommand.ClearAttackCommand	class	NPCAttackCommand	Clears attack overrides
NPCBlackboardCommand.ChunksCommand	class	NPCBlackboardCommand	Lists chunk sections
NPCBlackboardCommand.ChunkCommand	class	NPCBlackboardCommand	Inspects a chunk
NPCBlackboardCommand.DropCommand	class	NPCBlackboardCommand	Clears blackboard
NPCBlackboardCommand.ViewsCommand	class	NPCBlackboardCommand	Lists block type views
NPCBlackboardCommand.ViewCommand	class	NPCBlackboardCommand	Inspects a view
NPCBlackboardCommand.BlockEventsCommand	class	NPCBlackboardCommand	Block event subscriptions
NPCBlackboardCommand.EntityEventsCommand	class	NPCBlackboardCommand	Entity event subscriptions
NPCBlackboardCommand.ResourceViewsCommand	class	NPCBlackboardCommand	Lists resource views
NPCBlackboardCommand.ResourceViewCommand	class	NPCBlackboardCommand	Inspects a resource view
NPCBlackboardCommand.ReserveCommand	class	NPCBlackboardCommand	Manages reservations
NPCBlackboardCommand.ReservationCommand	class	NPCBlackboardCommand	Checks reservation status
NPCDebugCommand.ShowCommand	class	NPCDebugCommand	Shows debug flags
NPCDebugCommand.SetCommand	class	NPCDebugCommand	Sets debug flags
NPCDebugCommand.ToggleCommand	class	NPCDebugCommand	Toggles debug flags
NPCDebugCommand.DefaultsCommand	class	NPCDebugCommand	Applies default preset
NPCDebugCommand.ClearCommand	class	NPCDebugCommand	Clears debug flags
NPCDebugCommand.PresetsCommand	class	NPCDebugCommand	Lists presets
NPCGiveCommand.GiveNothingCommand	class	NPCGiveCommand	Clears held item
NPCPathCommand.SetPathCommand	class	NPCPathCommand	Sets freeform path
NPCPathCommand.PolygonPathCommand	class	NPCPathCommand	Sets polygon path
NPCRoleCommand.GetRoleCommand	class	NPCRoleCommand	Gets current role
NPCRunTestsCommand.NPCTestData	class	NPCRunTestsCommand	Test session ECS component
NPCSpawnCommand.SpawnPageCommand	class	NPCSpawnCommand	Spawn UI page
NPCTestCommand.ProbeTestCommand	class	NPCTestCommand	Position probe test