Activators features
These options are utilized to accomplish specific things to create simple to complex items
All this features are inside the activator, as reminder the activators allow you to execute custom actions on your ExecutableItem, it can have conditions, run commands, have cooldown, etc.
Starred features ⭐ are for premium version.
General features of an activator
Display name of the activator
Info: String value of the display name of the activator, it doesn't have much use, its used for the developer to recognize one activator from another. It also appears on the default message "timeLeft" inside the locale.yml file.
Example:
Variables modification
Info: Its a list of variables modification to apply to the variables inside your item. Its useful for example, for increase the value of a variable, for overriding an old value of a variable to another value, etc.
variableName: Name of the variable the variableModification is targetting
type: Type of variableModification you are using
SET: Override the old value of the variable and sets the modification value.
ADD: Apply math to the current value of the variable using the modification value. It needs the variable to be type of NUMBER. If the modification value is positive then it will increase, if its negative then it will decrease.
LIST_ADD: Applied to variable type LIST, it appens the modification value to the variable list.
LIST_CLEAR: Applied to variable type LIST, it clears the variable list.
LIST_REMOVE: Applied to variable type LIST, it removes the modification value from the variable list.
modification: Value of modification. Its applied to the variable using the types of modifications.
Example:
Be careful when using placeholders here ! There is no problem with that, just make sure the returning output is a NUMBER, otherwise you will need to use STRING features. For example, let's update a variableModification by another variable that we know it returns a NUMBER.
cancelEvent
Info: Boolean value that represents if the event related to the activator is going to be cancelled or not.
This can be hard to understand, I think its one of the things that most people don't understand but to explain it you must know that each ACTIVATOR is related to a Minecraft event, following the idea this event occur and then the ACTIVATOR is triggered. if we enabling cancelEvent which is a feature from the activator, that means the event occur, then at almost the same time the activator gets triggered and it cancels the event, so the activator keeps running all its enabled features but the event didn't happen, cancelling it. For example:
If the activator is PLAYER_HIT_PLAYER and we enable cancelEvent then the player won't be able to hit the player due all hits are cancelled/ignored.
If the activator is PLAYER_BLOCK_BREAK and we enable cancelEvent then the player won't be able to break blocks due the event is cancelled/ignored.
Example:
worldConditions
Info: You can use this conditions in all type of activators
placeholdersConditions
Info: You can use this conditions in all type of activators
silenceOutput
Info: Boolean value that makes all commands run from commands features such as (playerCommands, blockCommands, entityCommands and targetCommands) will not have an output on the console.
For example, using the minecraft vanilla command effect give [...] normally has an output on the console with this format: "Applied effect strength to <playerName>", well, to disable this output you can enable this feature
Example:
⭐Required features
This section is for setting up features related to required things in order to be able to trigger the activator. This means that if the event happens, the activator will only run if the player matches this required setup. The items will be consumed in the process.
If you would like the items not to get consumed then not use "required" feature but use conditions which are just conditions and doesn't consume.
⭐requiredExecutableItems
Info: This feature allows the activator to have as requirement an ExecutableItem(s). If the player meets this requirement the requirement will be consumed and the activator will run.
cancelEventIfError: Boolean value that represents if the event will be cancelled if the player doesn't have the requirement.
This means, for example, let's say there is an event of PLAYER_HIT_ENTITY, and it occurs but the player doesn't have the requirements in order to trigger the activator, if this feature is enabled the event of PLAYER_HIT_ENTITY will be cancelled so the player even though its clicking/hit the entity, the entity is not getting damage because in reality the event is not occurring due its being cancelled.
errorMessage: String message that will be sent to the player if the player doesn't meet the requirement.
executableItem: ExecutableItem ID that is needed as requiremennt
amount: Integer of amount of items that are needed as requirement.
usageConditions: Optional string condition in format of (==,!=,>,<,>=,<=){number} to the usage condition of the ExecutableItem.
This means, if the condition is >=5 then the requirement is that the Executableitem chosen must be on the player inventory as its a requirement but also needs to have usage over or equal a value of 5.
Example:
⭐requiredItems
Info: This feature allows the activator to have as requirement vanilla item(s). If the player meets this requirement the requirement will be consumed and the activator will run.
cancelEventIfError: Boolean value that represents if the event will be cancelled if the player doesn't have the requirement.
This means, for example, let's say there is an event of PLAYER_HIT_ENTITY, and it occurs but the player doesn't have the requirements in order to trigger the activator, if this feature is enabled the event of PLAYER_HIT_ENTITY will be cancelled so the player even though its clicking/hit the entity, the entity is not getting damage because in reality the event is not occurring due its being cancelled.
errorMessage: String message that will be sent to the player if the player doesn't meet the requirement.
material: Vanilla MATERIAL that is needed as requirement.
amount: Integer of amount of items that are needed as requirement.
notExecutableItem: Boolean value to make the requirement able to be a ExecutableItem or not.
This means, if the requirement is STONE, and this feature is not enabled, then the requirement will meet with vanilla STONE(s) and ExecutableItem(s) with material of STONE and so will be consumed. If you don't want this to happen then enable this feature.
Example:
⭐requiredMoney
Info: This feature needs the plugin called "Vault". This feature allows the activator to have as requirement money from Vault. If the player meets this requirement the requirement will be consumed and the activator will run.
cancelEventIfError: Boolean value that represents if the event will be cancelled if the player doesn't have the requirement.
This means, for example, let's say there is an event of PLAYER_HIT_ENTITY, and it occurs but the player doesn't have the requirements in order to trigger the activator, if this feature is enabled the event of PLAYER_HIT_ENTITY will be cancelled so the player even though its clicking/hit the entity, the entity is not getting damage because in reality the event is not occurring due its being cancelled.
errorMessage: String message that will be sent to the player if the player doesn't meet the requirement.
requiredMoney: Float value that represents the amount of money needed as requirement.
Example:
⭐requiredLevel
cancelEventIfError: Boolean value that represents if the event will be cancelled if the player doesn't have the requirement.
This means, for example, let's say there is an event of PLAYER_HIT_ENTITY, and it occurs but the player doesn't have the requirements in order to trigger the activator, if this feature is enabled the event of PLAYER_HIT_ENTITY will be cancelled so the player even though its clicking/hit the entity, the entity is not getting damage because in reality the event is not occurring due its being cancelled.
errorMessage: String message that will be sent to the player if the player doesn't meet the requirement.
requiredLevel: Integer value that represents the amount of Minecraft vanilla experience level(s) needed as requirement.
Example:
⭐requiredExperience
cancelEventIfError: Boolean value that represents if the event will be cancelled if the player doesn't have the requirement.
This means, for example, let's say there is an event of PLAYER_HIT_ENTITY, and it occurs but the player doesn't have the requirements in order to trigger the activator, if this feature is enabled the event of PLAYER_HIT_ENTITY will be cancelled so the player even though its clicking/hit the entity, the entity is not getting damage because in reality the event is not occurring due its being cancelled.
errorMessage: String message that will be sent to the player if the player doesn't meet the requirement.
requiredExperience: Integer value that represents the amount of experience needed as requirement.
Example:
⭐RequiredMana
Info: This feature allows the activator to have as requirement mana from AureliumSkills, MMOCore and AuraSkills. If the player meets this requirement the requirement will be consumed and the activator will run.
cancelEventIfError: Boolean value that represents if the event will be cancelled if the player doesn't have the requirement.
This means, for example, let's say there is an event of PLAYER_HIT_ENTITY, and it occurs but the player doesn't have the requirements in order to trigger the activator, if this feature is enabled the event of PLAYER_HIT_ENTITY will be cancelled so the player even though its clicking/hit the entity, the entity is not getting damage because in reality the event is not occurring due its being cancelled.
errorMessage: String message that will be sent to the player if the player doesn't meet the requirement.
requiredMana: Integer value that represents the amount of mana needed as requirement.
Example:
⭐RequiredMagic (EcoSkills)
Info: This feature allows the activator to have as requirement magic from EcoSkills. If the player meets this requirement the requirement will be consumed and the activator will run.
cancelEventIfError: Boolean value that represents if the event will be cancelled if the player doesn't have the requirement.
This means, for example, let's say there is an event of PLAYER_HIT_ENTITY, and it occurs but the player doesn't have the requirements in order to trigger the activator, if this feature is enabled the event of PLAYER_HIT_ENTITY will be cancelled so the player even though its clicking/hit the entity, the entity is not getting damage because in reality the event is not occurring due its being cancelled.
errorMessage: String message that will be sent to the player if the player doesn't meet the requirement.
magicID: The ID of the magic in EcoSkills.
amount: Amount of magic of the magicID needed as requirement.
Features exclusive depending on type of activator
To make the features more understandable on which activators they work, we created categories :
[P_*] : It means that the main actor of the event/activator is a player
[E_*] : It means that the main actor of the event/activator is an entity
[B_*] : It means that the main actor of the event/activator is a block
[*_TP] : It means that the second actor of the event/activator is a player (we will call it target player)
[*_TE] : It means that the second actor of the event/activator is an entity (we will call it target entity)
[*_TB] : It means that the second actor of the event/activator is a block (we will call it target block)
[S_A_L] : Specific activator list: Other custom features specific to some activators
[P_*] commands
It's available in all activators that contains a player as the principal actor of the event.
Info: Player commands is a list commands that are normally run against the player when the activator triggers.
This means if it has an SCore command, example: DAMAGE 5, the damage will be applied to the user of the ExecutableItem.
You can also run commands from other plugins or vanilla commands. These commands will be executed by the console.
minecraft:say Hey
money give %player% 500
Example:
[P_*] playerConditions
It's available in all activators that contains a player as the principal actor of the event.
Info: Feature for activators that involves a player, here you can setup conditions for the player involved.
Example:
[P_*] Player placeholders
[B_*] blockCommands
It's available in all activators that contains a block as the principal actor of the event.
Info: List of commands that are normally run against the block when the activator triggers.
This means, the activator must have involved with a block, for example PLAYER_HIT_PLAYER is an activator, but it doesn't involve a block, so blockCommands are not available here. With the activator PLAYER_BLOCK_BREAK there is a block involved so blockCommands are available here.
Another example PLAYER_RIGHT_CLICK has an activatorFeature called typeTarget, by default its ONLY_AIR so blockCommands are not available due the activator is not involved with a block, but, typeTarget can be changed to ONLY_BLOCK and then the activator will have as available features blockCommands.
Example:
[B_*] detailedBlocks
It's available in all activators that contains a block as the principal actor of the event.
Info: Feature for activators that involves a block, here you can select as condition the type of block(s) where this activator will trigger by using this feature.
You can select blocks from Minecraft Vanilla like:
"STONE"
"FURNACE{lit:true}"
You can select blocks from ItemsAdder like:
"ITEMSADDER:<id>"
You can select blocks from ExecutableBlocks like:
"EXECUTABLEBLOCKS:<id>"
You can blacklist certain blocks adding ! at the beginning like:
"!DIRT"
You can add Block Tags like:
"#MINECRAFT:MINEABLE/PICKAXE"
You can add group of blocks like
"ALL_ORES"
Example:
[B_*] blockConditions
It's available in all activators that contains a block as the principal actor of the event.
Info: Feature for activators that involves a block, here you can setup conditions for the block involved.
[B_*] Block placeholders
[E_*] entityCommands
It's available in all activators that contains an entity (not player) as the principal actor of the event.
Info: Player commands is a list commands that are normally run against the player when the activator triggers.
This means if it has an SCore command, example: DAMAGE 5, the damage will be applied to the user of the ExecutableItem.
You can also run commands from other plugins or vanilla commands. These commands will be executed by the console.
minecraft:say Hey
money give %player% 500
Example:
[E_*] detailedEntities
It's available in all activators that contains an entity (not player) as the principal actor of the event.
Info: For activators that involves an entity you can select as condition the type of entity(es) where this activator will trigger by using this feature.
"ZOMBIE"
"ZOMBIE{isBaby:1}"
"ZOMBIE{CustomName:"*"}"
You can select a MythicMob mob like:
"MM-<ID>"
You can blacklist a mob by usinig ! like
!SKELETON
[E_*] entityConditions
It's available in all activators that contains an entity (not player) as the principal actor of the event.
Info: Feature for activators that involves a entity, here you can setup conditions for the entity involved.
[E_*] Entity placeholders
[P_*, E_*] Player cooldown
Info: Cooldown options its the cooldown applied to the player/entity who triggered this activator for this activator.
If the activator is PLAYER_RIGHT_CLICK, it has some commands [] and the cooldown is 30 seconds, if the player triggers this activator he will need to wait 30 seconds in order to make it trigger again. This doesn't prevent other player from running it between those 30 seconds as long as that player is not on cooldown too. This is a feature per player
cooldown: Integer value that represents the amount of time the cooldown will last for this activator.
isCooldownInTicks: Boolean value that sets the cooldown time to be in ticks (20 ticks = 1 second)
cooldownMsg: String value to be displayed when the player try to trigger the activator when its on cooldown
displayCooldownMessage: Boolean value to allow or prevent the message of cooldownMsg displayed if the player try to trigger the activator while he is on cooldown.
Placeholders that can be used:
%time% -> the entire cooldown in seconds
%time_H% -> the hours part of the cooldown
%time_M% -> the minutes part of the cooldown
%time_S% -> the seconds part of the cooldown
cancelEventIfInCooldown: Boolean value that cancels the event of the activator if the player is on cooldown. This means, if the activator is PLAYER_HIT_ENTITY, while he is on cooldown all the player event's of PLAYER_HIT_ENTITY will be cancelled and so they will be ignored, disabling the ability of the player to attack entities (reminder: that activator targets all entities except players)
pauseWhenOffline: Boolean value that pauses the cooldown if the player is offline. To better understanding, if its false, the cooldown time doesn't stop so he can leave the server, wait the cooldown and join again and he will be able to trigger the activator again. But if this feature is enabled and he left the server while on cooldown, when he joins again he will have the same remaining cooldown time that he had when he left.
pausePlaceholdersConditions: Its similar to pauseWhenOffline but it only pauses depending on certain placeholdersConditions. Example of usages would be pausing the cooldown if the player is VIP rank. So VIP rank has access to that feature.
enableVisualCooldown: Enables a visual cooldown for the item.
Example:
[P_*, E_*] Global cooldown
Info: Its the same idea as cooldown but instead of being the cooldown applied to the player its a global cooldown that is applied to all players/entities. That means, if someone triggers the activator and it has 30 seconds of global cooldown, then no one will be able to use it after those 30 seconds has gone. It has the same features as cooldown.
cooldown: Integer value that represents the amount of time the cooldown will last for this activator.
isCooldownInTicks: Boolean value that sets the cooldown time to be in ticks (20 ticks = 1 second)
cooldownMsg: String value to be displayed when a player try to trigger this activator when its on cooldown
displayCooldownMessage: Boolean value to allow or prevent the message of cooldownMsg displayed if the player try to trigger the activator while he is on cooldown.
Placeholders that can be used:
%time% -> the entire cooldown in seconds
%time_H% -> the hours part of the cooldown
%time_M% -> the minutes part of the cooldown
%time_S% -> the seconds part of the cooldown
cancelEventIfInCooldown: Boolean value that cancels the event of the activator if the player is on cooldown. This means, if the activator is PLAYER_HIT_ENTITY, while he is on cooldown all the player event's of PLAYER_HIT_ENTITY will be cancelled and so they will be ignored, disabling the ability of the player to attack entities (reminder: that activator targets all entities except players)
enableVisualCooldown: Enables a visual cooldown for the item.
Example:
[*_TP] targetPlayerCommands
It's available in all activators that contains a player targeted as the second actor of the event.
Info: Target commands is a list commands that are normally run against the target when the activator triggers.
This means if it has an SCore command of DAMAGE 5, the damage will be applied to the target/enemy involved in the activator.
You can also run commands from other plugins or vanilla commands. These commands will be executed by the console.
minecraft:say Hey
money give %target% 500
Example:
[*_TP] targetPlayerConditions
It's available in all activators that contains a player targeted as the second actor of the event.
Info: Feature for activators that involves a player target, here you can setup conditions for the player target involved.
Example:
[*_TP] Target player placeholders
[*_TE] targetEntityCommands
It's available in all activators that contains an entity targeted as the second actor of the event.
Info: Target commands is a list commands that are normally run against the target when the activator triggers.
This means if it has an SCore command of DAMAGE 5, the damage will be applied to the target/enemy involved in the activator.
You can also run commands from other plugins or vanilla commands. These commands will be executed by the console.
minecraft:say Hey
Example:
[*_TE] targetEntityConditions
It's available in all activators that contains an entity targeted as the second actor of the event.
Info: Feature for activators that involves a player target, here you can setup conditions for the entity target involved.
Example:
[*_TE] detailedTargetEntities
It's available in all activators that contains an entity targeted as the second actor of the event.
Info: For activators that involves a target entity you can select as condition the type of entity(es) where this activator will trigger by using this feature.
"ZOMBIE"
"ZOMBIE{isBaby:1}"
"ZOMBIE{CustomName:"*"}"
You can select a MythicMob mob like:
"MM-<ID>"
You can blacklist a mob by usinig ! like
!SKELETON
[*_TE] Target entity placeholders
[*_TB] targetBlockCommands
It's available in all activators that contains a block as the second actor of the event.
Info: List of commands that are normally run against the block when the activator triggers.
Another example PLAYER_RIGHT_CLICK has an activatorFeature called typeTarget, by default its ONLY_AIR so targetBlockCommands are not available due the activator is not involved with a block, but, typeTarget can be changed to ONLY_BLOCK and then the activator will have as available features targetBlockCommands
Example:
[*_TB] detailedTargetBlocks
It's available in all activators that contains a block as the second actor of the event.
Info: Feature for activators that involves a target block, here you can select as condition the type of block(s) where this activator will trigger by using this feature.
You can select blocks from Minecraft Vanilla like:
"STONE"
"FURNACE{lit:true}"
You can select blocks from ItemsAdder like:
"ITEMSADDER:<id>"
You can select blocks from ExecutableBlocks like:
"EXECUTABLEBLOCKS:<id>"
You can blacklist certain blocks adding ! at the beginning like:
"!DIRT"
You can add Block Tags like:
"#MINECRAFT:MINEABLE/PICKAXE"
You can add group of blocks like
"ALL_ORES"
Example:
[*_TB] targetBlockConditions
It's available in all activators that contains a block as the second actor of the event.
Info: Feature for activators that involves a target block, here you can setup conditions for the target block involved.
Example:
[*_TB] detailedTargetBlocks
It's available in all activators that contains a block as the second actor of the event.
Info: Feature for activators that involves a target block, here you can select as condition the type of block(s) where this activator will trigger by using this feature.
You can select blocks from Minecraft Vanilla like:
"STONE"
"FURNACE{lit:true}"
You can select blocks from ItemsAdder like:
"ITEMSADDER:<id>"
You can select blocks from ExecutableBlocks like:
"EXECUTABLEBLOCKS:<id>"
You can blacklist certain blocks adding ! at the beginning like:
"!DIRT"
You can add Block Tags like:
"#MINECRAFT:MINEABLE/PICKAXE"
You can add group of blocks like
"ALL_ORES"
Example:
[*_TB] Target block placeholders
[S_A_L] detailedItems
Type of activator category: Specific activator list
🔹PLAYER_DROP_ITEM
🔹PLAYER_CONSUME
Info: For activators that involves an item you can select as condition the type of item(s) where this activator will trigger by using this feature.
You can select a Minecraft vanilla item like:
"STONE"
You can select a Minecraft vanilla item with NBT like:
"DIRT{CUSTOMMODELDATA:5}"
You can blacklist items using ! like:
"!TORCH"
Example:
[S_A_L] detailedDamageCauses
Type of activator category: Specific Activator List
⭐PLAYER_BLOCK_HIT_OF_ENTITY
⭐PLAYER_BLOCK_HIT_OF_PLAYER
⭐PLAYER_RECEIVE_HIT_BY_ENTITY
⭐PLAYER_RECEIVE_HIT_BY_PLAYER
⭐PLAYER_RECEIVE_HIT_GLOBAL
🔹PLAYER_DEATH
🔹PLAYER_HIT_PLAYER
Info: Feature for activators that involves damage, here you can select as condition the type of damage that is either received or dealt depending on the activator you are using.
Example:
[S_A_L] detailedEffects
Type of activator category: Specific Activator List
⭐PLAYER_RECEIVE_EFFECT
Info: Feature for activators that involves effects, here you can select as condition the type of effect involved to trigger the activator.
Example:
[S_A_L] detailedCommands
Type of activator category: Specific Activator List
⭐PLAYER_WRITE_COMMAND
Info: Feature for activators that involves commands, here you can select as condition the command the activator should run with.
Example:
[S_A_L] desactiveDrops
Type of activator category: Specific Activator List
⭐PLAYER_KILL_ENTITY
⭐PLAYER_BLOCK_BREAK
⭐PLAYER_KILL_PLAYER
⭐PLAYER_FISH_FISH
Info: Boolean value that allows or prevents the vanilla loot to be dropped when breaking blocks or killing mobs. Since its vanilla drops, custom drops from custom mobs e.g. (MythicMobs) will not get affected by this.
Example:
[S_A_L] typeTarget
Type of activator category: Specific Activator List
🔹PLAYER_ALL_CLICK
🔹PLAYER_RIGHT_CLICK
🔹PLAYER_LEFT_CLICK
Info: Feature that restricts the activator so it will only get activated/triggered when the event occurred with certain type of clicking
typeTarget
ONLY_AIR: Restricts the activator so it will only get activated/triggered when the event occurred when clicking only in the air, it means if you clicked on a block the activator won't get triggered. Don't get confuse ! You may think, what happens if I click on a player ? which will not be a block so its on the "air" well.. that even is outside the instance of PLAYER_(CLICK) type activators, that event is instance of PLAYER_CLICK_ON_PLAYER so the activator won't trigger too, it must be instance of PLAYER_(CLICK).
ONLY_BLOCK: Restricts the activator so it will only get activated/triggered when the event occurred with clicking only in a block. This means if you clicked on the air the activator won't get triggered.
This feature makes the activator a block instance activator so it will have blockCommands.
NO_TYPE_TARGET: Doesn't restrict the activator on the type of click, both type will be accepted, air clicks and block clicks.
Example:
[S_A_L] detailedClick
Type of activator category: Specific Activator List
⭐PLAYER_CLICK_ON_ENTITY
🔹PLAYER_CLICK_ON_PLAYER
Info: Feature that restricts the activator triggers only if the correct click is involved in the event.
detailedClick
RIGHT: Restricts the activator only work when the even occurred with the right click
LEFT: Restricts the activator only work when the even occurred with the left click
RIGHTORLEFT: Doesn't restrict the type of click for this activator, it will allow right and left click.
Example:
[S_A_L] mustBeAProjectileLaunchWithTheSameEI
Type of activator category: Specific Activator List
⭐PROJECTILE_ENTER_IN_LIQUID
⭐PROJECTILE_HIT_BLOCK
⭐PROJECTILE_HIT_ENTITY
🔹PROJECTILE_HIT_PLAYER
Info: Feature for the activator that are related to projectile, it affects if the activator should run with projectiles not launched by the same EI.
Example, there is an activator PROJECTILE_HIT_ENTITY, detailedSlots: [all slots] and on commands: ["say hi"]
If the feature is enabled, then it will only work if this ExecutableItem has another activator that has LAUNCH command, so, the projectile will be launched from the EI and then the condition will met
If the feature is disabled, all projectiles, such as: vanilla bow, vanilla snowball, projectiles from others ExecutableItems, and projectile for the ExecutableItem itself will run the activator.
Example:
[S_A_L] delay and delayTick
Type of activator category: Specific Activator List
⭐LOOP
Info: Features of the activator that changes the interval time where this activator triggers, it affects the behavior of the loop repetitions of the activator.
delay: Integer value that represents how many seconds will the loop be. This means, each <delay> [time] the loop will trigger again. e.g. (If the delay is 30 seconds then each 30 seconds the activator will trigger)
delayTick: Boolean value to set the delay time in ticks, otherwise it is in seconds. (20 ticks = 1 second)
Example:
Last updated
