From 0eb8a0e574ef8b35709e60fbc7bc3842756042a8 Mon Sep 17 00:00:00 2001 From: Andre_601 Date: Fri, 1 Mar 2024 00:59:30 +0100 Subject: [PATCH] Improve actions page --- docs/general/actions.md | 58 ++++++++++++++++++++++++++++------------- 1 file changed, 40 insertions(+), 18 deletions(-) diff --git a/docs/general/actions.md b/docs/general/actions.md index 55737e5..b3ba07f 100644 --- a/docs/general/actions.md +++ b/docs/general/actions.md @@ -31,48 +31,70 @@ These click types are used in the [`addaction` page command](commands/hologram-p ### `#!command MESSAGE:` { #message } -Sends `#!command ` to the player who clicked the hologram. +> Sends a message to the player who clicked the hologram. +> +> - `#!command ` - The message to send. Supports Placeholders, including PlaceholderAPI. ### `#!command COMMAND:` { #command } -Executes `#!command ` as the player who clicked the hologram. If `#!command ` doesn't start with `/` will it be send as a message from the player. +> Executes a command as the player who clicked the hologram. Should the specified command not start with a `/` will it instead be send as a message by the player. +> +> - `#!command ` - The command to execute as the player. Supports Placeholders, including PlaceholderAPI. ### `#!command CONSOLE:` { #console } -Executes `#!command ` as the console. - -/// warning | Important -This action will not work with commands provided by a BungeeCord/Velocity proxy or a plugin running on one. -/// +> /// warning | Important +> Commands only available through a proxy cannot be executed by this Action. +> /// +> +> Executes the specified command through the console. +> +> - `#!command ` - The command to execute as the player. Supports Placeholders, including PlaceholderAPI. ### `#!command CONNECT:` { #connect } -Sends the player who clicked to `#!command `. Only works on a BungeeCord/Velocity network. +> Sends the player who clicked the hologram to the specified Server. This action only works with Servers connected to a BungeeCord/Velocity proxy. +> +> - `#!command ` - Name of the server the player should be connected to. ### `#!command TELEPORT::::` / `#!command TELEPORT:::` { #teleport } -Teleports the player to the provided world and coordinates. If no world is provided will the world the player is in be used. +> Teleports the player who clicked the hologram to the specified coordinates, and optionally world. +> +> - `#!command ` - World to teleport the player to. This is optional and defaults to the world the player is in. +> - `#!command ` - X coordinate to teleport the player to. +> - `#!command ` - Y coordinate to teleport the player to. +> - `#!command ` - Z coordinate to teleport the player to. ### `#!command SOUND:::` / `#!command SOUND:` { #sound } -Plays a sound for the player who clicked the hologram. -If no volume and pitch are provided will `1.0` be used for both, playing the sound with default volume and pitch. - -What sounds you can use depends on the server version. A list of known sound names for each version can be found here: -https://docs.andre601.ch/Spigot-Sounds{ target="_blank" rel="nofollo" } +> Plays the specified sound, optionally with a set volume and pitch, to the player who clicked the Hologram. +> +> - `#!command ` - Name of the sound to play. A list of available sounds is found [here](https://docs.andre601.ch/Spigot-Sounds){ target="_blank" rel="nofollow" } +> - `#!command ` - Optional volume to set. Default if not set is `1.0`. +> - `#!command ` - Optional pitch to set. Default if not set is `1.0`. ### `#!command PERMISSION:` { #permission } -Checks whether the player who clicked has the specified permission and if not, all the actions after this one will not be executed. +> Checks whether the player who clicked the Hologram has the specified permission. Unlike other actions does this one act differently by stopping any actions after it from executing, should the player not have the permission. +> +> - `#!command ` - The permission to check. ### `#!command NEXT_PAGE:` / `NEXT_PAGE` { #next_page } -Switches to the next page of the specified hologram. If no hologram is provided will the one the player clicked on be used. +> Changes the page of the (optionally specified) Hologram to the next one, if one is available. +> +> - `#!command ` - Optional Hologram to change the page of. Defaults to the Hologram the player clicked on, if not set. ### `#!command PREV_PAGE:` / `PREV_PAGE` { #prev_page } -Switches to the previous page of the specified hologram. If no hologram is provided will the one the player clicked on be used. +> Changes the page of the (optionally specified) Hologram to the previous page, if one is available. +> +> - `#!command ` - Optional Hologram to change the page of. Defaults to the Hologram the player clicked on, if not set. ### `#!command PAGE::` / `#!command PAGE:` { #page } -Switches to the specified page of the specified hologram. If no hologram is provided will the one the player clicked on be used. +> Changes to the specified page on the (optionally specified) Hologram, if one is available. +> +> - `#!command ` - Optional Hologram to change the page of. Defaults to the Hologram the player clicked on, if not set. +> - `#!command ` - Page to switch to on the Hologram.