🤖 Action Types

Actions that are used on our plugin

In our system's configuration files, you can utilize various action types to perform different actions. These actions enable you to interact with players, send messages, play sounds, set gamemodes, and much more.

Actions run from four places:

Menu buttons, from the actions of any button in a shop menu.
Shop actions, when a player buys, sells, is refused, clicks, turns a page or uses the amount, fill and back buttons in a shop.
Category actions ⭐, when a player opens or closes a category.
Deny actions ⭐, when a requirement stops a player from buying or selling an item.

#Action Types

Action Type	Description	Where
[ACTION_BAR]	Display a custom action bar to the player	Everywhere
[CLOSE_INVENTORY]	Close the player's current inventory	Everywhere
[SOUND]	Play a sound for the player	Everywhere
[TITLE]	Display a custom title message to the player	Everywhere
[DELAY]	A way to delay some actions	Everywhere
[MESSAGE] ⭐	Display a custom message to the player	Everywhere
[COMMAND] ⭐	Execute a command (console or player)	Everywhere
[GAMEMODE] ⭐	Set the player's gamemode	Everywhere
[PARTICLE] ⭐	Show particles around the player	Everywhere
[CATEGORY]	Open a category	Everywhere
[SHOP]	Open a shop's main menu	Everywhere
[ENCHANT] ⭐	Enchant the item in the player's hand	Deny actions
[PERMISSION] ⭐	Give or take a permission	Deny actions

Explore each action type to learn more about its syntax and usage. Examples are provided to illustrate how to use these actions effectively in your system or application.

The actions do not replace any placeholder themselves. In a menu button, the menu's own placeholders are filled in before the action runs, so a button in a category can use %player%. See Placeholders.

#Send Action Bar Message

This action displays a custom action bar message to the player.

Syntax: [ACTION_BAR] <message>
Example: [ACTION_BAR] &aThanks for shopping

#Close Inventory

This action closes the inventory the player has open.

Syntax: [CLOSE_INVENTORY]
Example: [CLOSE_INVENTORY]

#Play Sound

This action plays a sound for the player.

Syntax: [SOUND] <sound>; <volume>; <pitch>
Example: [SOUND] entity_experience_orb_pickup; 1; 1

#Send Title Message

This action displays a custom title message to the player. The timings are in ticks.

Syntax: [TITLE] <title>; <subtitle>; <fadein>; <stay>; <fadeout>
Example: [TITLE] &aCustom title; &7Custom Subtitle; 20; 40; 20

#Delay

This action will make a short pause until it continues executing actions.

Syntax: [DELAY] <seconds>
Example: [DELAY] 3
Example: [DELAY] 0.5

#Open a Category

This action opens a category for the player, with the same checks as clicking it in the main menu: the shop's and the category's conditions apply and a disabled category does not open. A hidden category opens.

Syntax: [CATEGORY] <category> or [CATEGORY] <shop>:<category>
Example: [CATEGORY] ores
Example: [CATEGORY] blocks:wool

Without a shop, the category is looked up in the shop the action runs in. Outside a shop menu, such as in a deny action, write the shop as well.

#Open a Shop

This action opens a shop's main menu for the player, with the same checks as its open command.

Syntax: [SHOP] <shop>
Example: [SHOP] blocks

#Send Chat Message ⭐

This action sends a custom message to the player.

Syntax: [MESSAGE] <message>
Example: [MESSAGE] &aThis is a custom message

Semicolons inside the message are kept, so you do not have to escape them.

#Execute Command ⭐

This action executes a command either from the console or as a player.

Syntax: [COMMAND] <target>; <command>
Example: [COMMAND] console; give %player% diamond 1
Example: [COMMAND] player; spawn

The target has to be either console or player. A leading / is optional.

#Change Gamemode ⭐

This action sets the gamemode for the player.

Syntax: [GAMEMODE] <gamemode>
Example: [GAMEMODE] adventure

#Show Particles ⭐

This action spawns particles at the player's location, seen only by that player.

Syntax: [PARTICLE] <particle>; <count>; <offset x>; <offset y>; <offset z>
Example: [PARTICLE] happy_villager; 20; 0.5; 1; 0.5

Particles that need a color, a block or an item, such as dust, are skipped.

#Enchant Held Item ⭐

This action adds an enchantment to the item in the player's main hand. Nothing happens when the hand is empty.

Syntax: [ENCHANT] <enchantment>; <level>
Example: [ENCHANT] sharpness; 5

#Give or Take a Permission ⭐

This action gives the player a permission, or takes it away when remove is added. It needs Vault and a permissions plugin hooked into Vault.

Syntax: [PERMISSION] <permission>; [remove]
Example: [PERMISSION] essentials.fly
Example: [PERMISSION] essentials.fly; remove

Last updated about 1 hour ago