diff --git a/docs/general/actions.md b/docs/general/actions.md index c86758c..3fcd67c 100644 --- a/docs/general/actions.md +++ b/docs/general/actions.md @@ -22,169 +22,169 @@ The following action types are available to use. ### `#!command MESSAGE:` { #message } -: Sends a message to the player who clicked the hologram. - - - `#!command ` - The message to send. Supports Placeholders, including PlaceholderAPI. - - /// details | Example - type: example - - ``` - MESSAGE:You clicked this Hologram! # Sends "You clicked this Hologram!" to the player. - ``` - /// +Sends a message to the player who clicked the hologram. + +- `#!command ` - The message to send. Supports Placeholders, including PlaceholderAPI. + +/// details | Example + type: example + +``` +MESSAGE:You clicked this Hologram! # Sends "You clicked this Hologram!" to the player. +``` +/// ---- ### `#!command COMMAND:` { #command } -: 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. +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. + +/// details | Examples + type: example - /// details | Examples - type: example - - ``` - COMMAND:/help # Executes /help as the player. - COMMAND:My name is {player} # Sends "My name is {player}" as the player. - ``` - /// +``` +COMMAND:/help # Executes /help as the player. +COMMAND:My name is {player} # Sends "My name is {player}" as the player. +``` +/// ---- ### `#!command CONSOLE:` { #console } -: /// warning | Proxy commands cannot be executed by this action! - /// - - Executes the specified command through the console. - - - `#!command ` - The command to execute as the console. Supports Placeholders, including PlaceholderAPI. +/// warning | Proxy commands cannot be executed by this action! +/// - /// details | Example - type: example - - CONSOLE:say {player} clicked on a Hologram! # Executes "/say {player} clicked on a Hologram!" as the console. - /// +Executes the specified command through the console. + +- `#!command ` - The command to execute as the console. Supports Placeholders, including PlaceholderAPI. + +/// details | Example + type: example + +CONSOLE:say {player} clicked on a Hologram! # Executes "/say {player} clicked on a Hologram!" as the console. +/// ---- ### `#!command CONNECT:` { #connect } -: 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. +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. - /// details | Example - type: example - - CONNECT:lobby # Connects the player to the server named "lobby". - /// +/// details | Example + type: example + +CONNECT:lobby # Connects the player to the server named "lobby". +/// ---- ### `#!command TELEPORT:[:]::` { #teleport } -: Teleports the player who clicked the hologram to the specified coordinates, and optionally world. - - - `#!command [:]` - Optional `#!command ` to teleport the player to. Defaults to the World the player is in, if not specified. - - `#!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 [::]` - Optional `#!command ` and `#!command ` to set for the teleportation. Defaults to the current Yaw and Pitch of the player if not set. - - /// details | Example - type: example - - TELEPORT:0:100:0 # Teleports player to 0,100,0 in the World they are. - TELEPORT:world:0:100:0 # Teleports player to 0,100,0 in World "world". - TELEPORT:0:100:0:-180:0 # Teleports player to 0,100,0 in the World they are, facing North. - TELEPORT:world:0:100:0:-180:0 # Teleports player to 0,100,0 in World "world", facing North. - /// +Teleports the player who clicked the hologram to the specified coordinates, and optionally world. + +- `#!command [:]` - Optional `#!command ` to teleport the player to. Defaults to the World the player is in, if not specified. +- `#!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 [::]` - Optional `#!command ` and `#!command ` to set for the teleportation. Defaults to the current Yaw and Pitch of the player if not set. + +/// details | Example + type: example + +TELEPORT:0:100:0 # Teleports player to 0,100,0 in the World they are. +TELEPORT:world:0:100:0 # Teleports player to 0,100,0 in World "world". +TELEPORT:0:100:0:-180:0 # Teleports player to 0,100,0 in the World they are, facing North. +TELEPORT:world:0:100:0:-180:0 # Teleports player to 0,100,0 in World "world", facing North. +/// ---- ### `#!command SOUND:[::]` { #sound } -: 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 `#!command ` and `#!command ` with both defaulting to 1.0 if not set. +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 `#!command ` and `#!command ` with both defaulting to 1.0 if not set. - /// details | Examples - type: example +/// details | Examples + type: example - ``` - SOUND:ENTITY_CREEPER_PRIMED # "Creeper Primed" sound at normal volume and pitch. - SOUND:ENTITY_CREEPER_PRIMED:0.5:0.5 # "Creeper Primed" sound at half the volume and pitch. - ``` - /// +``` +SOUND:ENTITY_CREEPER_PRIMED # "Creeper Primed" sound at normal volume and pitch. +SOUND:ENTITY_CREEPER_PRIMED:0.5:0.5 # "Creeper Primed" sound at half the volume and pitch. +``` +/// ---- ### `#!command PERMISSION:` { #permission } -: 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. +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. - /// details | Examples - type: example +- `#!command ` - The permission to check. - ``` - PERMISSION:some.permission.here # Checks for permission some.permission.here - ``` - /// +/// details | Examples + type: example + +``` +PERMISSION:some.permission.here # Checks for permission some.permission.here +``` +/// ---- ### `#!command NEXT_PAGE[:]` { #next_page } -: Changes the page of the (optionally specified) Hologram to the next one, if one is available. - - - `#!command [:]` - Optional Hologram `#!command ` to change the page of. Defaults to the Hologram the player clicked on, if not set. +Changes the page of the (optionally specified) Hologram to the next one, if one is available. + +- `#!command [:]` - Optional Hologram `#!command ` to change the page of. Defaults to the Hologram the player clicked on, if not set. - /// details | Examples - type: example +/// details | Examples + type: example - ``` - NEXT_PAGE # Moves to the next page of the Hologram the player clicks. - NEXT_PAGE:some_hologram # Moves to the next page of the Hologram "some_hologram". - ``` - /// +``` +NEXT_PAGE # Moves to the next page of the Hologram the player clicks. +NEXT_PAGE:some_hologram # Moves to the next page of the Hologram "some_hologram". +``` +/// ---- ### `#!command PREV_PAGE[:]` { #prev_page } -: Changes the page of the (optionally specified) Hologram to the previous page, if one is available. - - - `#!command [:]` - Optional Hologram `#!command ` to change the page of. Defaults to the Hologram the player clicked on, if not set. +Changes the page of the (optionally specified) Hologram to the previous page, if one is available. - /// details | Examples - type: example +- `#!command [:]` - Optional Hologram `#!command ` to change the page of. Defaults to the Hologram the player clicked on, if not set. - ``` - PREV_PAGE # Moves to the previous page of the Hologram the player clicks. - PREV_PAGE:some_hologram # Moves to the previous page of the Hologram "some_hologram". - ``` - /// +/// details | Examples + type: example + +``` +PREV_PAGE # Moves to the previous page of the Hologram the player clicks. +PREV_PAGE:some_hologram # Moves to the previous page of the Hologram "some_hologram". +``` +/// ---- ### `#!command PAGE:[:]` { #page } -: Changes to the specified page on the (optionally specified) Hologram, if one is available. - - - `#!command [:]` - Optional Hologram `#!command ` to change the page of. Defaults to the Hologram the player clicked on, if not set. - - `#!command ` - Page to switch to on the Hologram. +Changes to the specified page on the (optionally specified) Hologram, if one is available. + +- `#!command [:]` - Optional Hologram `#!command ` to change the page of. Defaults to the Hologram the player clicked on, if not set. +- `#!command ` - Page to switch to on the Hologram. - /// details | Examples - type: example +/// details | Examples + type: example - ``` - PAGE:2 # Switches to page 2 of the Hologram the player clicked. - PAGE:some_hologram:1 # Switches to page 2 of the Hologram "some_hologram". - ``` - /// +``` +PAGE:2 # Switches to page 2 of the Hologram the player clicked. +PAGE:some_hologram:1 # Switches to page 2 of the Hologram "some_hologram". +``` +///