-
Notifications
You must be signed in to change notification settings - Fork 4
Properties
This defines the item that will appear in your menu
id: DIAMOND_SWORD damage-value: 0 name: &eHello World
You can define a list of items that will be displayed in your menu. These items will be displayed according to your particles display mode
The menu item defined above will also be included in this list when the particle is loadedicons: - WOODEN_SWORD:0 - IRON_SWORD:0 - GOLDEN_SWORD:0
Labels let you define a unique identifier for this particle
You can use labels in/h set [player] [label]to quickly equip this particle
label: cool_sword
Mainly used for debugging, but useful for testing out new features.
tags: - arrows
en_US.lang contains a global equip message that players will see, but you can define your own for each particle.
Anytime the player uses this particle they'll see a custom equip message
equip-message: "oooh, shiny"
Give your particles a description. Players will see this when they move their mouse over the item
description: - "&aHere is some text" - "&aHere is even more text"
Add a description for players that don't have permission to use this particle
permission-description: - "&cSorry, but only &eVIP &ccan use this"
Here you can define a unique permission value for this particle. You don't need to include
particlehats.particle., that is automatically added
permission: vip
To use this value, just give your players the permission:particlehats.particle.vip
en_US.lang contains a global no permission message, but you can define a unique message that players will see when they try to use this particle
permission-denied: "&cOnly &eVIP &ccan use this"
You can define a left & right click action. Actions tell the plugin what to do next.
action: left-click: id: equip right-click: id: mimicSome Actions will need an additional argument to work correctly, like so:
action: left-click: id: open_menu argument: differentMenu.ymlSupported values are
The display mode Lets you define how items are displayed in menus. If you have more than one item to display, the
icon-update-frequencywill determine how frequently items will be swappeddisplay-mode: display_in_order icon-update-frequency: 2Supported values are
- display_in_order
- display_randomly
Define a custom sound this particle will make when a player clicks on it
sound: id: UI_BUTTON_CLICK volume: 1.0 pitch: 1.0
A potion effect will be given to this player when they have the particle equipped
potion: id: SPEED strength: 1
The Type that will be used when displaying particles
Normal Type
type: haloCustom Type
type: id: custom name: butterfly_wings_colorable
A starting position for your particle, you can fine-tune it by adjusting it's offset
location: headSupported values are
- head
- chest
- feet
Modes determine when particles are displayed
mode: active
Some Types can be toggled between static & animated
animated: true
If you have given this particle the Demo action then you can define how long this hat will stay equipped
duration: 200
If you have an economy enabled in config.yml, you can define the price of particles
price: 10
Defines how fast particles are moving
speed: 0
Define how many particles are displayed in each pass.
count: 1
Want to make a Type smaller? change it's scale
scale: 1.0
Granular control of where your particle is displayed, offset is relative to your Location
offset: x: 0 y: 0 z: 0
After using
offset, a random offset will be applied to the particlerandom-offset x: 0 y: 0 z: 0
Tweak the angle your particle's [[Type|https://github.com/MediusEcho/ParticleHats/wiki/Types]
angle: x: 0 y: 0 z: 0
Define how often this particle is displayed. Particles are checked 20 times a second (every server tick), an
update-frequencyof 2 means this particle will be checked every other tick
update-frequency: 2
Some types, such as the Cape, are designed to display relative to the players direction. others support multiple Tracking Methods
tracking: track_nothing
Here you can define what particle to display, depending on the Type picked, you can have multiple particles defined here
particles: '1': particle: SWEEP_ATTACKSome particles will need additional information to work correctly
Color Dataparticles: '1': particle: REDSTONE color: r: 255 g: 255 b: 255 # Size of the REDSTONE particle, only available on 1.13+ servers size: 1.0Block Data
particles: '1': particle: FALLING_DUST block-data: BLUE_WOOLItem Data
particles: '1': particle: ITEM_CRACK item-data: APPLEItem Stack Data
particles: '1': particle: ITEMSTACK items: - DIAMOND - GOLD_INGOT # How long items stay spawned in the world in ticks (20 = 1 second) item-duration: 20 # Item gravity is only supported on 1.10+ item-gravity: true item-velocity: x: 0 y: 0 z: 0
Nodes are secondary particles displayed along side the main particle. You can create up to 28 additional nodes. Each node is essentially it's own particle, they support all the properties listed above
nodes: '1': # All properties above '2': # All properties above