Beacon Effects

In this page you will learn how to add custom beacon effects

You can add beacon effects inside effects.yml

Effect Config Structure

Effects:
    <effect id>:
        Display Name: <effect display name>
        Item: <effect display item>
        Description: <effect description>
        Enabled: <true/false>
        Levels: <effect upgrades map list>
    ...

For effect display item, please see

https://www.spigotmc.org/wiki/itemstack-serialization/

Effect Upgrades Config Structure

        Levels:
        - Cost:
                <economy name>: <price>
                ...
          Description: <upgrade description>
          Power Consumption: <upgrade's effect power consumption>
          Effects: <effects map list>
          Condition: <upgrade's effect condition>
        ...
        

Economy Types

• PlayerPoints

• Vault

• Level

• <Item> (see config.yml)

Effects Config Structure

• EXP_BOOST

          Effects:
          - Type: EXP_BOOST
            Multiplier: <experience boost multiplier>
            Condition: [effect condition, optional]

• FLY

          Effects:
          - Type: FLY
            Height: <fly max height from beacon>
            Condition: [effect condition, optional]

• FURNACE_BOOST

          Effects:
          - Type: FURNACE_BOOST
            Speed Up Time: <speed up time percentage>
            Block Type Whitelist: [list of whitelisted blocks, optional]
            Condition: [effect condition, optional]
          - Type: FURNACE_BOOST
            Speed Up Time: <speed up time percentage>
            Block Type Whitelist:
            - FURNACE
            - SMOKER

For list of blocks, please see

https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html

• CROPS_BOOST

          Effects:
          - Type: CROPS_BOOST
            Speed Up Stage: <stage to skip when planted>
            Crops Blacklist: [list of blacklisted blocks, optional]
            Crops Whitelist: [list of whitelisted blocks, optional]
            Condition: [effect condition, optional]

For list of blocks, please see

https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html

• MAGNET

          Effects:
          - Type: MAGNET
            Magnitude: <the magnet strength>
            Condition: [effect condition, optional]

• POTION_EFFECT

          Effects:
          - Type: POTION_EFFECT
            Effect: <effect type>
            Duration: <effect duration>
            Amplifier: <effect amplifier, number starts from 0>
            Ambient: <true/false>
            Particles: <true/false>
            Icon: <true/false>
            Condition: [effect condition, optional]

For list of potion effect types, please see

https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/potion/PotionEffectType.html

• POTION_DURATION_BOOST

          Effects:
          - Type: POTION_DURATION_BOOST
            Potion Effect Type: <effect type>
            Duration Boost Tick: <tick to decrease from effect every beacon tick>
            Condition: [effect condition, optional]

For list of potion effect types, please see

https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/potion/PotionEffectType.html

• STUPID_AI

          Effects:
          - Type: STUPID_AI
            Condition: [effect condition, optional]

• SPAWNER_BOOST

          Effects:
          - Type: SPAWNER_BOOST
            Speed Up Percentage: <spawner delay speed up percentage>
            Condition: [effect condition, optional]

• FIRE_CONTROL

          Effects:
          - Type: FIRE_CONTROL
            Fire Tick: <fire tick to add every beacon tick>
            Condition: [effect condition, optional]

If the fire tick is positive, the entity will be burned, otherwise, it will extinguish it

• SATURATION

          Effects:
          - Type: SATURATION
            Saturation: <saturation value, number>
            Condition: [effect condition, optional]

• COMMAND_EXECUTOR

        Effects:
        - Type: COMMAND_EXECUTOR
          Command: "say Hello everyone! My name is {player} and i live in {world}"
          Console: false

Placeholders:

1. {player} The entity name

2. {uuid} The entity UUID

3. {world} The entity world name

4. {x} The entity x coordinate

5. {y} The entity y coordinate

6. {z} The entity z coordinate

7. {yaw} The entity yaw

8. {pitch} The entity pitch

9. {beacon_x} The beacon x coordinate

10. {beacon_y} The beacon y coordinate

11. {beacon_world} The beacon world name