Rules

This page contains a list of rules included with QuantumAPI.

TOC

• avoid-block
• only-block
• avoid-biome
• only-biome
• avoid-entity
• nearby-entity
• avoid-region
• avoid-claims

avoid-block

Invalidates a location if it's Material type is a specific type.

Options

• block-types: A list of Materials

Example

// Rulesets configuration
{
  type: avoid-block
  options: {
    block-types: [LAVA, WATER]
  }
}

only-block

Invalidates a location if it's Material type is not a specific type.

Options

• block-types: A list of Materials

Example

// Rulesets configuration
{
  type: only-block
  options: {
    block-types: [STONE]
  }
}

avoid-biome

Invalidates a location if it's Biome type is a specific type.

Options

• biome-types: A list of Biomes

Example

// Rulesets configuration
{
  type: avoid-biome
  options: {
    biome-types: [PLAINS]
  }
}

only-biome

Invalidates a location if it's Biome type is not a specific type.

Options

• biome-types: A list of Biomes

Example

// Rulesets configuration
{
  type: only-biome
  options: {
    biome-types: [PLAINS]
  }
}

avoid-entity

Invalidates a location if a specific entity type is within radius blocks of the location.

Options

• entity-types: A list of Entitys
• radius: How far should one of these mobs be to consider this location invalid

Example

// Rulesets configuration
{
  type: avoid-entity
  options: {
    entity-types: [CREEPER, SKELETON, ZOMBIE],
    radius: 10
  }
}

nearby-entity

Invalidates a location if a specific entity type isn't within radius blocks of the location.

Options

• entity-types: A list of Entitys
• radius: How far should one of these mobs be to consider this location valid

Example

// Rulesets configuration
{
  type: nearby-entity
  options: {
    entity-types: [PIG, SHEEP, ZOMBIE],
    radius: 10
  }
}

avoid-region

Invalidates a location if it is within a WorldGuard region.

Requires WorldGuard to be installed.

Options

• regions: A list of region names to avoid. If you want to avoid all regions, set the list to ["*"].

Example

// Rulesets configuration
{
  type: avoid-region
  options: {
    regions: ["spawn", "warzone"],
//    regions: ["*"], // ignores all regions
  }
}

avoid-claims

Invalidates a location if it is within a FactionsUUID.

Requires FactionsUUID (or a fork) to be installed.

Options

• factions-whitelist: A list of Faction names to allow. Make sure you include "wilderness"!

Example

// Rulesets configuration
{
  type: avoid-claims
  options: {
    factions-whitelist: ["wilderness", "warzone"]
  }
}