Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
plugin:extrafireworks:commands [2021/02/06 22:58] – created phoenix616plugin:extrafireworks:commands [2022/07/18 12:52] (current) – Add give command phoenix616
Line 12: Line 12:
  
 Allows reloading of the plugin config. Allows reloading of the plugin config.
 +
 +## Give Firework Rocket
 +
 +**Usage:** `/ef give <player> rocket <effect> <power> [<config>]`  
 +**Example:** `/ef give Phoenix616 rocket text 2 {colors:["0,255,0","255,0,0"],particle: redstone, text: "The Text", box: true}`  
 +**Permission:** `extrafireworks.command.give`
 +
 +Allows giving a firework rocket to a specific player. The firework effect type can be both [Vanilla](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/FireworkEffect.Type.html#enum.constant.summary) and [ExtraFirework's effects](https://wiki.phoenix616.dev/plugin:extrafireworks:effects) (including custom defined ones in the config).
 +
 +## Give Firework Star
 +
 +**Usage:** `/ef give <player> star <effect> [<config>]`  
 +**Example:** `/ef give Phoenix616 star text {colors:["0,255,0","255,0,0"],particle: redstone, text: "The Text", box: true}`  
 +**Permission:** `extrafireworks.command.give`
 +
 +Allows giving a firework star to a specific player. The firework effect type can be both [Vanilla](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/FireworkEffect.Type.html#enum.constant.summary) and [ExtraFirework's effects](https://wiki.phoenix616.dev/plugin:extrafireworks:effects) (including custom defined ones in the config).
 +
 +## Launch
 +
 +**Usage:** `/ef launch <effect> [<world>,]<x>,<y>,<z> <power> [<config>]`  
 +**Example:** `/ef launch text -1914,63,-898 2 {motion:"0.5,0.8,-0.5",colors:["0,255,0","255,0,0"],particle: redstone, text: "The Text", box: true}`  
 +**Permission:** `extrafireworks.command.launch`
 +
 +Allows launching of fireworks at specific locations. The firework effect type can be both [Vanilla](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/FireworkEffect.Type.html#enum.constant.summary) and [ExtraFirework's effects](https://wiki.phoenix616.dev/plugin:extrafireworks:effects) (including custom defined ones in the config).
  
 ## Show ## Show
  
 **Usage:** `/ef show <effect> [<world>,]<x>,<y>,<z> [<config>]`   **Usage:** `/ef show <effect> [<world>,]<x>,<y>,<z> [<config>]`  
-**Example:** `/ef show text-1914,63,-898 {colors:["0,255,0","255,0,0"],particle: redstone, text: "The Text", box: true}`  +**Example:** `/ef show text -1914,63,-898 {colors:["0,255,0","255,0,0"],particle: redstone, text: "The Text", box: true}`  
 **Permission:** `extrafireworks.command.show` **Permission:** `extrafireworks.command.show`
  
Line 24: Line 48:
  
 ### Available for all types ### Available for all types
 +
 +#### motion
 +
 +A string in the format of `x,y,z` (e.g. `motion: "0.5,0.8,-0.6"`) which contains motion/direction information into which the firework should fly. Some effects also get changed based on that direction if the `direction` tag isn't explicitly specified. (Currently only fountains)
  
 #### color #### color
Line 60: Line 88:
  
 The direction an effect should be rotated in. (does nothing with fountain, snow, or explosion) E.g. `yaw: 100.0`. The direction an effect should be rotated in. (does nothing with fountain, snow, or explosion) E.g. `yaw: 100.0`.
 +
 +#### direction
 +
 +The direction vector string in the format of `x,y,z` an effect should point in. (currently only used for fountain) E.g. `direction: "0,1,0"` for up.
  
 #### box #### box
Line 80: Line 112:
  
 Set the snow strength. Can be any valid integer. The default values are 1, 2, and 3 respectively depending on the amount of modifier items in the recipe. Set the snow strength. Can be any valid integer. The default values are 1, 2, and 3 respectively depending on the amount of modifier items in the recipe.
 +
 +#### texture
 +
 +The texture id of a head item for the head effect. Queries from the `skins.download.texture` URL.
 +
 +#### owner
 +
 +The user name or uuid of the player for the head effect. (Only one of `texture` and `owner` is necessary!)
  
 #### count #### count
  
 Changes the count of some particles in some effects. Changes the count of some particles in some effects.
 +
 +### Available for "custom" Effects
 +
 +By using `custom` as the effect name in the command you can directly display [[plugin:extrafireworks:config#custom|custom effects]] without having to set them up in the config beforehand.
 +
 +#### image
 +The image in the images folder on which the custom effect is based on.
 +
 +#### scale
 +The scale of the image (blocks per pixel)
 +
 +#### density
 +How many particles should be used to display one pixel
 +
 +#### transparent
 +Whether the effect should display dark color as transparent. (`true`/`false`)
 +
 +#### sounds
 +Specify custom sounds to play at the explosion location when the effect gets displayed. See [this list](https://minecraft.fandom.com/wiki/Sounds.json#Java_Edition_values) for sounds available in the Vanilla game. (Resource pack sounds are supported too!)
 +
 +Can be multiple and omit the category or volume or pitch and uses the following syntax: `<sound>[,<category>][,<volume>[,<pitch>]]`