Plugin Information

πŸ€– 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, broadcast messages, play sounds, set gamemodes, and much more.

You can create interactive menus, NPC interactions, double jump, and other type of interactionsin your plugin using these action types.

Action Builder

#Action Types

Action Type Description
[MESSAGE] Display a custom message to the player
[BROADCAST] Broadcast a message to every online player
[BROADCAST_WORLD] Broadcast a message to the player's world
[BROADCAST_SOUND] Play a sound for every online player
[BROADCAST_SOUND_WORLD] Play a sound for the player's world
[TITLE] Display a custom title message to the player
[ACTION_BAR] This is a custom action bar
[PROXY] Redirect the player to a specific server
[TRANSFER] Send the player to another network
[QUEUE] Put the player in the queue for a server
[VISIBILITY] Change the player's player-visibility state
[CLOSE_INVENTORY] Close the player's current inventory
[COMMAND] Execute a command (console or player)
[GAMEMODE] Set the player's gamemode
[POTION_EFFECT] Apply a potion effect to the player
[SOUND] Play a sound for the player
[PLAY_DISC] Play a music disc for the player
[STOP_DISC] Stop the music disc the player is hearing
[MENU] Open a custom menu
[DELAY] A way to delay some 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.

#Send Chat Message

This action sends a custom message to the player.

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

#Broadcast Message

This action sends a message to every player online.

  • Syntax: [BROADCAST] <message>
  • Example: [BROADCAST] &a%player% just joined the lobby

#Broadcast Message to World

This action sends a message to every player in the world the player is in.

  • Syntax: [BROADCAST_WORLD] <message>
  • Example: [BROADCAST_WORLD] &aThe event is starting

#Broadcast Sound

This action plays a sound for every player online.

  • Syntax: [BROADCAST_SOUND] <sound>; <volume>; <pitch>
  • Example: [BROADCAST_SOUND] entity_player_levelup; 1; 1

#Broadcast Sound to World

This action plays a sound for every player in the world the player is in.

  • Syntax: [BROADCAST_SOUND_WORLD] <sound>; <volume>; <pitch>
  • Example: [BROADCAST_SOUND_WORLD] entity_player_levelup; 1; 1

#Send Title Message

This action displays a custom title message to the player.

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

#Send Action Bar Message

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

  • Syntax: [ACTION_BAR] <message>
  • Example: [ACTION_BAR] This is a custom action bar

#Connect to Proxy server

This action redirects the player to a specified server using your proxy (BungeeCord & Velocity).

  • Syntax: [PROXY] <serverName>
  • Example: [PROXY] lobby

circle-info

[BUNGEE] is the old name for this action and still works, so an existing config does not need rewriting. It is hidden from the action builder, but you will meet it in the default menus/servers.yml. New actions should use [PROXY].

#Transfer to another Network

This action sends the player to a completely different server address, without a proxy.

  • Syntax: [TRANSFER] <host>; <port>
  • Example: [TRANSFER] play.example.com; 25565

circle-info

This one needs Paper 1.20.5 or newer, and the player has to be on 1.20.5 or newer as well.

Two things can stop a transfer, and each tells the player why:

  • On a server too old to transfer at all, they are told transfers are not supported.
  • If the destination refuses them, they are told the transfer is unavailable. A server only accepts arrivals with accepts-transfers set to true in its server.properties, so that is the first thing to check.

#Join Server Queue

This action puts the player in the queue for a server instead of connecting right away. Requires the proxy plugin with the queue enabled.

  • Syntax: [QUEUE] <serverName>
  • Example: [QUEUE] skyblock

#Player Visibility

This action changes whether the player can see other players.

  • Syntax: [VISIBILITY] <on/off/toggle>
  • Example: [VISIBILITY] toggle

#Close Inventory

This action closes the inventory the player has open.

  • Syntax: [CLOSE_INVENTORY]
  • Example: [CLOSE_INVENTORY]

#Execute Command

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

  • Syntax: [COMMAND] <target>; <command>
  • Example: [COMMAND] console; mvtp %player% world
  • Example: [COMMAND] player; warp spawn

%player% is replaced with the player's name, which is what lets a console command act on them.

circle-info

A player command is run the way the player typing it would be, so other plugins see it exactly as they see a real command. The queue commands are the one exception: behind a proxy, queue, joinqueue and leavequeue are forwarded to the proxy instead, so [COMMAND] player; queue survival works from a lobby even though the command only exists on the proxy.

#Change Gamemode

This action sets the gamemode for the player.

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

#Give Potion Effect

This action gives the player a potion effect.

  • Syntax: [POTION_EFFECT] <effect>; <duration>; <amplifier>
  • Example: [POTION_EFFECT] speed; 5; 2

#Play Sound

This action plays a sound for the player.

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

#Play Music Disc

This action plays a music disc for the player. Any disc already playing is stopped first.

  • Syntax: [PLAY_DISC] <disc>
  • Example: [PLAY_DISC] cat
  • Example: [PLAY_DISC] pigstep

#Stop Music Disc

This action stops the music disc the player is currently hearing.

  • Syntax: [STOP_DISC]
  • Example: [STOP_DISC]

#Open Menu

This action opens a custom graphical user interface (GUI) menu.

  • Syntax: [MENU] <menu_name>
  • Example: [MENU] servers
  • Example: [MENU] lobbies

The name is the file name of the menu, without the .yml. Building one of your own is covered on Menus.

#Delay

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

  • Syntax: [DELAY] <seconds>
  • Example: [DELAY] 3
Last updated about 2 hours ago
My Cart (0 items)

Oops... looks like the spiders padded through here

Add products to your cart and remove them from here Lets buy