🛡️ Sets (bonus by pieces worn) PREMIUM

:::info Premium Sets need the premium version of ExecutableItems. With the free version, the files of the sets folder are not loaded (the console says so at each reload) and /ei sets explains it. :::

A set gives bonuses to a player who wears several ExecutableItems together: 2 pieces give a first bonus, 4 pieces a stronger one, and so on. The bonuses are active only while the pieces are worn, and they are removed cleanly as soon as a piece is taken off.

Sets replace the old method with a LOOP on one piece and ifHasExecutableItems conditions (Armor Set Bonus): the bonus comes the tick the last piece is put on and leaves the tick one is taken off, with several tiers, and nothing runs while the equipment does not change.

Create a set

1. Create a file in plugins/ExecutableItems/sets/. The file name is the set id: Coven_Witch.yml gives the set Coven_Witch.
2. List the ExecutableItems ids of the pieces and the tiers (see the example below).
3. Run /ei reload. The errors of the file (unknown item, effect or attribute...) are shown in the console and to the player who ran the reload.
4. Check with /ei sets <player> while wearing the pieces.

An Example_Set.yml (with enabled: false) is created the first time ExecutableItems starts. The items must exist: the sets are loaded after the items.

Default set: Tempest

The premium version comes with a ready set made of default items (1.21+): Tempest, four dyed leather armor pieces with a copper bolt trim and a Loyalty trident (items Prem_Tempest_*_v1_21, file sets/Tempest.yml).

• 2 pieces: Speed I
• 4 pieces: +2 hearts, +4 armor, Jump Boost I, storm sparks
• 5 pieces, the trident in a hand: Strength I and Conduit Power. Throw the trident: the bonus leaves with it and comes back when it returns.

It is installed with the default items: on a new server, or with /ei default_items on an existing one. Give yourself the pieces with /ei give <player> Prem_Tempest_Hood_v1_21 (_Mantle, _Greaves, _Treads, _Trident).

Example

enabled: true
name: '&2Coven Witch'
silenceOutput: true           # hide the console feedback of the commands
pieces:                       # ExecutableItems ids, each one counts once
  - Prem_Witch_Hat_v1_21      # by default a piece counts in the armor slots
  - Prem_Coven_Robe_v1_21
  - Prem_Coven_Skirt_v1_21
  - item: Prem_Coven_Wand_v1_21
    slots: [MAINHAND, OFFHAND]   # HEAD, CHEST, LEGS, FEET, OFFHAND, MAINHAND
tiers:                        # key = number of pieces; the tiers add up
  2:
    potionEffects:            # TYPE[:amplifier[:particles]]
      - SPEED:0
    enterCommands:            # player commands when the tier is reached
      - 'SENDMESSAGE &2%set_name% &7(%set_pieces%/%set_max_pieces%): Speed I'
    leaveCommands:            # player commands when the tier is lost
      - 'SENDMESSAGE &7%set_name%: bonus lost'
  4:
    potionEffects:
      - SPEED:1               # the strongest level of an effect wins
    attributes:               # ATTRIBUTE:amount[:ADD_NUMBER|ADD_SCALAR|MULTIPLY_SCALAR_1]
      - 'MAX_HEALTH:4'
    loopCommands:             # player commands every loopDelay ticks while the tier holds
      - 'MOB_AROUND distance:5 DAMAGE 2'
    loopDelay: 40

Settings

Set

Tier

How it behaves

• Tiers add up: with 4 pieces, the tiers 2 and 4 are both active. For the same potion effect, the strongest level wins.
• Effects and attributes stay while the tier holds and are removed when it is lost. They are put back automatically if something removes them (milk, /effect clear, death with keepInventory...). A stronger potion drunk over a set effect takes priority, and the set effect comes back when it ends. On 1.19.4+ the set effects are infinite (no blinking timer).
• enterCommands / leaveCommands run only when the player puts a piece on or takes it off. They do not run when the player joins or quits, nor on /ei reload: use them for feedback (message, sound, particles). For a lasting bonus, use potionEffects, attributes or loopCommands. When several tiers change at once, the lost tiers run their leaveCommands first (highest first), then the new tiers run their enterCommands (lowest first).
• The set bonuses are never saved on the player: they are removed when the player quits, on reload and when the server stops, and given back when the player joins. After a crash, leftover set effects are cleaned at the next join.
• Placeholders in the commands: %set_id%, %set_name%, %set_pieces%, %set_max_pieces%, %set_tier%, and the usual player placeholders.

Placeholders (PlaceholderAPI)

• %executableitems_set_<id>%: number of pieces of the set the player wears.
• %executableitems_set_<id>_tier%: highest active tier (number of pieces), 0 if none.

They can be used in the conditions of the activators of the pieces themselves, for example a stronger ability with the full set:

activators:
  full_set_spell:
    option: PLAYER_RIGHT_CLICK
    placeholdersConditions:
      full_set:
        type: PLAYER_NUMBER
        part1: '%executableitems_set_Coven_Witch%'
        comparator: SUPERIOR_OR_EQUALS
        part2: '4'
    playerCommands:
      - 'SENDMESSAGE &2Full coven power!'

Commands

• /ei sets: the loaded sets. /ei sets <player>: what this player wears and the active tier of each set. Permission ei.cmd.sets.

When a piece is lost

The bonus follows the pieces, whatever the way they leave or come back:

Performance

Nothing runs for every player at every tick. An equipment change marks the player and the pieces are counted once on the next tick, only in the slots the sets use, and the item id is read without going through the whole item list. On Paper the armor change event catches every armor change; the hands (when a set uses them), and the armor on Spigot, get a light check every half second, spread over the players, that only recounts when something changed. The loopCommands of all players share one task. Without any file in sets/, nothing runs at all.