updated layout and informations authored by Lxlp's avatar Lxlp
## Description ## Description
Creates a line of particles from the caster to the targeted entity or location. Extension of the [Particle Effect](/skills/effects/particles). Creates a line of particles from the caster to the targeted entity or location.
A list of particle types can be found [here](/skills/effects/particles/types).
## Attributes ## Attributes
| Attribute | Aliases | Description | Default |
This effect extends the general [Particle Effect](/skills/effects/particles) and uses all attributes from it. |-----------|-----------|----------------------------------------------------------------------|---------|
| distanceBetween | db | The distance between each point in the line | 0.25 |
Particle attributes are “per point” in this effect, so keeping 'amount' low is recommended. | startYOffset | syo, ystartoffset, ys| Offset Y location of the starting point of the line | 0 |
| targetYOffset | tyo, ytargetoffset, yt | Offset Y location of the target point of the line | 0 |
| Attribute | Alias | Description | Default Value | | fromOrigin | fo | Whether to draw the line from the [@origin] instead | false |
| --------------- | -------- | --------------------------------------------------- | ------------- | | zigzag | zz | Whether to draw the line to the target as a zigzag | false |
| distanceBetween | db | The distance between each point in the line | 0.25 | | zigzags | zzs | Amount of zigzags when using the zigzag option | 10 |
| startYOffset | syo | Offset Y location of the starting point of the line | 0 | | zigzagOffset | zzo | Offset of each zigzag | 0.2 |
| targetYOffset | tyo | Offset Y location of the target point of the line | 0 | | maxdistance | md | The maximum distance the line can reach | 256 |
| fromOrigin | fo | Whether to draw the line from the origin instead | false | > This mechanic inherits every attribute of the [Particle](skills/mechanics/particle) mechanic
| xSpread | xs | Spread of particles on the x axis | 0 | >> The particles are generated “per point” in this mechanic, so keeping `amount` low is recommended.
| ySpread | ys | Spread of particles on the y axis | 0 |
| zSpread | zs | Spread of particles on the z axis | 0 |
| zigzag | zz | Whether to draw the line to the target as a zigzag | false |
| zigzags | zzs | Amount of zigzags when using the zigzag option | 10 |
| zigzagOffset | zzo | Offset of each zigzag | 0.2 |
| maxdistance | | The maximum distance the line can reach | 256 |
## Examples ## Examples
Example would draw a beam of fire from the origin to the target.
```yaml ```yaml
FlameParticleLine: FlameParticleLine:
Skills: Skills:
- effect:particleline{particle=flame;amount=1;fromOrigin=true} @target - particleline{particle=flame;amount=1;fromOrigin=true} @target
``` ```
\ No newline at end of file
## Aliases
- [x] effect:particleline
- [x] e:pl
- [x] pl
<!-- LINKS -->
[@origin]: skills/targeters/origin
\ No newline at end of file