All Beacon Effects

All Beacon Effects Reference

BeaconPlus features a modular effect system. This document provides a deep, technical breakdown of every built-in effect type, how they function internally, their configuration parameters, and important precautions for server owners.

---

1. Potion & Combat Effects

POTION_EFFECT

Applies standard Minecraft potion effects to entities within range.

• Mechanics: This effect uses the standard Bukkit Potion API. It applies the effect periodically to all entities that pass the beacon's conditions.

• Parameters:

  • Effect: The name of the potion effect (e.g., SPEED, INCREASE_DAMAGE). See Spigot/Paper documentation for a full list of valid names.
  • Amplifier: The strength of the potion. Note that standard Minecraft amplifiers starts at 0 for Level I, 1 for Level II.
  • Duration: How long the effect lasts once applied. Can be formatted as a string (e.g., "10s", "5m") or raw ticks.
  • Ambient: (Boolean) If true, makes the potion particles translucent (like from a beacon).
  • Particles: (Boolean) Whether to show particles on the entity.
  • Icon: (Boolean) Whether to show the effect icon in the player's HUD.
  • Remove On Leave: (Boolean) If enabled, the effect is instantly stripped the moment the player leaves the beacon's area.

• [!IMPORTANT] Precaution: Setting a very long duration with Remove On Leave: false effectively gives players permanent buffs outside the beacon range until they expire or die. Use this cautiously for balance.

YAML Example:

- Type: POTION_EFFECT
  Effect: SPEED
  Amplifier: 1
  Duration: "12s"
  Ambient: true
  Particles: false
  Icon: true
  Remove On Leave: true

POTION_DURATION_BOOST

Extends the duration of potion effects that a player already possesses.

• Mechanics: Scans the entity's active effects. If a match is found, it adds the specified number of ticks to the remaining duration.
• Parameters:
  • Potion Effect Type: The ID of the effect to boost.
  • Duration Boost Tick: Amount of ticks added per application cycle.
• Precaution: If the boost amount is higher than the decay rate, the player will have an "infinite" potion effect as long as they stay in range.

YAML Example:

- Type: POTION_DURATION_BOOST
  Potion Effect Type: INCREASE_DAMAGE
  Duration Boost Tick: 40 # Adds 2 seconds every cycle

IMMORTALITY_FIELD

Creates a "Death Defy" zone where entities cannot be killed.

• Mechanics: Listens to damage events. If an event would result in health dropping below the threshold, it cancels the death and sets health to the minimum.
• Parameters:
  • Min Health: The lowest health value an entity can drop to (e.g., 1.0 for half a heart).
  • Survival Chance: (0.0 to 100.0) The probability that the "Saving Grace" will trigger on a fatal hit.

• [!WARNING] Precaution: Survival Chance: 100 makes players effectively invincible. This can be exploited in PvP or for farming mobs without risk.

YAML Example:

- Type: IMMORTALITY_FIELD
  Min Health: 2.0
  Survival Chance: 50.0

---

2. Movement & Physics

FLY

Grants players the ability to fly as if in creative mode.

• Mechanics: Interfaces with the player.setAllowFlight() API. It tracks the player's altitude relative to the beacon.
• Parameters:
  • Height: The maximum altitude (Y-level) above the beacon block where flight is permitted. Set to -1 for infinite height within the beacon's horizontal range.
• Precaution: Be aware that "Fly Kick" or "Cheat Detection" plugins might flag players if they move too fast or change directions abruptly while flying.

YAML Example:

- Type: FLY
  Height: 32 # Flight allowed up to 32 blocks above the beacon

MAGNET

Attracts entities toward the beacon location.

• Mechanics: Calculates a vector from the entity to the beacon and applies a velocity pulse.
• Parameters:
  • Magnitude: The "strength" of the pull. Positive values pull inward; negative values push entities away (Repulsion).

• [!CAUTION] Precaution: High magnitude values can cause entities to "glitch" through walls or trigger anti-cheat lag detections. Use low values (e.g., 0.1 to 0.5) for smooth movement.

YAML Example:

- Type: MAGNET
  Magnitude: 0.2

---

3. World & Economy

KEEP_CHUNK_LOADED

Forces the chunk(s) around the beacon to stay loaded even if no players are nearby.

• Mechanics: Uses the Bukkit chunk ticketing system. Ensures the chunk is kept in memory.
• Parameters:
  • Single Chunk: (Boolean) If true, only the chunk containing the beacon is kept.
  • Load Chunk: (Boolean) If the chunk is currently unloaded when the beacon activates, force it to load.

• [!IMPORTANT] Precaution: Keeping many chunks loaded on a low-RAM server will lead to server crashes or extreme TPS drops. Use this only for specialized "Admin" beacons or very high-cost player upgrades.

YAML Example:

- Type: KEEP_CHUNK_LOADED
  Single Chunk: true
  Load Chunk: true

EXP_BOOST

Increases the amount of raw Experience points players gain.

• Mechanics: Multiplies the value of EXP orbs or experience gained from activities.
• Parameters:
  • Multiplier: A decimal value. 1.0 is default gain, 2.0 is double exp.

YAML Example:

- Type: EXP_BOOST
  Multiplier: 1.5

APPLY_MENDING

Automatically repairs Mending-enchanted items by consuming beacon power.

• Mechanics: Scans the player's inventory for damaged mending items and restores durability.
• Parameters:
  • Mending Repair Amount: Raw durability points restored per application cycle.
• Precaution: This can make anvil repairs obsolete. Ensure the Power Consumption for this tier is balanced correctly.

YAML Example:

- Type: APPLY_MENDING
  Mending Repair Amount: 5

---

4. Automation & Mobs

SPAWNER_BOOST

Accelerates the "spawn delay" of nearby Creature Spawners.

• Mechanics: Modifies the internal timer of CreatureSpawner blocks in range.
• Parameters:
  • Speed Up Percentage: How much faster the spawner runs. 50 means 1.5x speed.
• Precaution: Boosting many spawners simultaneously creates massive entity lag. Monitor entity counts closely when using this effect.

YAML Example:

- Type: SPAWNER_BOOST
  Speed Up Percentage: 25

CROPS_BOOST

Accelerates the growth stages of nearby crops (wheat, carrots, etc.).

• Mechanics: Detects Ageable blocks and manually increments their age property.
• Parameters:
  • Speed Up Stage: How many growth stages to skip (Default: 1).
  • Crops Whitelist: (List) Specific materials to boost.
  • Crops Blacklist: (List) Materials to ignore.
  • Prevent Instant Growth: (Boolean) If true, the crop will stop growing at its final stage but won't "pop off" (like pumpkin stems).
  • Growth Boost: (Boolean) If true, uses the standard growth event which allows integration with other farming plugins.

YAML Example:

- Type: CROPS_BOOST
  Speed Up Stage: 2
  Prevent Instant Growth: true
  Crops Whitelist:
    - WHEAT
    - CARROTS

FURNACE_BOOST

Accelerates smelting in Furnaces, Blast Furnaces, and Smokers.

• Mechanics: Increases both the smelting progress and the fuel burn rate.
• Parameters:
  • Speed Up Time: Multiplier for smelting speed.
  • Fuel Speed Up Time: Multiplier for fuel consumption speed.
  • Block Type Whitelist: (List) Which furnace types are affected.

YAML Example:

- Type: FURNACE_BOOST
  Speed Up Time: 2.0
  Fuel Speed Up Time: 1.5

---

5. Technical & Management

COMMAND_EXECUTOR

Runs a server command relative to the entities in range.

• Mechanics: Executes a command as if typed by the console or player.
• Parameters:
  • Command: The command string.
  • Console: (Boolean) If true, runs as the Server Console (allows bypassing permissions). If false, runs as the player.
• Available Placeholders:
  • {player} - Player name.
  • {uuid} - Entity UUID.
  • {world}, {x}, {y}, {z} - Entity location.
  • {beacon_x}, {beacon_y}, {beacon_z} - Beacon location.

• [!CAUTION] Security Precaution: NEVER use {player} in a command that grants permissions or OP status unless the logic is strictly controlled. A malicious player could figure out a way to trigger the command prematurely.

YAML Example:

- Type: COMMAND_EXECUTOR
  Command: "eco give {player} 10"
  Console: true

PERMISSION

Grants temporary permission nodes to players while they remain in range.

• Mechanics: Uses an internal Permission Attachment. Permissions are automatically removed when the player leaves.
• Parameters:
  • Permissions: A map of node names to boolean values.

YAML Example:

- Type: PERMISSION
  Permissions:
    essentials.fly: true
    myplugin.premium.access: true

GLOW

Highlights entities or the beacon location itself.

• Mechanics: Uses various rendering methods to create a glowing silhouette.
• Parameters:
  • Method: AUTO, BLOCK_DISPLAY (1.19.4+), SHULKER (Fake entity), PARTICLES.
  • Color: Standard ChatColor name (e.g., GOLD, AQUA).

YAML Example:

- Type: GLOW
  Method: BLOCK_DISPLAY
  Color: LIGHT_PURPLE

---

6. Self-Buffs (Beacon Internal)

EXTRA_POWER / EXTRA_RANGE

Extends the beacon's own stats.

• Mechanics: Modifies the beacon's metadata during the calculation phase.
• Parameters:
  • Amount: The value to add to the base power or range.

YAML Example:

- Type: EXTRA_RANGE
  Amount: 20 # Adds 20 blocks to the calculated radius