Skip to content

Properties

Jump to bottom
Jacob edited this page Sep 8, 2019 · 3 revisions

Content

Menu item

This defines the item that will appear in your menu

id: DIAMOND_SWORD  
damage-value: 0
name: &eHello World
Content ▲

Icons

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 loaded

icons:
- WOODEN_SWORD:0
- IRON_SWORD:0
- GOLDEN_SWORD:0
Content ▲

Labels

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

Content ▲

Tags

Mainly used for debugging, but useful for testing out new features.

tags:
- arrows
Content ▲

Custom Equip Message

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"

Content ▲

Description

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"
Content ▲

Permission Description

Add a description for players that don't have permission to use this particle

permission-description:
- "&cSorry, but only &eVIP &ccan use this"
Content ▲

Permission

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

Content ▲

Permission Denied

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"

Content ▲

Actions

You can define a left & right click action. Actions tell the plugin what to do next.

action:
  left-click:
    id: equip
  right-click:
    id: mimic

Some Actions will need an additional argument to work correctly, like so:

action:
  left-click:
    id: open_menu
    argument: differentMenu.yml

Supported values are

Content ▲

Display Mode

The Display Mode Lets you define how items are displayed in menus. If you have more than one item to display, the icon-update-frequency will determine how frequently items will be swapped

display-mode: display_in_order
icon-update-frequency: 2

Supported values are

  • display_in_order
  • display_randomly
Content ▲

Sound

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
Content ▲

Potions

A potion effect will be given to this player when they have the particle equipped

potion:
  id: SPEED
  strength: 1
Content ▲

Type

The Type that will be used when displaying particles

Normal Type
type: halo

Custom Type

type:
  id: custom
  name: butterfly_wings_colorable
Content ▲

Location

A starting position for your particle, you can fine-tune it by adjusting it's offset

location: head

Supported values are

  • head
  • chest
  • feet
Content ▲

Mode

Modes determine when particles are displayed

mode: active

Content ▲

Animated

Some Types can be toggled between static & animated

animated: true

Content ▲

Duration

If you have given this particle the Demo action then you can define how long this hat will stay equipped

duration: 200

Content ▲

Price

If you have an economy enabled in config.yml, you can define the price of particles

price: 10

Content ▲

Speed

Defines how fast particles are moving

speed: 0

Content ▲

Count

Define how many particles are displayed in each pass.

count: 1

Content ▲

Scale

Want to make a Type smaller? change it's scale

scale: 1.0

Content ▲

Offset

Granular control of where your particle is displayed, offset is relative to your Location

offset:
  x: 0
  y: 0
  z: 0
Content ▲

Random Offset

After using offset, a random offset will be applied to the particle

random-offset
  x: 0
  y: 0
  z: 0
Content ▲

Angle

Tweak the angle your particle's [[Type|https://github.com/MediusEcho/ParticleHats/wiki/Types]

angle:
  x: 0
  y: 0
  z: 0
Content ▲

Update Frequency

Define how often this particle is displayed. Particles are checked 20 times a second (every server tick), an update-frequency of 2 means this particle will be checked every other tick

update-frequency: 2

Content ▲

Tracking Method

Some types, such as the Cape, are designed to display relative to the players direction. others support multiple Tracking Methods

tracking: track_nothing

Content ▲

Particles

Here you can define what particle to display, depending on the Type picked, you can have multiple particles defined here

particles:
  '1':
    particle: SWEEP_ATTACK

Some particles will need additional information to work correctly
Color Data

particles:
  '1':
    particle: REDSTONE
    color:
      r: 255
      g: 255
      b: 255
    # Size of the REDSTONE particle, only available on 1.13+ servers
    size: 1.0

Block Data

particles:
  '1':
    particle: FALLING_DUST
    block-data: BLUE_WOOL

Item Data

particles:
  '1':
    particle: ITEM_CRACK
    item-data: APPLE

Item 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
Content ▲

Nodes

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
Content ▲

Getting Started

Particles

Editing

Configuration

Languages

API

Legacy Wiki (v3.7.5)

Clone this wiki locally