# AdvancedPlugins Wiki Welcome! Here you can find information about Advanced Plugins.

**Sponsored by MintServers. AdvancedPlugins.net integration & auto updates. Unlimited RAM plan for only $9.99!**

# Config Items How items are configured in AdvancedPlugins All AdvancedPlugins use similar item configuration format. You can follow this guide to configure your items. ## Item Configuration ### **type** item's material ### **id** item's durability ### **amount** item's amount ### **name** item's custom name ### **lore** item's custom lore ### **item-flags** list of item flags applied to items ### **custom-model-data** item's custom model data for custom textures ### **armor-trim** set item's trim material and pattern (new in Minecraft 1.20) * format: `'MATERIAL;PATTERN'`, e.g. `QUARTZ;COAST` * Trim material: * Trim pattern: * **force-glow** set whether item should glow or not ### **enchantments** list of enchantments applied to item ### **custom-enchantments** list of custom enchantments \**present in AdvancedEnchantments only* ### **rgb-color** item's color (applyable for colored leather armor) ### **nbt** set item's custom nbt (json format) ### **owner** skull's owner. It can be player username or base64 ### **unbreakable** set item unbreakable (boolean - true/false) ### **itemsadder** use custom item from ItemsAdder plugin (item's name) ## Configuration Example ```yaml item: amount: 1 name: '&cCustom chestplate' lore: - '&dExclusive from &dVillagers' enchantments: - 'Protection:20' - 'Unbreaking:2' custom-enchantments: - 'glow:1' item-flags: - 'HIDE_ENCHANTS' custom-model-data: 1 armor-trim: 'DIAMOND;SILENCE' force-glow: false rgb-color: 255;0;0 owner: 40b7ff035bb8761eb40e86f3a17faee349dbcccd84a77703b47e9894a1df847f #base64 nbt: '{CanDestroy:["minecraft:diamond_ore"],CustomNBTData:"test:true"}' unbreakable: true itemsadder: 'lava_pickaxe' ```

# Colors Most of our plugins have HEX & gradient support in messages & UIs. ## Hex Format: `{#HEX}`\ Example: `{#FF0000}` ## Gradient Format: `text`\ Example: `Hello Advanced!` # Introduction New effects system that brings all our plugins into one. We have launched a new effects system to unify all of our plugins which use effects (Enchantments, Pets and Mobs) into one system working together. ## Explanation Abilities are a unique implementation of completely customizable abilities. Abilities can be a powerful tool for adding dynamic gameplay mechanics. By combining effects, triggers, targets, conditions and effects, you can create a wide variety of actions and reactions in your plugin. * [Effects](/abilities/effects) * [Triggers](/abilities/triggers) * [Targets](/abilities/targets) * [Conditions](/abilities/conditions) * [Functions](/abilities/functions) * [Variables](/abilities/variables) * [Pointers](/abilities/pointers) ### Examples ```yaml chance: 30 # Chance is optional, default is 100 cooldown: 5 # Cooldown is optional, default is 0 cooldownMessage: "&cThis ability is in cooldown!" # Optional cooldown message effects: - 'LIGHTNING @Victim' - 'FIREBALL @Victim' - 'MESSAGE:You have been &bfrozen! @NearestPlayer{r=3}' - 'FREEZE:10 @NearestPlayer{r=3}' ```

# Effects Effects are the actions that will be performed when an ability is activated. Examples of effects include damaging an entity, healing an entity, or teleporting an entity. There are many different types of effects available, each with their own unique properties and parameters. ## Effect examples ```yaml effects: - 'BURN:40' - 'MESSAGE:Hello,Hi,Greetings %victim name%!' ``` In this example, when the trigger occurs, the victim will be set on fire for 2 seconds, a random greeting will be sent to the victim with their name.

## Effect List There are many different types of effects that can be used in our ability system. Some of the effects available are:

Usage	Description
`ACTION_BAR:<TEXT>`	Send an actionbar message
`ADD_DURABILITY_CURRENT_ITEM:<AMOUNT>`	Modify durability of main item
`ADD_DURABILITY_ARMOR:<AMOUNT>`	Armor durability: `− = damage`, `+ = repair`. Ex: `ADD_DURABILITY_ARMOR:-10`
`ADD_DURABILITY_ITEM:<SLOT>:<AMOUNT>`	Repair item
`ADD_FLY_SPEED`	Adds to the player's fly speed (from -1 to 1)
`ADD_FOOD:<AMOUNT>`	Modify player's food level
`ADD_HEALTH:<HEALTH>`	Add health to entity
`ADD_MONEY:<AMOUNT>`	Add money to player account
`ADD_WALK_SPEED`	Adds to the player's walk speed (from -1 to 1)
`AIR:<AMOUNT>`	Modify player's remaining air
`AUTO_REEL`	Auto reel in fish from fishing rod (for BITE_HOOK trigger only)
`BLEED:<DAMAGE>:<TICKS>:<INTERVAL_TICKS>`	Steal entity bleed
`BLOOD`	Display blood effect
`BOOST:[DIRECTION]:[AMOUNT]`	Boost entity up in air
`BREAK_BLOCK`	Break block
`BREAK_TREE:[MAX_LOGS]:[MAX_LEAVES]`	Break a whole tree at once
`BURN:<SECONDS>`	Set an entity on fire
`CACTUS`	Display cactus effect
`CANCEL_EVENT`	Cancel Event, e.g. an attack
`CANCEL_USE:<MATERIAL>:<TICKS>`	Cancel use of a material, e.g. ENDER_PEARL
`CONSOLE_COMMAND:<COMMAND>`	Run command through console
`CURE:<POTION>`	Remove non-permanent potion effect
`CURE_PERMANENT:<POTION>`	Remove permanent potion effect
~~`DAMAGE_ARMOR`~~	Removed. Use ADD_DURABILITY_ARMOR effect
`DECREASE_DAMAGE:<AMOUNT>`	Decrease damage by percentage
`DISABLE_ACTIVATION:<NAME>:<SECONDS>`	Disable activation for seconds
`DISABLE_KNOCKBACK:<TICKS>`	Disable entity's knockback for time
`DISARM`	Disarm Entity
`DO_HARM:<HEALTH>`	Harm an entity by doing health damage. This does not ignore armor and dealt damage may be reduced depending on armor
`REMOVE_HEALTH:<HEALTH>`	Take entity's health away, ignores armor and does not play damage animation for player
`REMOVE_HEALTH_DAMAGE:<HEALTH>`	Take entity's health away, ignore armor play damage animation for player
`REMOVE_HEALTH_TOTEM`	Remove health from an entity while allowing the use of totem, "%e:<HEALTH>"
`REMOVE_HEALTH_DAMAGE_TOTEM`	Remove health from an entity with damage effect while allowing the use of totem, "%e:<HEALTH>"
`DOUBLE_DAMAGE`	Double damage
`DROP_HEAD`	Drop player or mob head
`EXP:<AMOUNT>`	Drop Experience Orbs
`EXPLODE:<POWER>:<FIRE (true/false)>:<BREAK BLOCKS (true/false>`	Create an explosion
`EXTINGUISH`	Extinguish an entity
`FIREBALL`	Shoot a fireball
`FIREWORK:[COLOR]:[FADE_COLOR]:[TYPE]:[POWER]:[TRAIL]:[FLICKER]`	Spawns a firework. Examples: `- FIREWORK:RED:ORANGE:BALL:1:true:true` `- FIREWORK:255,0,255:0,255,0:BURST:3:false:true`
`FLY:[TICKS]`	Toggle player's flight
`FLY_SPEED:<SPEED>`	Sets the player's fly speed (from -1 to 1)
`FREEZE:<TICKS>`	Freeze Entity
`GUARD:<ENTITY>:<SECONDS>:<AMOUNT>:<NAME>:<SWITCH_ROLES>`	Spawn a guard to protect an entity. Use baby version of supported mobs by adding `BABY_` prefix to the type, e.g. `BABY_ZOMBIE`. `SWITCH_ROLES` is used to anger the guard at the target instead of protecting him
`GIVE_ITEM:<MATERIAL>:[AMOUNT]`	Give items to user/location
`HALF_DAMAGE`	Half damage effect
`IGNORE_ARMOR_DAMAGE`	Cancel armor durability reduction
`IGNORE_ARMOR_PROTECTION`	Ignores armor damage reduction
`INCREASE_DAMAGE:<AMOUNT>`	Increase damage by percentage
`INVINCIBLE`	Toggle entity's invincibility
`KILL`	Kill an entity
`KEEP_ON_DEATH`	Keep item on death
`LIGHTNING:[BOOLEAN]`	Strike a lightning. Optional argument if true, will cause block damage and harm players around, if false, will only play a visual lightning effect. Default is true.
`MESSAGE:<TEXT>`	Send a message
`MORE_DROPS:<AMOUNT>`	Multiplies item drops by the value set in <AMOUNT>. We recommend that you set a whitelist for materials, otherwhise this will multiply all drops (e.g. diamond_block) Settings
`NEGATE_DAMAGE:<AMOUNT>`	Negate a specified amount of damage
`PARTICLE:<PARTICLE>:<AMOUNT>:<OFFSET>`	Play particles at a location ParticleEffectTypes
`PARTICLE_LINE:<PARTICLE>:<AMOUNT>:<POINTS>`	Play particles in straight line. Amount = number of particles in each point, Points = number of points between two locations that particles will be shown at.
`PERMISSION:<TEXT>`	Toggle player's permission
`PLANT_SEEDS:<RADIUS>:<SEEDS>`	Plant seeds in radius. Seed types: SEEDS, POTATO, MELON, PUMPKIN, CARROT, BEETROOT, NETHER_WART
`PLAYER_COMMAND:<COMMAND>`	Run command through player
`PLAY_SOUND:<SOUND>:[PITCH]:[VOLUME]`	Play sound for a specific player
`PLAY_SOUND_OUTLOUD:<SOUND>:[PITCH]:[VOLUME]`	Play sound at a location
`POTION:<POTION>:<LEVEL>:[TICKS]`	Add potion effect PotionEffectTypes
`POTION_OVERRIDE:<POTION>:<LEVEL>:[TICKS]`	Force-add potion effect
`PULL_AWAY:<DISTANCE>`	Pull away an entity
`PULL_CLOSER:<AMOUNT>`	Pull an entity closer
`PUMPKIN:<TICKS>`	Put a pumpkin on entity's head
`REMOVE_ARMOR:<ARMOR TYPE>`	Remove a specific armor piece
`REMOVE_RANDOM_ARMOR`	Remove a random armor piece
`REMOVE_MONEY:<AMOUNT>`	Remove money from player account
`REPAIR`	Repair item
`REVIVE`	Revive an entity
`SET_AIR:<AMOUNT>`	Set player's remaining air
`SET_BLOCK:<MATERIAL>`	Set block to a type
`SET_MAX_CATCH_TIME:<TICKS>`	Set max. Time for fishing
`SET_MIN_CATCH_TIME:<TICKS>`	Set min. Time for fishing
`SHUFFLE_HOTBAR`	Shuffle player's hotbar
`SMELT`	Smelt drops
`SNOWBLIND`	Cancel Event, e.g. an attack
`SPAWN_ARROWS`	Spawn flood of arrows from above
`SPAWN_BLOCKS:<MATERIAL>:<DAMAGE>`	Spawn falling blocks from above player and to cause damage
`STEAL_EXP:<AMOUNT>`	Steal EXP from one person for another
`STEAL_HEALTH:<HEALTH>`	Steal health from one entity for another
`STEAL_MONEY:<AMOUNT>`	Steal Money from one person for another
`STOP_KNOCKBACK`	Stop entity's knockback
`SUBTITLE:<TEXT>`	Send a subtitle
`TAKE_AWAY:<MATERIAL>:<AMOUNT>`	Take item away from player
`TELEPORT_BEHIND`	Teleport behind other entity
`TELEPORT`	Teleport to location
`TITLE:<TEXT>`	Send a title
`TNT:[DAMAGE]:[RADIUS]`	Create a TNT explosion
`TP_DROPS`	Teleport drops to inventory
`DELETE_ITEM:[amount]`	Delete x amount of current item from inventory
`SPAWN_ENTITY:<TYPE>`	Spawn an entity at a location (req. EntityType)
`PROJECTILE:<TYPE>`	Spawn a shooting projectile with velocity (req. EntityType Projectile)
`WEB_WALKER`	Walk fast through cobwebs
`LAVA_WALKER`	Walk on lava
`WATER_WALKER`	Walk on water
`WALK_SPEED:<SPEED>`	Sets the player's fly speed (from -1 to 1)
`OPEN_CRAFTING_TABLE`	Open a virtual crafting table
`OPEN_ENDERCHEST`	Open virtual enderchest
`DROP_HELD_ITEM`	Drop item in hand
`INVERT_VARIABLE:<NAME>`	Invert a custom variable's boolean.
`SET_VARIABLE:<NAME><VALUE>`	Create a custom variable globally, not per user. To create a variable that could be user for a user, you can include user's name in the variable's name, e.g. `customVar%attacker name%.` Read more here.
`SCREEN_FREEZE:<ticks>`	Slow player down and show freeze effect on player's screen for defined amount of ticks (1 second = 20 ticks!)
`WAIT:<ticks>`	Wait for the next effect to activate.

## Plugin-specific effects ### AdvancedEnchantments: | Usage | Description | | ----------------------------- | ------------------------- | | `ADD_ENCHANT::` | Add an enchant to item | | `REMOVE_ENCHANT:` | Remove enchant from item | | `ADD_SOULS:` | Add souls to an item | | `REMOVE_SOULS:` | Remove souls from an item | ### McMMO:

Usage	Description
`ADD_EXP_MCMMO:<SKILL>:<AMOUNT>`

	Add mcmmo skill experience

# Triggers Triggers are the events that will activate an ability. Examples of triggers include a player attacking another player, a mob taking damage, they can be environmental events, or a block being broken. Triggers can also have their own parameters, such as a specific type of damage or a certain block material. Triggers are events that activate abilities in the system. When a trigger occurs, the system checks for any abilities that are set to activate on that trigger and performs the corresponding effects.

### External Triggers Here are the external triggers, which depend on other plugins or systems to work

Name	Description	For plugin
CUSTOM_MOB_DEFENSE	Activates when a custom mob is hit	AdvancedMobs

### Internal Triggers Here is a list of all the default available triggers, along with a brief description of each: {% hint style="info" %} **MINING**, **ATTACK** and **ATTACK\_MOB** triggers do not work with off-hand items. {% endhint %}

Name	Description
ATTACK	Activates when a player/mob hits a player
ATTACK_MOB	Activates when a player/mob hits a mob
ARROW_HIT	Activates when an arrow hits an entity
BOW_FIRE	Activates when a bow is fired full power
BITE_HOOK	Activates when fish bites fishing hook (or item gets caught on it)
BREW_POTION	Activates when player brews a potion (variables: %potion type%, %is extended%, %is upgraded%)
CATCH_FISH	Activates when a player catches a fish (does not activate with entities)
COMMAND	Activates when player runs a command. Specify a command at the same block as chances, cooldowns are set, example here: `chance: 100` `cooldown: 0` `command: exampleCommand`
HOOK_ENTITY	Activates when player hooks an entity with a fishing rod
DEATH	Activates when a player or mob dies
DEFENSE	Activates when a player/mob is hit by a player
DEFENSE_MOB	Activates when a player/mob is hit by a mob
DEFENSE_MOB_PROJECTILE	Activates when a player/mob is hit by a projectile from a mob
DEFENSE_PROJECTILE	Activates when a player/mob is hit by a projectile from a player
EAT	Activates when a player eats
ELYTRA_FLY	Activates when an entity starts flying with an elytra
EXPLOSION	Activates when an entity takes explosion damage
FALL_DAMAGE	Activates when an entity takes fall damage
ELYTRA_FLY_DAMAGE	Activates when entity takes damage while flying with elytra
FIRE	Activates when an entity takes fire damage
HELD	Activates when player holds an item
ITEM_BREAK	Activates when a player breaks an item
JUMP	Activates when a player jumps
JOIN	Activates when any player joins (on all items)
QUIT	Activates when any player leaves (on all items)
KILL	Activates when any entity kills another entity
KILL_MOB	Activates when any entity kills a mob
KILL_PLAYER	Activates when any entity kills a player
MINING	Activates when a block is broken
PASSIVE_DEATH	Activates when an entity is struck by lightning
RIGHT_CLICK	Activates when a player right clicks blocks, air
RIGHT_CLICK_ENTITY	Activates when player right clicks entity
ROD_CAST	Activates when a player casts their fishing rod
SHOOT	Activates when a player/mob shoots a player
SHOOT_MOB	Activates when a player/mob shoots a mob
SWING	Activates when a player swings their held item
SHIELD_BLOCK	Activates when a player blocks with a shield
HORN	Activates when player blows a horn
EFFECT_STATIC	Activates when a player equips or unequips armor
REPEATING	Repeatingly activates effects. Must set `time`settings in the same block as effects list. If you don't wish the effect to apply immediately, you must set `instantApply` setting to `false` in the same block as effects list. That will respect the `time` setting for apply delay.

# Targets Targets are the entities or blocks that will be affected by an ability. Examples of targets include the player using the ability, the victim of an attack, or a block that has been broken. Here are some examples of targets: * `@Victim`: Applies the effect to the victim of an event (such as an attack). * `@Attacker`: Applies the effect to the attacker of an event (such as an attack). * `@Block`: Applies the effect to the block that was interacted with (such as right-clicking). * `@NearestPlayer{radius=0}`: Applies the effect to the nearest player within the specified radius. You can use multiple targets in a single effect, separated by a space. For example:\ `@Victim @Attacker` would apply the effect to both the victim and the attacker of an event. ### Target Configuration Targets can be configured with additional options. For example, you can use the `radius` option to specify the radius around a target to search for another target. Here's an example of a target configuration using the `radius` option: ```yaml effects: - 'MESSAGE:you are the nearest player! @NearestPlayer{radius=10}' ``` This would apply the effect to the nearest player within a radius of 10 blocks. ### Target Reference Table Here is a table of all available targets, along with their descriptions: | Name | Description | | --------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `@Victim` | Applies the effect to the victim of an event (such as an attack). | | `@Attacker` | Applies the effect to the attacker of an event (such as an attack). | | `@Self` | Applies the effect to main entity (who activated it) | | `@Block` | Applies the effect to the block that was interacted with (such as right-clicking). | | `@NearestPlayer{radius=0}` | Applies the effect to the nearest player within the specified radius. | | `@EyeHeight` | Applies the effect at entity's eye location | |

@Trench{radius=0}
@Trench{radiuscustom=0x0x0}

Applies effect in square (e.g. 3x3x3) size area (commonly used for Trench). Only odd numbers allowed (e.g. 3, 5, 7, 9 etc..)

Use {ignoretool=true} to allow trench with tools which are not allowed to break blocks with. E.g. shovel on cobblestone

| | `@Tunnel{radiuscustom=1x3x5,mode=UP}` | Applies effects in tunnels and staircases areas. Available Modes: `UP, DOWN, STRAIGHT, AUTO`. Works very similarly to the Trench target and shares the same arguments. | | `@BlockInDistance{distance=1}` | Gets block within distance (closest one or the furthest away location if no block is within distance) | | `@Veinmine{depth=75}` |

Vein mine blocks. You must define whitelist of materials in settings.whitelist in the same block as chance, cooldown, etc.. Example here.
Default depth is 75

| | `@Add{x=0.0,y=0.0,z=0.0}` | Add distance to main entity's location | | `@Aoe{radius=1,target=all}` |

Area of effect target. Radius is in what radius around a location entities are searched for. Targets are:
- ALL
- MOBS
- DAMAGEABLE (all entities that can damaged by user)
- UNDAMAGEABLE (all entities that can't be harmed by user, e.g. allies)
--------------------------------------------
You can also define a limit for number of entities affected adding option e.g. limit=1

| | `@EntityInSight{distance=20,angle=40,limit=5,target=ALL}` | Target entities in sight, specify max distance, limit of entities, targets and angle of vision for targeted entities. | | `@AllPlayers` | All players on the server | You can use aliases for parameters, which are more concise.

Name	Alias
ignoretool	it
radius	r
radiuscustom	rc
target	t
limit	p
distance	d
depth	dp
points	p
angle	a

# Conditions Learn how to activate abilities depending on set conditions. Conditions let you choose under what circumstances enchantment should be activated/stopped or chance of activation increased/decreased. ### **3 Conditions Elements** 1. Dynamic Variable ([Find all variables here](/abilities/conditions/conditions-variables)) 2. Expected result 3. Outcome ### How do Conditions work Conditions work by comparing dynamic variables with your expected result. If variable's result matches your result, then the outcome will be taken into consideration. ### Examples of Conditions Following condition will not activate effects if player's health is higher than 5 points (2.5 hearts): `%victim health% > 5 : %stop%`\ \| **Dynamic Variable** | **Expected Result** | **Outcome** | Next condition will only allow enchantment to work if player is in a world called `my_world`: `%player world% = my_world : %allow%` Final example is a bit more complex, it combines multiple conditions. If player's Y level is less than 30 and health is more than 5 hearts, it will increase chance of effects activating by 10: `%player y% < 30 && %player health% > 10 = : %chance%+10` ### Nested conditions Nested Conditions enhance the flexibility of enchantment conditions by allowing complex logical groupings. This feature introduces parentheses () to combine multiple checks, enabling more sophisticated decision-making. For example: `(%victim max health% > 20 AND %victim world% != dungeon) OR %victim world% = prison : %allow%` This condition will activate if either: the victim has over 20 health and is not in the dungeon world, or if the victim is in the prison world. Nested conditions support AND, OR operators, and can be used to create intricate, multi-layered logic for enchantment activation. # Conditions Variables Dynamic variables to be used in conditions and abilities. Conditions can be targeted against different entities. You can use **attacker** or **victim** instead of **player**, for example: `%player health%` -> `%victim health%`. ### List of built-in variables {% hint style="info" %} All variables can start with 'player', 'attacker', and 'victim'\ Example: '%victim is on fire%' {% endhint %} {% hint style="info" %} Parsing for attacker or victim works for placeholders from PlaceholderAPI as well.\ Example: "%victim checkitem\_getinfo:39\_mat:%" {% endhint %} #### Player only variables

Variable	Description
Variable	Description
%can break%	True if a player can break the block
%faction land%	Gets faction land player is in.
%food%	Food level of player
%is bleeding%	True if the player is bleeding via McMMO
%helmet%	Equipped Helmet
%chestplate%	Equipped Chestplate
%leggings%	Equipped Leggings
%boots%	Equipped Boots
%is blocking%	True if the player is blocking
%is flying%	True if the player is flying
%is sneaking%	True if the player is sneaking
%level of skill <skill>%	Level of a player's McMMO skill
%permissions%	All player's permissions
%is op%	True if player has OP

#### Global Variables | Variable | Description | | ------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | %block below% | Block type player/ mob is standing on | | %trigger type% | Type of trigger | | %combo% | Current combo | | %custom name% | Custom name of player/ mob | | %has enchantment in hand of \% | Whether player/ mob has an enchantment on the item in its main hand | | %has enchantment in hand of \ level \% | Whether player/ mob has an enchantment of a specific level on the item in its main hand | | %has enchantment in \ of \% | Whether player/ mob has an enchantment on the item in a specific armor slot | | %has potion effect \% |

Whether player/ mob has a potion effect
PotionEffectTypes

| | %item in hand level \% | Level of enchantment on item in main hand | | %health% | The health of player/ mob | | %health percentage% | Percentage of health left | | %is critical% | Whether attack was a critical hit | | %is gliding% | Whether player/ mob is gliding | | %is sprinting% | Whether player is sprinting | | %is crouching% | Whether player/ mob is crouching | | %is holding% | Type of item currently held by player/ mob | | %is hostile% | Whether mob is hostile | | %is damageable% | Whether the player/mob can be damaged | | %is on fire% | Whether player/ mob is on fire | | %is removal% | Whether effect is removal (EFFECT\_STATIC, HELD, SHIFT, SPRINT) | | %is under water% | Whether player/ mob is underwater | | %item slot% | Slot of item that triggered enchant | | %max health% | Maximum health of player/ mob | | %mob type% | Type of mob | | %name% | Name of player/ mob | | %nearby mobs% | Amount of mobs in a 10 block radius | | %offhand item% | Type of item currently held in offhand by player/ mob | | %players% | Amount of players in a 10 block radius | | %potion effect level \ \% | Whether player/ mob has a potion effect of a specifc level | | %time% | Time of the world | | %x% | X coordinate of player/ mob | | %y% | Y coordinate of player/ mob | | %z% | Z coordinate of player/ mob | | %x double% | More precise X coordinate of player/ mob | | %y double% | More precise Y coordinate of player/ mob | | %z double% | More precise Z coordinate of player/ mob | | %block tags% | Array of tags a target block has | | %is riding% | Whether player/mob is riding player/mob (or is a passenger) | | %passengers% | Passengers of the player/mob | | %yaw% | Yaw of the player/mob | | %pitch% | Pitch of the player/mob | #### Type-specific variables (global) | Variable | Description | Applicable Type(s) | | ---------------------- | -------------------------------------------------- | ------------------------------------------------------ | | %is headshot% | Whether an arrow/ trident hit was a headshot | BOW, BOW\_MOB, DEFENSE\_BOW, DEFENSE\_BOW\_MOB | | %force% | Force of bow when firing arrow | BOW\_FIRE | | %damaged from behind% | If victim was damaged from behind by enemy | DEFENSE, DEFENSE\_MOB, DEFENSE\_BOW, DEFENSE\_BOW\_MOB | | %projectile type% | Type of projectile ("arrow" or "trident") | BOW, BOW\_MOB, DEFENSE\_BOW, DEFENSE\_BOW\_MOB | | %exp% | Amount of EXP to give/ drop | CATCH\_FISH, FISHING, KILL\_MOB | | %caught% | Type of item player caught | CATCH\_FISH, FISHING | | %maximum durability% | Maximum durability of item | ITEM\_BREAK | | %block x% | X coordinate of block broken | MINING | | %block y% | Y coordinate of block broken | MINING | | %block z% | Z coordinate of block broken | MINING | | %block type% | Type of block | MINING, SWING | | %block type lowercase% | Type of block but all letters are lowercase | MINING | | %block drop type% | Type of item block will drop | MINING | | %is crop% | Whether broken block was a crop | MINING | | %is fully grown% | Whether broken crop was fully grown | MINING | | %block location% | Location of the block (used in location parameter) | MINING, SWING | | %damage% | Final damage | Any type triggered by damage or an attack | | %raw damage% | Damage before armor | Any type triggered by damage or an attack | | %damage cause% | Cause of damage | Any type triggered by damage or an attack | ### PlaceholderAPI support E.g: `%victim player_level% > 10 : %stop%`, `player_level` is a PlaceholderAPI placeholder `%player_level%`. You can use `%player %`, `%attacker %` or`%victim %` It's a must to remove percentage signs from PlaceholderAPI placeholders, more examples: `%server_online% -> server_online` -> `%player server_online% > 5 : %allow%` # Condition Comparison Available methods of comparing between variables and your expected result:

Comparison	Explanation	Example
=	Equals to	%player world% = world
<	Less than	%player y% < 20
<=	Less than or equals to	%player y% <= 22
>	More than	%player y% > 20
>=	More than or equals to	%player y% >= 20
contains	Variable contains string	%player world% contains nether
matchesregex	Variable matches RegEx	%player name% matchesregex `^.\w+` (name starts with a dot)

# Condition outcome | Outcome | Description | | ---------- | ----------------------------------------------------------- | | %force% | Force ability to activate, ignoring cooldown and chacnes | | %allow% | Allow ability to activate, not ignoring cooldown or chances | | %continue% | Continue to next condition | | %stop% | Stop ability's activation | | %chance%+x | Add chance to ability's activation (e.g. `%chance%+5`) | | %chance%-5 | Remove chance from ability's activation | # Multiple Conditions You can make multiple condition lines, and have different comparisons and outcomes for each one.\ Example: ```yaml conditions: - '%attacker health% <= 5 : %allow%' - '%victim health% >= 15 : %allow%' effects: - 'INCREASE_DAMAGE:100' ``` You can make conditions even more advanced by having multiple different types of conditions on one line.\ Use `&&` to make combine two conditions on one line and require both of them to be fit the comparison for your outcome to happen.\ Additionally, you can use `OR` to make at least one of these conditions fit for it to parse.\ Examples:

conditions:
  - '%attacker health% <= 5 && %victim health% >= 15 : %allow%'
effects:
  - 'INCREASE_DAMAGE:100'

```yaml conditions: - '%mob type% = RAVAGER OR %mob type% = POLAR_BEAR : %allow%' effects: - 'INCREASE_DAMAGE:5-15 %attacker%' ``` You can have up to as many of these in a line as you want, for example: ```yaml conditions: - '%mob type% = SKELETON : %allow% OR %mob type% = ZOMBIE : %allow% OR %mob type% = ZOMBIE_VILLAGER : %allow% OR %mob type% = WITHER : %allow% OR %mob type% = WITHER_SKELETON : %allow% OR %mob type% = ZOMBIFIED_PIGLIN : %allow% OR %mob type% = SKELETON_HORSE : %allow% OR %mob type% = ZOMBIE_HORSE : %allow% OR %mob type% = STRAY : %allow% OR %mob type% = HUSK : %allow% OR %mob type% = PHANTOM : %allow% OR %mob type% = DROWNED : %allow% OR %mob type% = ZOGLIN : %allow% effects: - 'ADD_HARM:

%level%*1.5

%victim%' ``` # Settings Settings are values you can set for each ability. Be it world whitelist, whitelist/blacklist for materials and more. ## Examples Example for ability to Veinmine blocks {% code lineNumbers="true" fullWidth="false" %} ```yaml levels: '1': chance: 15 cooldown: 4 settings: whitelist: - "COAL_ORE" - "COPPER_ORE" - "IRON_ORE" - "GOLD_ORE" - "LAPIS_ORE" - "REDSTONE_ORE" - "DIAMOND_ORE" - "EMERALD_ORE" - "NETHER_QUARTZ_ORE" - "NETHER_GOLD_ORE" - "ANCIENT_DEBRIS" - "DEEPSLATE_COAL_ORE" - "DEEPSLATE_COPPER_ORE" - "DEEPSLATE_IRON_ORE" - "DEEPSLATE_GOLD_ORE" - "DEEPSLATE_LAPIS_ORE" - "DEEPSLATE_REDSTONE_ORE" - "DEEPSLATE_DIAMOND_ORE" - "DEEPSLATE_EMERALD_ORE" effects: - 'BREAK_BLOCK @Veinmine' ``` {% endcode %} ## Important for AdvancedEnchantments Settings must be set for each level, not for whole enchant. ## Setting reference table | Setting | Description | | -------------- | ------------------------------------------------------------------------------------ | | worldBlacklist | List of worlds where this ability is blacklisted and won't activate. Case sensitive. | | blacklist | Material blacklist (works with certain effects only) | | whitelist | Material whitelist(works with certain effects only) | # Functions Functions are tags which can be used in effect lines to make them more dynamic. They are written in `<>` brackets and are used instead of a value for the effect. Here is a list of available functions: ### `` Sets a chance for this effect line to activate. The number inside the brackets is the percentage chance of the effect activating. Example: ```yaml effects: - 'INCREASE_DAMAGE:5 50' ``` This will cause the entity to take 5% more damage 50% of the time. ### `` Use in-line conditions for effects. Extremely handly to create dynamic mechanics. Example: ```yaml effects: - 'ADD_HEALTH:5 %victim health% < 10 : %allow%' ``` This would add 2.5 hearts to victim's health if they had less than 5 hearts remaining. ### `

`

Performs a math operation using variables or numbers. The operation is written inside the brackets.

Example:

```yaml
effects:
- 'EXP: %exp% * 2'
```

This will drop double the amount of experience from event.

### ` `

Picks a random number between two values. The values are written inside the brackets and separated by a dash `-`.

Example:

```yaml
effects:
- 'INCREASE_DAMAGE: 1-5'
```

This will increase the damage to a random amount between 1 and 5.

### ` `

Picks a random word from a list. The words are written inside the brackets and separated by a comma `,`.

Example:

```yaml
effects:
- 'MESSAGE: Hello,Goodbye,Hi'
```

This will send a message with a random word from the list.

### ` `

Rounds a number to the nearest whole number. The number is written inside the brackets.

Example:

```yaml
effects:
- 'EXP: %exp% * 2.5'
```

This will give the entity an amount of experience that is 2.5 times their current amount, rounded to the nearest whole number.

### **` `**

Converts a floating-point number to an integer by removing any fractional parts. The number to be converted is written inside the brackets.

**Example:**

`effects:`

* `'EXP: %exp% * 1.5'`

In this example, if the entity has an experience value (`%exp%`), multiplying it by 1.5 might result in a floating-point number. The ` ` tags ensure that the final experience value given to the entity is an integer by removing any decimals.

### **` `**

Randomly rearranges the characters within the text placed inside the brackets. This can be used to create scrambled text effects.

**Example:**

`effects:`

* `'Message: Welcome!'`

In this example, the text "Welcome" will be scrambled into a random arrangement, such as "cme!lWe!" (Note: The actual scrambled output will vary each time it's generated.)


# Scripting

Learn how to script with Abilities

With new abilities v2, we've added scripting support for effects. Variables are are reset with server restarts.

## `SET_VARIABLE: `

Create a custom variable globally, not per user. To create a variable that could be user for a user, you can include user's name in the variable's name, e.g. `customVar%attacker name%`

## `INVERT_VARIABLE: `

Invert a custom variable's boolean. If no variable was set before, it will default to `false`

## Use variable in effects and conditions

Due to nature of these variables and naming, you can create global or per-player variables. To use them in effects and conditions, add a `%custom_` prefix and then name your variable.

### Global variables

E.g. if we create a variable:

```yaml
SET_VARIABLE:myVariable:awesome
```

We can use this variable in effects later like this:

```
MESSAGE:You are %custom_myVariable%
```

This would send a message to the player `You are awesome`.

### Per-player variables

Creating per-player variables is still as simple and easy! Just include the player name variable inside the variable's name, e.g.:

```
SET_VARIABLE:customValue%attacker name%:50
```

Then later we can retrieve it in a message like this as well:

```
MESSAGE:I have %custom_customValue%attacker name%% dollars
```

This would message `I have 50 dollars`

### Conditions

It works the same, but an example would be:

```
conditions:
  - '%custom_customValue%attacker name%% = 50 %allow%'
```

### Null / Unitialized variables

If an attempt is made to retrieve a variable which doesn't exist, default value will be `0`

## Examples

In this example, we use RIGHT\_CLICK trigger to count how many times user right clicks. If they click more than 5 times, they will not be able to activate the message again.

{% code lineNumbers="true" %}

```yaml
RIGHT_CLICK:
  conditions:
    - '%custom_nameof%attacker name%% = 5 : %stop%'
  effects:
    - 'SET_VARIABLE:clicks%attacker name%: %custom_clicks%attacker name%%+1'
    - 'MESSAGE:You clicked %custom_clicks%attacker name%% times'
```

{% endcode %}


# Variables

Variables are placeholders for dynamic data in Ability configurations. They allow for more flexibility and customization in Abilities.

### Usage

To use a variable, simply include it in an Ability configuration with the `%` symbol surrounding it. For example:

```yaml
effects:
- "MESSAGE: The attacker's name is %attacker name%"
```

### Available Variables

| VARIABLE                                      | DESCRIPTION                                                                                                                                             |
| --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `%attacker name%`                             | The name of the entity that initiated an Ability.                                                                                                       |
| `%victim name%`                               | The name of the entity that was targeted by an Ability.                                                                                                 |
| `%block type%`                                | The type of the block that was targeted by an Ability.                                                                                                  |
| `%system time%`                               | The current system time, in milliseconds.                                                                                                               |
| `%exp%`                                       | Amount of exp that was dropped in trigger event                                                                                                         |
| `%player name%`                               | Main entity's name                                                                                                                                      |
| `%damage%`                                    | Damage dealt (after armor etc)                                                                                                                          |
| `%raw damage%`                                | Raw damage dealt (before armor etc)                                                                                                                     |
| `%damage cause%`                              | Cause of damage                                                                                                                                         |
| `%random%`                                    | Last \ number                                                                                                                                   |
| `%is removed%`                                | Whether the effect is being removed. Is used mostly on triggers like EFFECT\_STATIC, HELD etc.                                                          |
| `%client version%`                            | Returns client's protocol version. Find all versions here: |
| `%potion type%, %is extended%, %is upgraded%` | From BREW\_POTION trigger, passes data on potion. Potion types: |
| `%block is interactable%`                     | Whether the block is interactable or not from [bukkit api](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/block/BlockType.html#isInteractable\(\)) |

## Plugin-specific variables:

### AdvancedEnchantments:

| VARIABLE          | DESCRIPTION             |
| ----------------- | ----------------------- |
| `%level%`         | Level of enchantment    |
| `%souls on item%` | Amount of souls in item |


# Pointers

**Pointers** are a new mechanic introduced in AdvancedEnchantments to specify the event or situation under which an effect is activated or applied. They are concise, easy to read, and help in providing context to the enchantment effects.

{% hint style="info" %}
Pointers will still obey triggers set by your ability. Meaning you cannot add additional triggers to your abilities with just pointers.
{% endhint %}

### Overview

A pointer is a short string prefixed by `~`. It indicates when an effect should be activated. For instance, `~ATTACK` signifies the effect is activated during an attack. Negative pointers, prefixed by `~!`, indicate when an effect should NOT be activated. For example, `~!ATTACK` implies the effect is not to be activated during an attack.

### Usage

To use a pointer, append it to the effect line in the enchantment definition. Here are some examples:

```graphql
DECREASE_DAMAGE:40 @Attacker ~DEFENSE
```

Multiple pointers can be combined for more complex conditions:

```graphql
EFFECT_NAME ~ATTACK ~!DEFENSE
```

This would mean the effect is activated during an attack but not during defense.

### Conclusion

Pointers provide a powerful and flexible way to specify the context under which enchantment effects are activated. They streamline enchantment definitions and make them more readable and intuitive for users. By adopting pointers, enchantment designers have a more granular control over when and how their effects are triggered.


# Skills

Coming soon.

Set up pre-made skills to be used in effects, instead of having to declare each time. They will have dynamic variables and could be used like this:

{% code lineNumbers="true" %}

```yaml
effects:
  - 'SKILL:extremeDamage[damage=2]'
```

{% endcode %}

And in skills.yml file, you would be define a skill like this:

skills:
  extremeDamage:
    effects:
    - 'DO_HARM:[damage] @Victim'
    - 'LIGHTNING @Victim'
    - 'MESSAGE:&cYou were hit with &lextreme damage&c! @Victim'

# Install Custom UIs A detailed step-by-step guide on how to install custom UIs made for our plugins with ItemsAdder or Oraxen. You must have [**ItemsAdder**](https://www.spigotmc.org/resources/%E2%9C%A8itemsadder%E2%AD%90emotes-mobs-items-armors-hud-gui-emojis-blocks-wings-hats-liquids.73355/) **or** [**Oraxen** ](https://www.spigotmc.org/resources/%E2%98%84%EF%B8%8F-oraxen-custom-items-blocks-emotes-furniture-resourcepack-and-gui-1-18-1-21-4.72448/)installed and working properly before proceeding with these steps. ## Available UIs Currently, 4 UI packs are available for our plugins:


Immersive BattlePass UI	Immersive new drag & drop UI graphics solution for BattlePass plugin	/files/wA83DXQUF74vK051KB2C	https://advancedplugins.net/item/110
AdvancedEnchantments UI	Amaze and surprise your server players with new immersive experience	/files/YpaBjqqtf89I7nagiQkH	https://advancedplugins.net/item/AdvancedEnchantments-UI.123
AdvancedPets UI	Complete the full unique experience of custom pets with this immersive UI upgrade	/files/3aXleo64ZRuC0bwl3hYb	https://advancedplugins.net/item/AdvancedPets-UI.137
AdvancedJobs UI	Improve your players' experience with the new ultimate AdvancedJobs UI	/files/lhjD0MDfqJ7jeg5RlSJl	https://advancedplugins.net/item/AdvancedJobs-UI.189

## Video Guide We now have a YouTube video guide available on installing our UIs using ItemsAdder and Oraxen: {% embed url="" %} Using timestamps navigate between ItemsAdder (starts 0:27s) and Oraxen installations (Oraxen starts 2:25s). The process explained in this video is the same for all UIs we have and you can follow this guide to install UIs with any of our offered packs. ## Text Guide ### For ItemsAdder 1. Copy the "ItemsAdder" folder from the Configurations folder into the "plugins" folder of your server. 2. In-game, run the "/iareload" and "/iazip" commands. 3. Open "\ Config (For ItemsAdder)" in the downloaded file *(E.g. "BattlePass Config (for ItemsAdder")* 4. Replace all contents of the Plugin's folder with the contents of the "\ Config (For ItemsAdder)" folder. 5. Restart your server ### For Oraxen 1. Copy the "Oraxen" folder from the Configurations folder into the "plugins" folder of your server. 2. In-game, run the "/oraxen reload all" command 3. Open "\ Config (For Oraxen)" in the downloaded file *(E.g. "BattlePass Config (for* Oraxen\_")\_ 4. Replace all contents of the Plugin's folder with the contents of the "\ Config (For Oraxen)" folder. 5. Restart your server ## Common Problems

Help! My plugin GUI is full of gold nuggets

You have not installed or loaded the texture pack correctly yet! Make sure you added files in the ItemsAdder/Oraxen folder, then:\ \- For ItemsAdder run /iareload and /iazip commands\ \- For **Oraxen** run /oraxen reload all\ Restart your server and the UIs will be installed!

My GUI is offset

If your GUI is offset like this and you are using Oraxen, you have not installed `glyphs` file's `shifts.yml` file correctly. Make sure you go into `/plugins/Oraxen/glyphs` and install the shifts.yml file from the pack. Make sure it overrides the file, as sometimes that is the problem. Afterwards restart.

I can't get it to work at all

# Introduction Actions power some of our plugins. Like Abilities system, actions are based on triggers. Actions are mostly based on simplier triggers, with simplified conditions. Focus is on more external plugin hooks as well as Minecraft vanilla triggers. ## Used for our plugins, such as: #### BattlePass: #### AdvancedJobs:

# Actions

## Internal Action Types (36) * [**block-break**](#block-break) - Break backs * [**block-place** ](#block-place)- Place blocks * [**bucket-place**](#bucket-place) - Place bucket * [**chat** ](#chat)- Say something in chat * [**chat-stripped**](#chat-stripped) - Saying something in chat but stripped of colour codes *(since v3.0.6)* * [**right-click**](#right-click) - Right-click anything * [**left-click**](#left-click) - Left click anything * [**right-click-block** ](#right-click-block)- Right click a block * [**left-click-block**](#left-click-block) - Left click a block * [**consume**](#consume) - Consume a consumable * [**craft**](#craft) - Craft items * [**smith**](#smith) - Smith items * [**damage-player**](#damage-player) - Deal damage to players * [**enchant**](#enchant) - Enchant an item using an enchant table * [**enchant-anvil**](#enchant-anvil) - Enchant an item using an anvil *(since v3.10)* * [**enchant-all**](#enchant-all) - Enchant an item using an enchantment table OR anvil *(since v3.10)* * [**execute-command**](#execute-command) - Execute a command in chat * [**fish**](#fish) - Fishing * [**gain-experience** ](#gain-experience)- Gain experience * [**item-break**](#item-break) - Have an item break e.g pickaxe, sword * [**fly** ](#fly)- Fly * [**glide** ](#glide)- Glide * [**sneak** ](#sneak)- Sneaking (Shifting) * [**sprint** ](#sprint)- Sprinting * [**swim** ](#swim)- Swimming * [**move** ](#move)- Whenever you move a block regardless of how * [**kill-mob**](#kill-mob) - Kill mobs (Use `advancedspawners_kill` for AdvancedSpawners mobs) * [**kill-player**](#kill-player) - Kill players * [**login** ](#login)**- Login** * [**milk** ](#milk)- Milk a cow * [**playtime** ](#playtime)- Time played measured in seconds. Must enable in `settings.yml`. *(since v3.10)* * [**throw-projectile**](#throw-projectile) - When a player throws any projectile (egg, snowball, etc..). *(since v3.10)* * [**regenerate** ](#regenerate)- Regenerate health * [**ride-mob**](#ride-mob) - Ride a mob * [**shear**](#shear)- Shear a sheep * [**smelt** ](#smelt)- Smelt an item in a furnace * [**tame** ](#tame)- Tame a pet (Ocelot/Wolf) * [**honey-extract**](#honey-extract) - Extract honey * [**honey-comb-extract**](#honey-comb-extract) - Extract honey comb with shears * [**breed**](#breed) - Breed an entity * [**brew**](#brew) - Brew a potion ## External Action Type (100+) * **AdvancedSpawners (**[**https://advancedplugins.net/item/2**](https://advancedplugins.net/item/2)**)** * [**advancedspawners\_kill** ](https://as.advancedplugins.net/)- Killing custom mobs * **McMMO** (New) * [**mcmmo\_gain\_exp**](#mcmmo-mcmmo_gain_exp) - Gain experience in skill * [**mcmmo\_level\_up\_skill**](#mcmmo-mcmmo_level_up_skill) - Level up an mcmmo skill * [**mcmmo\_level\_total\_skill**](#mcmmo-mcmmo_level_total_skill) - Level up an mcmmo skill (returns total level of skill) * **MBedWars** * [**mbedwars\_break\_bed**](#mbedwars_break_bed) - When bed is broken * [**mbedwars\_kill**](#mbedwars_kill) - When kill is achieved * [**mbedwars\_stat\_change** ](#mbedwars_stat_change)- Stat changes * [**mbedwars\_buy\_item** ](#mbedwars_buy_item)- When item is bought * [**mbedwars\_join\_arena**](#mbedwars_join_arena) - When an arena is joined * [**mbedwars\_team\_eliminate** ](#mbedwars_team_eliminate)- When a teammate is eliminated * **ChestShop** * [**chestshop\_create**](#chestshop-chestshop_create) - Placing/creating a chest shop. * [**chestshop\_buy**](#chestshop-chestshop_buy) - Buying items from a player's chest shop. * [**chestshop\_sell**](#chestshop-chestshop_sell) - Selling items to another player via a chest shop. * [**chestshop\_spend**](#chestshop-chestshop_spend) - Spending money at a chest shop. * [**chestshop\_profit**](https://app.gitbook.com/s/-MVKgJtPKw7gQhR_Osin/features/s#chestshop---chestshop_profit) - Making money from a chest shop. * **chestshop\_destroy** - Destroying a chest shop. * **AdvancedEnchantments** * [**advancedenchantments\_enchant**](#advancedenchantments-advancedenchantments_enchant) - Adding a custom enchant to an item. * **ASkyBlock** * [**askyblock\_create\_island**](#askyblock-askyblock_create_island) - Creating an island. * [**askyblock\_create\_warp**](#askyblock-askyblock_create_warp) - When a player creates a warp. * **AuctionHouse by Kludge** * [**auctionhouse\_kludge\_list**](#auctionhouse-by-kludgemonkey-auctionhouse_list) - Listing an item on the auction house. * [**auctionhouse\_kludge\_list\_singular**](#auctionhouse-by-kludgemonkey-auctionhouse_list_singular) - Listing an item on the auction house. * [**auctionhouse\_kludge\_buy**](https://github.com/AdvancedPlugins/Wiki/blob/main/AdvancedPluginsWiki/actions/broken-reference/README.md) - Buying an item from the auction house. * [**auctionhouse\_kludge\_buy\_singular**](https://github.com/AdvancedPlugins/Wiki/blob/main/AdvancedPluginsWiki/actions/broken-reference/README.md) - Buying an item from the auction house. * [**auctionhouse\_kludge\_sell**](https://github.com/AdvancedPlugins/Wiki/blob/main/AdvancedPluginsWiki/actions/broken-reference/README.md) - Successfully selling an item on the auction house. * [**auctionhouse\_kludge\_sell\_singular**](https://github.com/AdvancedPlugins/Wiki/blob/main/AdvancedPluginsWiki/actions/broken-reference/README.md) - Successfully selling an item on the auction house. * [**auctionhouse\_kludge\_profit**](https://github.com/AdvancedPlugins/Wiki/blob/main/AdvancedPluginsWiki/actions/broken-reference/README.md) - Making x money from selling. * [**auctionhouse\_kludge\_spend**](https://github.com/AdvancedPlugins/Wiki/blob/main/AdvancedPluginsWiki/actions/broken-reference/README.md) - Spending x money on the auction house. * **AutoSell** * [**autosell\_break**](#autosell-autosell_break) - Alternative to block\_break when autosell is applied (autosell breaks the normal action). * **BedWars1058** * [**bedwars1058\_break\_beds**](#bedwars1058-bedwars1058_break_beds) - Breaking the beds of other teams. * [**bedwars1058\_kill\_players**](#bedwars1058-bedwars1058_kill_players) - Killing opponents. * **bedwars1058\_play\_games** - Playing BedWars games. * [**bedwars1058\_buy\_items**](#bedwars1058-bedwars1058_buy_items) - Buying items from the shop. * [**bedwars1058\_buy\_upgrades**](#bedwars1058-bedwars1058_buy_upgrades) - Buying team upgrades from the shop. * **Benzimmer's KOTH** * [**koth\_capture**](#benzimmers-koth-koth_capture) - Capture for X seconds (time in seconds is progress). * [**koth\_win\_cap**](#benzimmers-koth-koth_win_cap) - Win the capture of a point. * [**BuildBattle by Tigerpanzer**](https://www.spigotmc.org/resources/44703/) * [**buildbattle\_join**](#buildbattle-by-tiger-buildbattle_join) - Join a game. * [**buildbattle\_play**](#buildbattle-by-tiger-buildbattle_play) - Triggered for every player when a game starts. * [**buildbattle\_finish**](#buildbattle-by-tiger-buildbattle_play) - Triggered for every player when a game finishes. * **ChatReaction** * [**chatreaction\_win**](#chatreaction-chatreaction_win) - Winning chat reaction games (repeat/unscramble). * **Citizens** * [**citizens\_click**](#citizens-citizens_click) - Clicking a citizens NPC. * [**citizens\_damage**](#citizens-citizens_damage) - Damaging a citizens NPC. * [**citizens\_kill**](#citizens-citizens_kill) - Killing a citizens NPC. * **Clans** * [**clans\_create**](#clans-clans_create) - Creating a clan. * [**clans\_join**](#clans-clans_join) - Joining a clan.. * **ClueScrolls** * [**cluescrolls\_complete\_clue**](https://app.gitbook.com/s/-MVKgJtPKw7gQhR_Osin/features/cluescrolls---cluescrolls_complete_clue) - Complete a clue. * [**cluescrolls\_complete\_scroll**](https://app.gitbook.com/s/-MVKgJtPKw7gQhR_Osin/features/cluescrolls---cluescrolls_complete_scroll) - Complete a scroll. * **CrateReloaded** * [**cratereloaded\_open**](#cratereloaded-cratereloaded_open) - Opening a crate. * **CratesPlus** * [**cratesplus\_open**](#cratesplus-cratesplus_open) - Opening a crate. * **CrazyCrates** * [**crazycrates\_open**](#crazycrates-crazycrates_open) - Opening a crate. * **CrazyEnvoy** * [**crazyenvoy\_open\_envoy**](#crazyenvoy-crazyenvoy_open_envoy) - Opening an envoy crate/drop. * [**crazyenvoy\_use\_flare**](#crazyenvoy-crazyenvoy_use_flare) - Using a flare to start an envoy. * **DiscordMinecraft** * [**discordminecraft\_link**](#discordminecraft-discordminecraft_link-probably-broken) - Link your Discord account to Minecraft. * **ExcellentCrates** * [**excellentcrates\_open**](#excellentcrates-excellentcrates_open) - Opening a crate. * **FactionsUUID** * [~~**factionsuuid\_kill\_enemy**~~](https://github.com/AdvancedPlugins/Wiki/blob/main/AdvancedPluginsWiki/actions/broken-reference/README.md) - **Disabled due to name issues** * **Jobs** * [**jobs\_join**](#jobs-jobs_join) - Joining a job. * [**jobs\_gain\_exp**](#jobs-jobs_gain_exp) - Gaining experience from working. * [**jobs\_level\_up**](#jobs-jobs_level_up) - Leveling up. * **Lands** * [**lands\_join**](#lands-lands_join) - Join a land. * [**lands\_leave**](#lands-lands_leave) - Leave a land. * [**lands\_create**](#lands-lands_create) - Create a land. * [**lands\_disband**](#lands-lands_disband) - Disband a land. * [**lands\_invited**](#lands-lands_invited) - Be invited to a land. * [**lands\_claim\_chunk**](#lands-lands_claim_chunk) - Claim a chunk for your land. * **LobbyPresents** * [**lobbypresents\_find**](#lobbypresents-by-poompk-lobbypresents_find) - Find a lobby present. * **MoneyHunters** * [**moneyhunters\_level\_up**](#moneyhunters-moneyhunters_level_up) - Leveling up. * [**moneyhunters\_gain\_exp**](#moneyhunters-moneyhunters_gain_exp) - Gaining experience from working. * **MythicMobs** * [**mythicmobs\_kill\_mob**](#mythicmobs-mythicmobs_kill_mob) - Killing a MythicMobs mob. * MMOCore * mmocore\_level\_up\_skill - Level up a skill * mmocore\_gain\_exp - Gain exp from a skill * **PlaceholderAPI** * [**placeholderapi\_match\_placeholder**](/actions/placeholderapi-actions) - Value must match the variable * [**placeholderapi\_integer\_placeholder**](/actions/placeholderapi-actions) - Placeholder will be set to progress. * **PlotSquared** * [**plotsquared\_claim**](#plotsquared-plotsquared_claim) - Claim a PlotSquared plot. * [**plotsquared\_visit**](#plotsquared-plotsquared_visit) - Visit a player's plot. * [**plotsquared\_trust\_player**](#plotsquared-plotsquared_trust_player) - Trust another player. * [**plotsquared\_become\_trusted**](#plotsquared-plotsquared_become_trusted) - Become a trusted player (must be online). * [**plotsquared\_rate**](#plotsquared-plotsquared_rate) - Rate a player's plot. * [**plotsquared\_teleport**](#plotsquared-plotsquared_teleport) - Teleport to a player's plot. * **ProCosmetics** * [**procosmetics\_spend**](https://app.gitbook.com/s/-MVKgJtPKw7gQhR_Osin/features/procosmetics---procosmetics_spend) - Spend X amount on cosmetics. * [**procosmetics\_buy\_treasure**](#procosmetics-procosmetics_buy_treasure) - Buying treasures from ProCosmetics. * [**procosmetics\_open\_treasure**](#procosmetics-procosmetics_open_treasure) - Opening treasures from ProCosmetics. * [**procosmetics\_buy\_cosmetic**](#procosmetics-procosmetics_buy_cosmetic) - Buying cosmetics from ProCosmetics. * **ShopGui+** * [**shopguiplus\_buy**](#shopguiplus-shopguiplus_buy) - When you purchase an item from the shop. The progress will be the amount purchased. * [**shopguiplus\_buy\_singular**](#shopguiplus-shopguiplus_buy_singular) - When you purchase an item from the shop. The progress will always be 1 per transaction. * [**shopguiplus\_spend**](#shopguiplus-shopguiplus_spend) - When you purchase an item from the shop. The progress will be however much it cost the player. * [**shopguiplus\_sell**](#shopguiplus-shopguiplus_sell) - When you sell an item to the shop. The progress will be the amount sold. * [**shopguiplus\_sell\_singular**](#shopguiplus-shopguiplus_sell_singular) - When you sell an item to the shop. The progress will always be 1 per transaction. * [**shopguiplus\_profit**](#shopguiplus-shopguiplus_profit) - When you sell an item to the shop. The progress will be however much the player gained. * **EconomyShopGUI** * [**economyshopgui\_buy**](#economyshopgui_buy) - When you purhcase an item from shop * [**economyshopgui\_sell**](#economyshopgui_sell) - When you sell an item in shop * **Shopkeepers** * [**shopkeepers\_trade**](#shopkeepers-shopkeepers_trade) - Trade an item with a shopkeeper. * [**shopkeepers\_open**](#shopkeepers-shopkeepers_open) - Open a shopkeeper's GUI. * [**SkillAPI**](https://www.spigotmc.org/resources/skillapi.4824/) * [**skillapi\_damage**](https://github.com/AdvancedPlugins/Wiki/blob/main/AdvancedPluginsWiki/actions/broken-reference/README.md) - Damage someone with a skill. * [**skillapi\_combo**](https://github.com/AdvancedPlugins/Wiki/blob/main/AdvancedPluginsWiki/actions/broken-reference/README.md) - Get an x hit combo (combo length is progress). * [**skillapi\_upgrade**](https://github.com/AdvancedPlugins/Wiki/blob/main/AdvancedPluginsWiki/actions/broken-reference/README.md) - Upgrade a skill. * [**skillapi\_unlock**](https://github.com/AdvancedPlugins/Wiki/blob/main/AdvancedPluginsWiki/actions/broken-reference/README.md) - Unlock a skill. * [**skillapi\_loose\_mana**](https://github.com/AdvancedPlugins/Wiki/blob/main/AdvancedPluginsWiki/actions/broken-reference/README.md) - When you loose mana for any reason. * [**skillapi\_reach\_level**](https://github.com/AdvancedPlugins/Wiki/blob/main/AdvancedPluginsWiki/actions/broken-reference/README.md) - When you reach x level (level is the progress). * [**skillapi\_change\_class**](https://github.com/AdvancedPlugins/Wiki/blob/main/AdvancedPluginsWiki/actions/broken-reference/README.md) - When you change your class. * **Subside KoTH (King of The Hill)** * [**koth\_win\_cap**](#benzimmers-koth-koth_win_cap) - Win a KoTH and be the capping player. * [**koth\_capture**](#benzimmers-koth-koth_capture) - Capture a KoTH for X seconds (increments on time). * **StrikePractice** * [**strikepractice\_host\_events**](https://github.com/AdvancedPlugins/Wiki/blob/main/AdvancedPluginsWiki/actions/broken-reference/README.md) - Hosting an event for others to play. * [**strikepractice\_play\_games**](https://github.com/AdvancedPlugins/Wiki/blob/main/AdvancedPluginsWiki/actions/broken-reference/README.md) - Playing matches. * [**strikepractice\_play\_bot\_games**](https://github.com/AdvancedPlugins/Wiki/blob/main/AdvancedPluginsWiki/actions/broken-reference/README.md) - Playing matches against the bot. * [**strikepractice\_win\_games**](https://github.com/AdvancedPlugins/Wiki/blob/main/AdvancedPluginsWiki/actions/broken-reference/README.md) - Winning matches. * [**strikepractice\_win\_bot\_games**](https://github.com/AdvancedPlugins/Wiki/blob/main/AdvancedPluginsWiki/actions/broken-reference/README.md) - Winning matches against the bot. * [**strikepractice\_lose\_games**](https://github.com/AdvancedPlugins/Wiki/blob/main/AdvancedPluginsWiki/actions/broken-reference/README.md) - Losing matches. * **SuperiorSkyblock2** * [**superiorskyblock2\_create**](https://github.com/AdvancedPlugins/Wiki/blob/main/AdvancedPluginsWiki/actions/broken-reference/README.md) - Creating an island. * [**superiorskyblock2\_join**](https://github.com/AdvancedPlugins/Wiki/blob/main/AdvancedPluginsWiki/actions/broken-reference/README.md) - Joining a player's island. * [**superiorskyblock2\_upgrade**](https://github.com/AdvancedPlugins/Wiki/blob/main/AdvancedPluginsWiki/actions/broken-reference/README.md) - Purchasing an island upgrade. * **TokenEnchant** * [**tokenenchant\_gain**](https://github.com/AdvancedPlugins/Wiki/blob/main/AdvancedPluginsWiki/actions/broken-reference/README.md) - Gain tokens. * [**tokenenchant\_enchant**](https://github.com/AdvancedPlugins/Wiki/blob/main/AdvancedPluginsWiki/actions/broken-reference/README.md) - Enchant an item. * **uSkyBlock** * [**uskyblock\_invite**](https://github.com/AdvancedPlugins/Wiki/blob/main/AdvancedPluginsWiki/actions/broken-reference/README.md) - Inviting someone to your island. * [**uskyblock\_invited**](https://github.com/AdvancedPlugins/Wiki/blob/main/AdvancedPluginsWiki/actions/broken-reference/README.md) - Being invited to an island. * [**uskyblock\_join**](https://github.com/AdvancedPlugins/Wiki/blob/main/AdvancedPluginsWiki/actions/broken-reference/README.md) - Joining an island. * [**uskyblock\_island\_chat**](https://github.com/AdvancedPlugins/Wiki/blob/main/AdvancedPluginsWiki/actions/broken-reference/README.md) - Talking in the island chat. * **Votifier** * [**votifier\_vote**](https://github.com/AdvancedPlugins/Wiki/blob/main/AdvancedPluginsWiki/actions/broken-reference/README.md) - Just... vote lol * **RivalHarvesterHoes** * [**rivalharvesterhoes\_harvest**](#rivalharvesterhoes---rivalharvesterhoes_harvest) - When a player breaks crops using hoe from this plugin * **AdvancedMobs** * [**advancedmobs\_kill\_mob**](#advancedmobs---advancedmobs_kill-mob) - When a player kills a mob from this plugin #### `block-break` **Triggered:** When a player breaks a block. **Variable:** The block's material. #### `block-place` **Triggered:** When a player places a block.\ \ **Variable:** The block's material. #### `bucket-place` **Triggered**: When player places a bucket **Variable**: bucket's material (e.g. lava bucket) #### `brew` **Triggered**: when potion is brewed **Variables:** * `root`: [Potion Type](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/potion/PotionType.html) * `isExtended`: `true` if potion has extended time (on versions <1.20.2) * `isUpgraded` : `true` if potion is upgraded (on versions <1.20.2) * `item`: brewed potion #### `chat` **Triggered:** When a player sends a message in chat.\ \ **Variable:** The message sent (lower case) #### `chat-stripped` **Triggered:** When a player sends a message in chat - stripped from colour codes.\ \ **Variable:** The message sent (lower case) #### `right-click` **Triggered:** Whenever a player right clicks.\ \ **Variable:** none. #### `left-click` **Triggered:** Whenever a player left clicks.\ \ **Variable:** none. #### `right-click-block` **Triggered:** Whenever a player right clicks a block.\ \ **Variable:** The block's material. ### `left-click-block` **Triggered:** Whenever a player left clicks a block.\ \ **Variable:** The block's material. #### `consume` **Triggered:** Whenever a player consumes (eats) something.\ \ **Variable:** The item's material. #### `craft` **Triggered:** Whenever a player crafts an item.\ \ **Variable:** The crafted item's material. #### `smith` **Triggered:** Whenever a player smiths an item.\ \ **Variable:** The smithed item's material. #### `damage-player` **Triggered:** When a player deals damage to another player.\ \ **Variable:** none. #### `enchant` **Triggered:** When a player enchants an item using an enchantment table.\ \ **Variables:** * `root`: The name of the enchantment (see [here](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/enchantments/Enchantment.html)) * `item`: The material of the enchanted item (e.g `diamond_sword`) * `level`: The level of the enchantment * `cost`: The level cost of enchanting #### `breed` **Triggered**: When player breeds a mob Variables: * root: EntityType * name: Entity's custom name #### `harvest-crops` **Triggered**: When player harvests crops Variables: * root: Block type #### `enchant-anvil` **Triggered:** When a player enchants an item using an anvil.\ \ **Variables:** * `root`: The name of the enchantment (see [here](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/enchantments/Enchantment.html)) * `item`: The material of the enchanted item, upper case (e.g `DIAMOND_SWORD`) * `level`: The level of the enchantmente #### `enchant-all` **Triggered:** When a player enchants an item using an enchantment table OR an anvil.\ \ **Variables:** * `root`: The name of the enchantment (see [here](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/enchantments/Enchantment.html)) * `level`: The level of the enchantment #### `execute-command` **Triggered:** When a player issues a server command (cannot be bungee).\ \ **Variable:**: The command executed (must be lower case). #### `fish` **Triggered:** When a player catches an item from fishing.\ \ **Variable:** The item caught from fishing. #### `gain-experience` **Triggered:** When a player gains exp.\ \ **Variable:** none. #### `item-break` **Triggered:** When the item a player is using breaks.\ \ **Variable:** The item's material. #### `fly` **Triggered:** When a player flies.\ **Extra Info:** Progression is measured in blocks flown.\ \ **Variable:** none. #### `glide` **Triggered:** When a player glides.\ **Extra Info:** Progression is measured in blocks glided.\ \ **Variable:** none. #### `sneak` **Triggered:** When a player moves a block sneaking.\ **Extra Info:** Progression is measured in blocks snuck.\ \ **Variables:** * `isSwimming` - `true` / `false` * `isGliding` - `true` / `false` * `isFlying` - `true` / `false` * `isSneaking` - `true` / `false` * `isSprinting` - `true` / `false` #### `sprint` **Triggered:** When a player sprints a block.\ **Extra Info:** Progression is measured in blocks walked.\ \ **Variable:** none. #### `swim` **Triggered:** When a player swims a block.\ **Extra Info:** Progression is measured in blocks walked.\ \ **Variable:** none. #### `move` **Triggered:** When a player moves (basically just counting every other movement in one).\ **Extra Info:** Progression is measured in blocks walked.\ \ **Variable:** none. #### `kill-mob` **Triggered:** When a player kills a mob.\ \ **Variables:** root: The type of mob. * `spawn-reason` - [entity spawn reason](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/entity/CreatureSpawnEvent.SpawnReason.html) * `custom-name` - Custom name of entity #### `kill-player` **Triggered:** When a player kills another player.\ \ **Variable:** The name of the killed player. #### `login` **Triggered:** When a player logs into the server.\ \ **Variable:** none. #### `milk` **Triggered:** When a player milks a cow.\ \ **Variable:** none. #### `playtime` **Triggered:** Progressed 1 for every second a user is online (done in 5 second chunks, you must enable this in the settings.yml)\ \ **Variable:** none. #### `throw-projectile` **Triggered:** When a player throws/shoots a projectile\ \ **Variable:** The projectile thrown (see [here](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/entity/EntityType.html)). #### `regenerate` **Triggered:** When a player regenerates health.\ \ **Variable:** The reason for regaining health (see [here](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/event/entity/EntityRegainHealthEvent.RegainReason.html)). #### `ride-mob` **Triggered:** When a player rides a mob.\ \ **Variable:** The type of entity. #### `shear` **Triggered:** When a player shears a sheep.\ \ **Variable:** none. #### `smelt` **Triggered:** When a player smelts an item in a furnace.\ \ **Variable:** The material of the item received from smelting (e.g, iron\_ingot). #### `tame` **Triggered:** When a player tames a mob.\ \ **Variable:** The type of entity tamed. #### `honey-extract` **Triggered:** When a player extracts honey. **Variable:** Bee Nest or Bee Hive #### `honey-comb-extract` **Triggered:** When a player extracts honey combs using shears. **Variable:** Bee Nest or Bee Hive ### External Actions #### McMMO - `mcmmo_gain_exp` **Triggered**: When player gains exp in specific skill **Variable**: Skill name. #### McMMO - `mcmmo_level_up_skill` **Triggered**: When player levels up a skill **Variable**: Skill name. #### McMMO - `mcmmo_level_total_skill` **Triggered**: When player levels up a skill (returns total level of skill) **Variable**: Skill name. #### mbedwars\_break\_bed **Triggered**: When bed is broken Variable: root: team name arena: arena name #### mbedwars\_kill **Triggered**: When kill is achieved root: team name #### mbedwars\_stat\_change **Triggered**: Stat changes root: stat progress: how much of stat has been gained #### mbedwars\_buy\_item **Triggered**: When item is bought root: item name arena: arena name #### mbedwars\_join\_arena **Triggered**: When an arena is joined root: team name cause: #### mbedwars\_team\_eliminate **Triggered**: When a teammate is eliminated root: team name #### ChestShop - `chestshop_create` **Triggered:** When a player creates a chest shop.\ \ **Variable:** none. #### ChestShop - `chestshop_buy` **Triggered:** When a player makes a purchase from a chest shop.\ \ **Variables:** * `root`: The owner of the chest shop's name. * `item`: Bought item #### ChestShop - `chestshop_sell` **Triggered:** When a player sells something from their chest shop.\ \ **Variables:** * `root`: The owner of the client * `item`: Sold item #### ChestShop - `chestshop_spend` **Triggered:** When a player makes a purchase from a chest shop - the cost is the progress.\ \ **Variable:** The owner of the chest shop's name. #### ChestShop - `chestshop_profit` **Triggered:** When a player sells something from their chest shop - the cost is the progress.\ \ **Variable:** The name of the client. #### AdvancedEnchantments - `advancedenchantments_enchant` **Triggered:** When a player enchants any item.\ \ **Variable:** * root: Name of enchant (e.g. glowing) * level: Level of enchant (e.g. 1) #### ASkyBlock - `askyblock_create_island` **Triggered:** When you create a skyblock island.\ \ **Variable:** The name of the schematic of the island. #### ASkyBlock - `askyblock_create_warp` **Triggered:** When you create an island warp.\ \ **Variable:** none. #### AuctionHouse by Kludgemonkey - `auctionhouse_list` **Triggered:** When a player lists an item on the auction house (progressed by the amount of said item).\ \ **Variable:** The material of the item being listed. #### AuctionHouse by Kludgemonkey - `auctionhouse_list_singular` **Triggered:** When a player lists an item on the auction house (only progressed by 1)\ \ **Variable:** The material of the item being listed. #### AuctionHouse by Kludgemonkey - `auctionhouse_buy` **Triggered:** When a player buys an item on the auction house (progressed by the amount of said item bought).\ \ **Variable:** The material of the purchased item. #### AuctionHouse by Kludgemonkey - `auctionhouse_buy_singular` **Triggered:** When a player buys an item on the auction house (only progressed by 1)\ \ **Variable:** The material of the purchased item. #### AuctionHouse by Kludgemonkey - `auctionhouse_sell` **Triggered:** When a player successfully sells an item on the auction house (progressed by the amount of said item sold).\ \ **Variable:** The material of the sold item. #### AuctionHouse by Kludgemonkey - `auctionhouse_sell_singular` **Triggered:** When a player successfully sells an item on the auction house (only progressed by 1).\ \ **Variable:** The material of the sold item. #### AuctionHouse by Kludgemonkey - `auctionhouse_profit` **Triggered:** When a listed item is sold - the amount of money you make from it is the progress.\ \ **Variable:** The material of the sold item. #### AuctionHouse by Kludgemonkey - `auctionhouse_spend` **Triggered:** When you purchase an item from the auction house - the amount of money spent is the progress.\ \ **Variable:** The material of the item purchased. #### AutoSell - `autosell_break` **Triggered:** When you break a block whilst autosell is enabled.\ \ **Variable:** The material of the block broken. #### BedWars1058 - `bedwars1058_break_beds` **Triggered:** When a player breaks a team's bed.\ \ **Variable:** The team of the broken bed. #### BedWars1058 - `bedwars1058_kill_players` **Triggered:** When a player kills an enemy player.\ \ **Variable:** The cause of death (`UNKNOWN`, `EXPLOSION`, `VOID`, `PVP`, `PLAYER_SHOOT`) #### BedWars1058 - `bedwars1058_buy_items` **Triggered:** When a player purchases an item.\ \ **Variable:** none. #### BedWars1058 - `bedwars1058_buy_upgrades` **Triggered:** When a player buys a team upgrade.\ \ **Variable:** none. #### Benzimmer's KOTH - `koth_capture` **Triggered:** When a player captures a point for x time (the amount of time captured in seconds is the progress).\ \ **Variable:** The name of the KOTH. #### Benzimmer's KOTH - `koth_win_cap` **Triggered:** When a player wins the capture for a KOTH.\ \ **Variable:** The name of the KOTH #### BuildBattle by Tiger - `buildbattle_join` **Triggered:** When a player joins a BuildBattle game.\ \ **Variable:** The name of the map. #### BuildBattle by Tiger - `buildbattle_play` **Triggered:** When a player is in a game and it starts.\ \ **Variable:** The name of the map. #### BuildBattle by Tiger - `buildbattle_finish` **Triggered:** When a player is in a game when it finishes.\ \ **Variable:** The name of the map. #### ChatReaction - `chatreaction_win` **Triggered:** When a player wins a ChatReaction competition.\ \ **Variable:** none. #### Citizens - `citizens_click` **Triggered:** When a player click a citizens NPC.\ \ **Variable:** The name of the NPC. #### Citizens - `citizens_damage` **Triggered:** When a player damages a citizens NPC (normally requires Sentinel).\ \ **Variable:** The name of the NPC. #### Citizens - `citizens_kill` **Triggered:** When a player kills a citizens NPC (normally requires Sentinel).\ \ **Variable:** The name of the NPC. #### Clans - `clans_create` **Triggered:** When a player creates a clan.\ \ **Variable:** none. #### Clans - `clans_join` **Triggered:** When a player joins a clan.\ \ **Variable:** none. #### ClueScrolls - `cluescrolls_complete_clue` **Triggered:** When a player completes a clue.\ \ **Variable:** The type of clue. #### ClueScrolls - `cluescrolls_complete_scroll` **Triggered:** When a player completes a scroll.\ \ **Variable:** The tier type. **MMOCore** - `mmocore_level_up_skill` **Triggered**: When player levels up a skill **Variable**: skill type name (e.g. ARCHERY) **MMOCore** - `mmocore_gain_exp` **Triggered**: when player gains exp from a skill **Variable**: skill type name (e.g. ARCHERY) #### CrateReloaded - `cratereloaded_open` **Triggered:** When a player opens a CrateReloaded crate.\ \ **Variable:** The name of the crate opened. #### CratesPlus - `cratesplus_open` **Triggered:** When a player opens a CratesPlus crate.\ \ **Variable:** The name of the crate opened. #### CrazyCrates - `crazycrates_open` **Triggered:** When a player opens a CrazyCrates crate.\ \ **Variable:** The name of the crate opened. #### CrazyEnvoy - `crazyenvoy_open_envoy` **Triggered:** When a player opens an envoy crate.\ \ **Variable:** The name of the tier of crate. #### CrazyEnvoy - `crazyenvoy_use_flare` **Triggered:** When a player uses an envoy flare to start an envoy.\ \ **Variable:** none. #### DiscordMinecraft - `discordminecraft_link` *(probably broken)* **Triggered:** When a links their discord account.\ \ **Variable:** none. #### ExcellentCrates - `excellentcrates_open` **Triggered:** When a player opens a crate. **Variable:** crate name. #### FactionsUUID - `factions_kill_enemy` **Triggered:** When a player kills another person from an enemy faction.\ \ **Variable:** none. #### Jobs - `jobs_join` **Triggered:** When a player joins a job.\ \ **Variable:** The name of the job. #### Jobs - `jobs_gain_exp` **Triggered:** When a player gains experience (progress is the exp gained).\ \ **Variable:** The name of the player's job. #### Jobs - `jobs_level_up` **Triggered:** When a player levels up (progress is set to this level).\ \ **Variable:** The name of the player's job. #### Lands - `lands_join` **Triggered:** When a player joins a land.\ \ **Variable:** none. #### Lands - `lands_leave` **Triggered:** When a player leaves a land.\ \ **Variable:** none. #### Lands - `lands_create` **Triggered:** When a player creates a land.\ \ **Variable:** none. #### Lands - `lands_disband` **Triggered:** When a player disbands their land.\ \ **Variable:** none. #### Lands - `lands_invited` **Triggered:** When a player is invited to a land.\ \ **Variable:** none. #### Lands - `lands_claim_chunk` **Triggered:** When a player claims a chunk for their land.\ \ **Variable:** none. #### LobbyPresents by Poompk - `lobbypresents_find` **Triggered:** When a player finds a present.\ \ **Variable:** The ID of the present. #### MoneyHunters - `moneyhunters_level_up` **Triggered:** When a player levels up (the progress is set to their level).\ \ **Variable:** The name of their job. #### MoneyHunters - `moneyhunters_gain_exp` **Triggered:** When a player tames a mob (the progress is increased by the given xp).\ \ **Variable:** The name of their job. #### MythicMobs - `mythicmobs_kill_mob` **Triggered:** When a player kills a MythicMobs mob.\ \ **Variable:** The name of the type of mob. #### PlaceholderAPI - `placeholderapi_match_` **Description:** When the placeholder is resolved for the player, it will progress if the variable is the same as what the placeholder resolves to. E.g if the type was as `placeholderapi_match_essentials_flying` and the variable was true, if the player was flying the action would progress. #### PlaceholderAPI - `placeholderapi_integer_` **Description:** Resolves the placeholder for the player and sets the progress of the action to the value of the placeholder (**the resolved value must be an integer, e.g 342653476**). An example would be the type as `placeholderapi_integer_gemseconomy_balance_default` with the variable none and the required progress 10000. When they get 10000 gems it will be completed.\ \ **Variable:** none. #### PlotSquared - `plotsquared_claim` **Triggered:** When a player claims their plot.\ \ **Variable:** auto or manual. #### PlotSquared - `plotsquared_visit` **Triggered:** When a player visits another player's plot.\ \ **Variable:** The owner of the plot's username or `none` if not found. #### PlotSquared - `plotsquared_trust_player` **Triggered:** When a player trusts another player.\ \ **Variable:** none. #### PlotSquared - `plotsquared_become_trusted` **Triggered:** When a player becomes trusted on another player's plot.\ \ **Variable:** none. #### PlotSquared - `plotsquared_rate` **Triggered:** When a player rates another player's plot.\ \ **Variable:** none. #### PlotSquared - `plotsquared_teleport` **Triggered:** When a player teleports to a plot.\ \ **Variable:** The owner of the plot's username or `none` if not found. #### ProCosmetics - `procosmetics_spend` **Triggered:** When a player spends coins on a cosmetic or treasure chest (the progress is the amount spent).\ \ **Variable:** `treasure-chest` or `cosmetic` depending on what was bought. #### ProCosmetics - `procosmetics_buy_treasure` **Triggered:** When a player buys a treasure.\ \ **Variable:** The name of the treasure. #### ProCosmetics - `procosmetics_open_treasure` **Triggered:** When a player opens a treasure.\ \ **Variable:** The name of the treasure. #### ProCosmetics - `procosmetics_buy_cosmetic` **Triggered:** When a player buys a cosmetic.\ \ **Variable:** The type of cosmetic. #### ShopGuiPlus - `shopguiplus_buy` **Triggered:** When a player purchases an item from the shop. The progress will be the amount of items purchased\ \ **Variables:** * `root`: The item that was purchased (e.g iron\_sword:0) * `shop`: The ID of the shop the item was purchased from (e.g foodstuffs) * `item-id`: The ID of the item in the shop (e.g 2, 6, or 8) #### ShopGuiPlus - `shopguiplus_buy_singular` **Triggered:** When a player purchases an item from the shop. The progress will always be 1\ \ **Variables:** * `root`: The item that was purchased (e.g iron\_sword:0) * `shop`: The ID of the shop the item was purchased from (e.g foodstuffs) * `item-id`: The ID of the item in the shop (e.g 2, 6, or 8) #### ShopGuiPlus - `shopguiplus_spend` **Triggered:** When a player purchases an item from the shop. The progress will be the amount it cost the user rounded up to the nearest real number (2.4 -> 3)\ \ **Variables:** * `root`: The item that was purchased (e.g iron\_sword:0) * `shop`: The ID of the shop the item was purchased from (e.g foodstuffs) * `item-id`: The ID of the item in the shop (e.g 2, 6, or 8) #### ShopGuiPlus - `shopguiplus_sell` **Triggered:** When a player sells an item to the shop. The progress will be the amount of items sold.\ \ **Variables:** * `root`: The item that was purchased (e.g iron\_sword:0) * `shop`: The ID of the shop the item was purchased from (e.g foodstuffs) * `item-id`: The ID of the item in the shop (e.g 2, 6, or 8) #### ShopGuiPlus - `shopguiplus_sell_singular` **Triggered:** When a player sells an item to the shop. The progress will always be 1.\ \ **Variables:** * `root`: The item that was purchased (e.g iron\_sword:0) * `shop`: The ID of the shop the item was purchased from (e.g foodstuffs) * `item-id`: The ID of the item in the shop (e.g 2, 6, or 8) #### ShopGuiPlus - `shopguiplus_profit` **Triggered:** When a player sells an item to the shop. The progress will be the amount it cost the user rounded up to the nearest real number (2.4 -> 3)\ \ **Variables:** * `root`: The item that was purchased (e.g iron\_sword:0) * `shop`: The ID of the shop the item was purchased from (e.g foodstuffs) * `item-id`: The ID of the item in the shop (e.g 2, 6, or 8) #### EconomyShopGUI - `economyshopgui_buy` **Triggered:** When a player purchases an item from the shop.\ **Variable:** The item that was purchased #### EconomyShopGUI - `economyshopgui_sell` **Triggered:** When a player sells an item in the shop.\ **Variable:** The item that was sold #### Shopkeepers - `shopkeepers_trade` **Triggered:** When a player trades with a shopkeeper.\ \ **Variable:** The UUID of the shopkeeper. #### Shopkeepers - `shopkeepers_open` **Triggered:** When a player opens a shopkeeper.\ \ **Variable:** The UUID of the shopkeeper. #### SuperiorSkyBlock2 - `superiorskyblock2_upgrade` **Triggered:** Purchasing an island upgrade.\ **Variable:** The name of an upgrade (`plugins\SuperiorSkyblock2\modules\upgrades`) ### RivalHarvesterHoes - `rivalharvesterhoes_harvest` **Triggered:** When a player breaks crops using hoe from this plugin **Variables:** root: crop block * `item` - Hoe item #### AdvancedMobs - `advancedmobs_kill-mob` **Triggered:** When a player kills mob from this plugin **Variable:** The mob type # PlaceholderAPI Actions Learn how you can integrate almost any other plugin into your actions. Actions support PlaceholderAPI’s placeholders. Here you will learn how you can add any plugin, which has PlaceholderAPI's support to your actions. ### PlaceholderAPI - `placeholderapi_match_` **Description:** When the placeholder is resolved for the player, it will progress if the variable is the same as what the placeholder resolves to. E.g if the type was as `placeholderapi_match_essentials_fly` and the variable was yes, if the player was flying the action would progress. ```yaml type: placeholderapi_match_essentials_fly variable: 'yes' required-progress: 5 ``` ### PlaceholderAPI - `placeholderapi_integer_` This works by matching your listed placeholder to a specific number. If your **PlaceholderAPI's** placeholder was `%player_level%` your action would look like this: `placeholderapi_integer_player_level`\ \ Example, if you wanted to make an action which activates as soon as player reaches experience level 100, you can set up an action looking like this: ```yaml type: placeholderapi_integer_player_level required-progress: 10 ``` # Setting up and using Variables {% hint style="warning" %} BattlePass 4.6.2 and AdvancedJobs 1.4.1 removed MaterialData from items in variables (`:0`, `:1` at the end of item's type). {% endhint %} The core of actions is the variable system. The basis of this system is that it is a filter. If the variable is set to `none`, there is no filter. If it is set, if whatever the variable is entered as when a user performs an action matches the variable, it will progress. Recently, we've also added sub variables which can make this system a bit more confusing. Here are some examples for different action types with and without sub variables. Every action has the global sub variables listed below: ```yml variable: root: none holding: item: diamond_sword name: 'IDK some name' amount: 1 model: 0 # Custom Model Data (for resource packs) ``` Every sub-variable is optional. If you don't specify it, it won't be filtered for. Therefore, you can just use `holding.item` if you wish, or just `holding.amount`. ## Basic Examples **Without Sub-Variables:** The following two actions function in the same manner, they're just two ways of formatting them. `block-break` ```yml variable: root: stone ``` `block-break` ```yml variable: stone ``` Some more random examples: `throw-projectile` ```yml variable: SNOWBALL ``` **With Sub-Variables:** `block-break` ```yml variable: root: diamond_block holding: item: golden_pickaxe ``` `enchant-all` ```yml variable: root: SOUL_SPEED item: diamond_sword level: 3 ``` This action is to enchant an item with soul speed 3 using an anvil. **With Multiple Variables:** `block-break` ```yml variable: diamond_block OR gold_block OR iron_block #This will progress the action if any of the blocks listed above is mined. ``` `block-place` ```yml variable: - "stone" - "cobblestone" - "gravel" # This will progress the quest if any of the blocks listed above is placed. ``` ## Blacklists To create blacklist in variable, use `!` in front of first element **Examples without subroots:** `block-break` ```yml variable: "!stone OR dirt" # This will progress the quest if player mined any block except stone and dirt ``` `block-place` ```yml variable: - "!stone" - "dirt" # This will progress the quest if player placed any block except stone and dirt ``` **Examples with subroots:** ```yml variable: root: "none" holding: item: "!diamond_pickaxe" # This will progress the quest if player doesn't hold diamond pickaxe ``` ## Variable format There are some formats which you can use in variables to achieve certain functionality ### "Contains" element "CONTAINS" element check if action root/subroot contains specified text. TO create this, add `__` before element. **Example:** ```yml variable: __ORE ``` In this case, root will accept every item which contains ORE in name (it also applies for strings and entities) ### ItemsAdder (experimental) Just add `itemsadder:` before element name to use itemsadder items, block or entities **Example:** ```yml variable: itemsadder:ITEM_NAME ``` ### MMOItems (experimental) Just add `mmoitems:` before element name to use items from this plugin **Example:** ```yml variable: mmoitems:ITEM_NAME ``` ### Properties You can add some properties in JSON format. #### `nbt` property Minecraft NBT String to modify required item. I.e. to create quest that progres only when we use unbreakable diamond pickaxe, we can use this property. Note: Minecraft NBT String must contain item name. It also must be in correct format (1.20.5 changed format of NBT String i.e. in give command) **Example:** ```yml variable: root: none holding: item: "diamond_pickaxe{nbt: 'diamond_pickaxe[unbreakable={}]'}" ``` #### `faces` property Support for block with multiple faces i.e. mushroom blocks. **Example:** ```yml variable: "brown_mushroom_block{faces: ['west', 'east']}" ``` #### `age` property Age of Ageable material i.e. age of planted carrot **Example:** ```yml variable: "carrots{age: 3}" ``` #### `progress` property Added progress property (similar to old `special-progress` section). It's multiplier of progress. **Example:** ```yml variable: "iron_ingot OR diamond{progress: 3}" ``` In this case, diamond gives 3 progress instead of 1. {% hint style="info" %} `special-progress` is still available for cases where we can't use progress property, i.e. in blacklists {% endhint %} ## PAPI conditions If you have PlaceholderAPI installed, you can use variables conditions to have more control over when player can progress quest. There are 2 types of conditions: * `or` (same as `||` in Java) - player must meet at least one condition to progress * `and` (same as `&&` in Java) - player must meet all conditions to progress **Example:** ```yml variable: root: none conditions: or: - "%player_is_op% == yes" - "%player_level% > 10" and: [] ``` In this case, action will progress only when the player is op OR has level greater than 10.