# Custom Effect Format

BattleArena has support for custom effects in a few places that are primarily cosmetic.

### Particle

<table border="1" id="bkmrk-name-description-typ" style="border-collapse: collapse; width: 100%; height: 184.4px;"><colgroup><col style="width: 33.3333%;"></col><col style="width: 33.3333%;"></col><col style="width: 33.3333%;"></col></colgroup><tbody><tr style="height: 29.8px;"><td style="height: 29.8px;">**Name**  
</td><td style="height: 29.8px;">**Description**  
</td><td style="height: 29.8px;">**Type**  
</td></tr><tr style="height: 35.4px;"><td style="height: 35.4px;">particle  
</td><td style="height: 35.4px;">The name of the particle. See [Particle](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Particle.html).  
</td><td style="height: 35.4px;">&lt;Particle&gt;  
</td></tr><tr style="height: 29.8px;"><td style="height: 29.8px;">speed  
</td><td style="height: 29.8px;">The speed of the particle.  
</td><td style="height: 29.8px;">&lt;number&gt;  
</td></tr><tr style="height: 29.8px;"><td style="height: 29.8px;">count  
</td><td style="height: 29.8px;">The number of particles to display.  
</td><td style="height: 29.8px;">&lt;number&gt;  
</td></tr><tr style="height: 29.8px;"><td style="height: 29.8px;">offset  
</td><td style="height: 29.8px;">The offset of the particle.  
</td><td style="height: 29.8px;">Position: &lt;x,y,z&gt;  
</td></tr><tr style="height: 29.8px;"><td style="height: 29.8px;">data  
</td><td style="height: 29.8px;">The data for the particle.  
</td><td style="height: 29.8px;">Will vary for each particle (i.e. item\_crack will use [Item](https://docs.bplug.in/books/user-guide/page/item-syntax))  
</td></tr></tbody></table>

### Firework

<table border="1" id="bkmrk-name-description-typ-1" style="border-collapse: collapse; width: 100%; height: 225.4px;"><colgroup><col style="width: 33.3333%;"></col><col style="width: 33.3333%;"></col><col style="width: 33.3333%;"></col></colgroup><tbody><tr style="height: 29.8px;"><td style="height: 29.8px;">**Name**  
</td><td style="height: 29.8px;">**Description**  
</td><td style="height: 29.8px;">**Type**  
</td></tr><tr style="height: 46.6px;"><td style="height: 46.6px;">firework-type  
</td><td style="height: 46.6px;">The type of firework to display. See [FireworkEffect.Type](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/FireworkEffect.Type.html).  
</td><td style="height: 46.6px;">&lt;FireworkEffect.Type&gt;  
</td></tr><tr style="height: 29.8px;"><td style="height: 29.8px;">flicker  
</td><td style="height: 29.8px;">Whether the firework should flicker.  
</td><td style="height: 29.8px;">&lt;true|false&gt;  
</td></tr><tr style="height: 29.8px;"><td style="height: 29.8px;">trail  
</td><td style="height: 29.8px;">Whether the firework should have a trail.  
</td><td style="height: 29.8px;">&lt;true|false&gt;  
</td></tr><tr style="height: 29.8px;"><td style="height: 29.8px;">colors  
</td><td style="height: 29.8px;">The colors of the firework.  
</td><td style="height: 29.8px;">Color list:  
- \[#&lt;hex&gt;...\]  
</td></tr><tr style="height: 29.8px;"><td style="height: 29.8px;">fade-colors  
</td><td style="height: 29.8px;">The colors the firework should fade to.  
</td><td style="height: 29.8px;">Color list:  
- \[#&lt;hex&gt;...\]</td></tr></tbody></table>

### Freeze

<table border="1" id="bkmrk-name-description-typ-2" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 33.3333%;"></col><col style="width: 33.3333%;"></col><col style="width: 33.3333%;"></col></colgroup><tbody><tr><td>**Name**  
</td><td>**Description**  
</td><td>**Type**  
</td></tr><tr><td>duration  
</td><td>How long to freeze the player for. See [Time Format](https://docs.bplug.in/books/user-guide/page/time-format).  
</td><td>&lt;Duration&gt;  
</td></tr><tr><td>radius  
</td><td>In what radius players should be frozen for, if applicable.   
</td><td>&lt;number&gt;  
</td></tr></tbody></table>

### Single-line Format

This is the most common use of effects in BattleArena, and follows a very similar format to that seen in the [Action Reference](https://docs.bplug.in/books/user-guide/page/action-reference). Note that options are separated using the semicolon (**;**).

#### Examples:

```yaml
effects:
  - particle{particle=flame;speed=0.01;count=15;offset=0.3,0.7,0.3}
  - freeze{duration=5s}
```

### Configuration Node Format

While less common, this format may be seen to represent effects as well. Rather than the effect properties existing on a single line, they are defined over a configuration node. Here is an example of how that may look:

```yaml
my-effect:
  firework-type: ball
  flicker: true
  trail: false
  colors:
    - "#fcba03"
    - "#fcba03"
  fade-colors:
    - "#878378"
```