diff --git a/docs/all-plugins/the-item-lookup-system.md b/docs/all-plugins/the-item-lookup-system.md index 4f1e361145..ad4f8d5f01 100644 --- a/docs/all-plugins/the-item-lookup-system.md +++ b/docs/all-plugins/the-item-lookup-system.md @@ -46,6 +46,7 @@ Items can have modifiers applied to them in the key. For example, lets say you'r - **Item Flags:** You can specify flags for the item to have, by dropping in any of [these values](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/inventory/ItemFlag.html) (not case sensitive) - **Unbreakable:** You can make an item unbreakable by having the word `unbreakable` in the flags - **Custom Model Data:** You can specify custom model data with `custom-model-data:` +- **Armor Trims:** You can specify armor trims with `trim::`, e.g. `trim:emerald:snout` So, lets say you have an EcoMobs mob, and you want it to drop a rare custom weapon with extra modifiers already applied. Without the Item Lookup system, this wouldn't be possible, but thanks to it, you can just do this: `ecoitems:enlightened_blade razor:4 unbreaking:3 criticals:2 fire_aspect:2 reforge:mighty unbreakable hide_attributes custom-model-data:2` diff --git a/docs/effects/all-effects/drop_item_slot.md b/docs/effects/all-effects/drop_item_slot.md index 3fa3560994..d6bc115a1a 100644 --- a/docs/effects/all-effects/drop_item_slot.md +++ b/docs/effects/all-effects/drop_item_slot.md @@ -5,7 +5,7 @@ Drops items from the player's inventory # Example Config ```yaml -- id: drop_item +- id: drop_item_slot args: slot: hand # The slot to drop, can be any numeric slot, hand, or 'any' (Defaults to any) amount: 1 # (Optional) The amount of items to drop, defaults to full stack diff --git a/docs/effects/all-effects/rotate.md b/docs/effects/all-effects/rotate.md index ca5cb8c590..08890493f7 100644 --- a/docs/effects/all-effects/rotate.md +++ b/docs/effects/all-effects/rotate.md @@ -4,8 +4,8 @@ Spin around # Example Config -```rotate -- id: traceback +```yaml +- id: rotate args: angle: 180 # The angle to rotate / spin (in degrees) ...other config (eg triggers, filters, mutators, etc) diff --git a/docs/effects/all-filters/is_passive.md b/docs/effects/all-filters/is_passive.md new file mode 100644 index 0000000000..365bac5b24 --- /dev/null +++ b/docs/effects/all-filters/is_passive.md @@ -0,0 +1,9 @@ +# `is_passive` + +If the entity must be passive + +# Example Config +```yaml +filters: + is_passive: true +``` diff --git a/docs/effects/all-triggers.md b/docs/effects/all-triggers.md index 678008c71e..bfa2b5ca08 100644 --- a/docs/effects/all-triggers.md +++ b/docs/effects/all-triggers.md @@ -6,7 +6,8 @@ sidebar_position: 6 Triggered effects require a trigger, permanent effects do not support triggers and instead always apply when the effect is active -Triggered effects also produce a value, which is used in EcoPets for levelling. +Triggered effects also produce a value, which can be referenced with [their placeholders](https://plugins.auxilor.io/effects/configuring-an-effect#placeholders), +and are used in plugins like EcoSkills, EcoPets, EcoJobs (etc) for levelling. | ID | Description | Value Provided | |---------------------------------|-------------------------------------------------------------------------------------------------------------------|-----------------------------------------------| @@ -14,108 +15,108 @@ Triggered effects also produce a value, which is used in EcoPets for levelling. | `bite` | Triggered when a fish bites on your rod | 1 | | `block_item_drop` | Triggered when a mined block drops loot | The amount of items dropped | | `bow_attack` | Triggered when shooting an entity with a bow and arrow (or crossbow) | The damage dealt | +| `breed` | Triggered when breeding entities together | The experience received | +| `brew_ingredient` | Same as `brew`, but passes the ingredient as the item | 1 | +| `brew` | Triggered when brewing a potion in a brewing stand | 1 | +| `buy_item` | Triggered when buying an item in a shop **Requires EcoShop** | The price | | `cast_rod` | Triggered when casting a fishing line | 1 | | `catch_entity` | Triggered when hooking onto an entity with a fishing rod | 1 | -| `catch_fish` | Triggered when catching a fish | The experience dropped | | `catch_fish_fail` | Triggered when failing to catch a fish | 1 | -| `hook_in_ground` | Triggered when a fishing rod hook hits the ground | 1 | -| `reel_in` | Triggered when reeling in a fishing rod | 1 | +| `catch_fish` | Triggered when catching a fish | The experience dropped | +| `change_armor` | Triggered when changing armor | 1 | +| `change_world` | Triggered when changing world | 1 | +| `click_block` | Triggered when right-clicking on a block | 1 | +| `click_entity` | Triggered when right-clicking on an entity | 1 | +| `complete_advancement` | Triggered when completing an advancement | 1 | +| `complete_quest` | Triggered when completing a quest **Requires EcoQuests** | 1 | +| `complete_task` | Triggered when completing a task **Requires EcoQuests** | 1 | | `consume` | Triggered on item consumption | 1 | | `craft` | Triggered when crafting an item | 1 | | `damage_item` | Triggered when damaging an item | The damage | | `death` | Triggered on death from any sources | 1 | -| `enchant_item` | Triggered when enchanting an item | The xp cost | +| `disable` | Triggered when an item / enchant / etc disables | 1 | +| `drop_item` | Triggered when dropping an item | The amount of items | +| `empty_bucket` | Triggered when emptying a bucket | 1 | +| `enable` | Triggered when an item / enchant / etc enables | 1 | | `enchant_%type%` | Triggered when enchanting an item with a certain type of enchantment **Requires EcoEnchants** | The xp cost | +| `enchant_item` | Triggered when enchanting an item | The xp cost | +| `enter_bed` | Triggered when entering a bed | 1 | +| `enter_region` | Triggered when entering a region **Requires WorldGuard** | 1 | +| `entity_break_door` | Triggered when an entity breaks a door | 1 | +| `entity_catch_fire_from_block` | Triggered when an entity catches fire from a block | 1 | +| `entity_catch_fire_from_entity` | Triggered when an entity catches fire from an entity | 1 | +| `entity_damage_by_entity` | Triggered when an entity takes damage from another entity | The damage taken | +| `entity_damage` | Triggered when an entity takes damage | The damage taken | +| `entity_death` | Triggered when an entity takesdies | 1 | | `entity_item_drop` | Triggered when a killed entity drops loot | The amount of items dropped | +| `entity_spawn` | Triggered when an entity spawns | 1 | +| `entity_target` | Triggered when an entity targets another entity | 1 | +| `entity_teleport` | Triggered when an entity teleports | 1 | | `fall_damage` | Triggered when taking fall damage | The damage taken | +| `fill_bucket` | Triggered when filling a bucket | 1 | | `gain_hunger` | Triggered when gaining hunger points | The hunger gained | +| `gain_job_xp` | Triggered when gaining job experience points **Requires EcoJobs** | The experience gained | | `gain_pet_xp` | Triggered when gaining pet experience points **Requires EcoPets** | The experience gained | | `gain_skill_xp` | Triggered when gaining skill experience points **Requires EcoSkills** | The experience gained | +| `gain_task_xp` | Triggered when gaining task XP **Requires EcoQuests** | The experience gained | | `gain_xp` | Triggered when gaining experience points | The xp gained | +| `global_static_%interval%` | Run every x ticks for the server, eg `global_static_20` would run every second | 1 | +| `headshot` | Triggered when hitting an enemy with a projectile in the head | The damage dealt | | `heal` | Triggered when regaining health | The health regained | +| `hold_item` | Triggered when changing your held item | 1 | +| `hook_in_ground` | Triggered when a fishing rod hook hits the ground | 1 | | `item_break` | Triggered when breaking any item in your inventory (durability) | 1 | +| `jobs_level_up` | Triggered when levelling up a job **Requires Jobs Reborn** | The new level | +| `join_job` | Triggered when joining a job **Requires EcoJobs** | The job level | +| `join` | Triggered when joining the server | 1 | | `jump` | Triggered when Jumping (pressing space) | 1 | | `kill` | Triggered when a player kills a player or entity | The victim's max health | +| `leave_bed` | Triggered when leaving a bed | 1 | +| `leave_job` | Triggered when leaving a job **Requires EcoJobs** | The job level | +| `leave_region` | Triggered when leaving a region **Requires WorldGuard** | 1 | +| `leave` | Triggered when leaving the server | 1 | +| `left_click_npc` | Triggered when left-clicking an NPC **Requires Citizens** | 1 | +| `level_up_item` | Triggered when levelling up an item | The new item level | +| `level_up_job` | Triggered when levelling up a job **Requires EcoJobs** | The new level | | `level_up_pet` | Triggered when levelling up a pet **Requires EcoPets** | The new level | | `level_up_skill` | Triggered when levelling up **Requires EcoSkills** | The new level | +| `level_up_xp` | Triggered when levelling up XP | The new level | | `lose_hunger` | Triggered when losing hunger | The hunger lost | | `lose_potion_effect` | Triggered when losing a potion effect | 1 | | `melee_attack` | Triggered when injuring an entity with a melee attack | The damage dealt | -| `mine_block` | Triggered when mining a block | 1 | | `mine_block_progress` | Triggered when damaging a block | 1 | +| `mine_block` | Triggered when mining a block | 1 | | `move` | Triggered on all movement: looking around, walking | The distance moved | +| `pick_up_item` | Triggered when picking up an item | The amount of items | +| `place_block` | Triggered when placing a block | 1 | | `potion_effect` | Triggered when gaining a potion effect | 1 | | `projectile_hit` | Triggered when hitting a block or an entity with a projectile (arrow, trident, splash potion, egg, snowball) | 1 | | `projectile_launch` | Triggered when launching a projectile (arrow, trident, splash potion, egg, snowball) | 1 | +| `reel_in` | Triggered when reeling in a fishing rod | 1 | +| `regen_magic` | Triggered when regenerating magic **Requires EcoSkills** | 1 | +| `respawn` | Triggered when respawning | 1 | +| `right_click_npc` | Triggered when right-clicking an NPC **Requires Citizens** | 1 | +| `run_command` | Triggered when running a command | 1 | +| `scyther_auto_collect` | Triggered when autocollecting crops with a scyther hoe **Requires Scyther** | 1 | +| `scyther_auto_sell` | Triggered when autoselling crops with a scyther hoe **Requires Scyther** | 1 | +| `sell_item` | Triggered when selling an item in a shop | The price | +| `send_message` | Triggered when sending a message | 1 | +| `shear_entity` | Triggered when shearing an entity | 1 | | `shield_block` | Triggered when blocking an attack with a shield | The damage blocked | +| `shoot_bow` | Triggered when shooting a bow | The force the bow was shot at between 0 and 1 | +| `smelt` | Triggered when smelting an item in a furnace | The amount of items smelted | +| `smith_item` | Triggered when smithing an item in a smithing table | 1 | +| `start_quest` | Triggered when starting a quest **Requires EcoQuests** | 1 | | `static_%interval%` | Run every x ticks, eg `static_20` would run every second | 1 | -| `global_static_%interval%` | Run every x ticks for the server, eg `global_static_20` would run every second | 1 | | `swap_hands` | Triggered when swapping items in hands (F by default) | 1 | | `swing` | Triggered when swining an item, hand or weapon **Requires Paper** | 1 | | `take_damage` | Triggered when taking damage from any source | The damage taken | | `take_entity_damage` | Triggered when taking damage from an entity or player | The damage taken | +| `tame_animal` | Triggered when taming an animal | 1 | +| `teleport` | Triggered when teleporting | 1 | | `toggle_flight` | Triggered when chainging the flight state | 1 | | `toggle_sneak` | Triggered when chainging the sneak state | 1 | | `toggle_sprint` | Triggered when chainging the sprint state | 1 | | `trident_attack` | Triggered on injuring an entity with a thrown trident | The damage dealt | -| `win_raid` | Triggered when a player wins a raid | The level of bad omen | -| `jobs_level_up` | Triggered when levelling up a job **Requires Jobs Reborn** | The new level | -| `brew` | Triggered when brewing a potion in a brewing stand | 1 | -| `brew_ingredient` | Same as `brew`, but passes the ingredient as the item | 1 | -| `smelt` | Triggered when smelting an item in a furnace | The amount of items smelted | -| `place_block` | Triggered when placing a block | 1 | -| `level_up_job` | Triggered when levelling up a job **Requires EcoJobs** | The new level | -| `gain_job_xp` | Triggered when gaining job experience points **Requires EcoJobs** | The experience gained | -| `breed` | Triggered when breeding entities together | The experience received | -| `join_job` | Triggered when joining a job **Requires EcoJobs** | The job level | -| `leave_job` | Triggered when leaving a job **Requires EcoJobs** | The job level | -| `sell_item` | Triggered when selling an item in a shop | The price | -| `buy_item` | Triggered when buying an item in a shop **Requires EcoShop** | The price | -| `headshot` | Triggered when hitting an enemy with a projectile in the head | The damage dealt | -| `scyther_auto_collect` | Triggered when autocollecting crops with a scyther hoe **Requires Scyther** | 1 | -| `scyther_auto_sell` | Triggered when autoselling crops with a scyther hoe **Requires Scyther** | 1 | -| `join` | Triggered when joining the server | 1 | -| `leave` | Triggered when leaving the server | 1 | -| `respawn` | Triggered when respawning | 1 | -| `level_up_xp` | Triggered when levelling up XP | The new level | -| `change_world` | Triggered when changing world | 1 | -| `change_armor` | Triggered when changing armor | 1 | -| `hold_item` | Triggered when changing your held item | 1 | -| `send_message` | Triggered when sending a message | 1 | -| `pick_up_item` | Triggered when picking up an item | The amount of items | -| `drop_item` | Triggered when dropping an item | The amount of items | -| `entity_target` | Triggered when an entity targets another entity | 1 | -| `enter_bed` | Triggered when entering a bed | 1 | -| `leave_bed` | Triggered when leaving a bed | 1 | | `villager_trade` | Triggered when trading with a villager **Requires Paper** | The experience the villager gains | -| `fill_bucket` | Triggered when filling a bucket | 1 | -| `empty_bucket` | Triggered when emptying a bucket | 1 | -| `shear_entity` | Triggered when shearing an entity | 1 | -| `enable` | Triggered when an item / enchant / etc enables | 1 | -| `disable` | Triggered when an item / enchant / etc disables | 1 | -| `teleport` | Triggered when teleporting | 1 | -| `run_command` | Triggered when running a command | 1 | -| `click_entity` | Triggered when right-clicking on an entity | 1 | -| `click_block` | Triggered when right-clicking on a block | 1 | -| `enter_region` | Triggered when entering a region **Requires WorldGuard** | 1 | -| `leave_region` | Triggered when leaving a region **Requires WorldGuard** | 1 | -| `level_up_item` | Triggered when levelling up an item | The new item level | -| `tame_animal` | Triggered when taming an animal | 1 | -| `complete_quest` | Triggered when completing a quest **Requires EcoQuests** | 1 | -| `complete_task` | Triggered when completing a task **Requires EcoQuests** | 1 | -| `gain_task_xp` | Triggered when gaining task XP **Requires EcoQuests** | The experience gained | -| `start_quest` | Triggered when starting a quest **Requires EcoQuests** | 1 | -| `left_click_npc` | Triggered when left-clicking an NPC **Requires Citizens** | 1 | -| `right_click_npc` | Triggered when right-clicking an NPC **Requires Citizens** | 1 | -| `regen_magic` | Triggered when regenerating magic **Requires EcoSkills** | 1 | -| `shoot_bow` | Triggered when shooting a bow | The force the bow was shot at between 0 and 1 | -| `entity_break_door` | Triggered when an entity breaks a door | 1 | -| `entity_catch_fire_from_block` | Triggered when an entity catches fire from a block | 1 | -| `entity_catch_fire_from_entity` | Triggered when an entity catches fire from an entity | 1 | -| `entity_damage` | Triggered when an entity takes damage | The damage taken | -| `entity_damage_by_entity` | Triggered when an entity takes damage from another entity | The damage taken | -| `entity_death` | Triggered when an entity takesdies | 1 | -| `entity_spawn` | Triggered when an entity spawns | 1 | -| `entity_teleport` | Triggered when an entity teleports | 1 | -| `complete_advancement` | Triggered when completing an advancement | 1 | -| `smith_item` | Triggered when smithing an item in a smithing table | 1 | +| `win_raid` | Triggered when a player wins a raid | The level of bad omen | diff --git a/docs/effects/configuring-an-effect.md b/docs/effects/configuring-an-effect.md index 1fdc06c76e..061518292d 100644 --- a/docs/effects/configuring-an-effect.md +++ b/docs/effects/configuring-an-effect.md @@ -164,6 +164,22 @@ args: delay: 20 ``` +#### `repeat` + +Specify the effect to activate repeadetly. If the effect has a delay, it will delay between each repeat. +If the effect has any mutators, they will run again for each repeat. + +This provides new placeholders: `%repeat_times%`, `%repeat_start%`, `%repeat_increment%`, and `%repeat_count%`. + +```yaml +args: + repeat: + times: 5 # How many times the effect should be repeated + start: -10 # The initial value of the %repeat_count% placeholder + increment: 10 # How much the count should be increased (or decreased) by on each repeat + every: 3 +``` + #### `filters_before_mutation` By default, filters are ran after mutation - set this to true if filters should be ran on the un-mutated data. (defaults