NPC Hiding

Usage

Hide NPCs if specified conditions are met! You can do that by adding a hide_npcs section in your package. It allows you to assign conditions to specific BQ NpcIDs like so:

CitizensFancyNpcsZNPCsPlus

Example

npcs:
  innkeeper: citizens 0
conditions:
  hidden: tag innkeeperIsTired
hide_npcs:
  innkeeper: hidden

Required Dependency: ProtocolLib

This feature can be activated by installing the ProtocolLib plugin.

Example

npcs:
  innkeeper: FancyNpcs dc8f2889-ed79-455e-944b-115dae978737
conditions:
  hidden: tag innkeeperIsTired
hide_npcs:
  innkeeper: hidden

Example

npcs:
  innkeeper: ZNPCsPlus innkeeper
conditions:
  hidden: tag innkeeperIsTired
hide_npcs:
  innkeeper: hidden

Where NpcID is declared when you register the NPC which is described here.

The interval the conditions are checked in can be configured in the config.yml.

Force Visibility Update

You can run the updatevisibility event to manually update the visibility. This is useful for performance optimizations if used with the npc hider interval set to high values.