Groups

Groups

Groups are sets of entities that have strict rules for membership. Groups have several properties

Property	Type	Description
types	List of String	A list of eligible types a group member can be.
exclude-types	List of String	A list of entity types a group member cannot be.
distance	Number or "same-chunk"	The maximum distance an entity can be from another group member.
count	Number	The minimum number of entities required for the group.
pure	Boolean	Whether all of the group members must be of the same type.
ignore-vertical-distance	Boolean	Whether to ignore the y-axis in distance calculations.

Entity types

An entity type can either be a specific type of entity, e.g. "zombie"; "cow"; "bat", or it can be a category of entities from the following table

Category	Description
category:animal	Animals such as cows, pigs, sheep and rabbits.
category:monster	Monsters such as zombies, creepers, endermen and skeletons.
category:fish	Fish such as salmon, cod and pufferfish.
category:ambient	Ambient mobs - currently just bats.
category:tameable	Tameable mobs such as cats, wolves and horses.
category:raider	Raiders such as pillagers, evokers and vindicators.
category:golem	Golems such as iron golems, snow golems and shulkers.
category:vehicle	Boats and minecarts.
category:projectile	Projectile entities such as arrows, tridents and wither skulls.

Examples

Example 1

The following group definition will capture any group of 10 cows or 10 pigs (but not 10 cows AND pigs) within a 5 block distance of each other.

group:
  types:
    - "pig"
    - "cow"
  count: 10
  distance: 5
  pure: true

Example 2

The following group definition will capture any group of 20 or more monsters in a chunk, excluding creepers. The monsters do not need the same type to be in a group together, so 10 zombies and 10 skeletons in the same chunk would fit into this definition, for example.

group:
  types:
    - "category:monster"
  exclude-types:
    - "creeper"
  count: 20
  distance: same-chunk

Example 3

The following group definition will capture any group of 20 or more fish all within a distance of 20 of each other, ignoring the vertical component in distance calculations.

group:
  types:
    - "category:fish"
  count: 20
  distance: 20
  ignore-vertical-distance: true