Skip to content

GitLab

projectile · Changes

Page history
Completely updated Layout and Informations authored by Lxlp's avatar Lxlp
Show whitespace changes
Inline Side-by-side
Showing with 172 additions and 39 deletions
skills/mechanics/projectile.md
View page @ 1180031c
...@@ -20,43 +20,55 @@ It is of importance to note that other mechanics (such as [Missile](/skills/mech ...@@ -20,43 +20,55 @@ It is of importance to note that other mechanics (such as [Missile](/skills/mech
| onEndSkill | onEnd, oE | Meta-Skill executed when the projectile ends. | | | onEndSkill | onEnd, oE | Meta-Skill executed when the projectile ends. | |
| onBounceSkill| onBounce |Meta-Skill executed when the projectile bounces. **Premium Only**.| | | onBounceSkill| onBounce |Meta-Skill executed when the projectile bounces. **Premium Only**.| |
| onHitBlockSkill |onHitBlock, ohb | Meta-Skill executed when the projectile hits a block. | | | onHitBlockSkill |onHitBlock, ohb | Meta-Skill executed when the projectile hits a block. | |
| Interval | i | How often (in ticks) the projectile updates its position | 4 | | BulletType | bullet, b | The type of the bullet. If set, additional attributes becomes available depending on the specified bullet type. A list of bullet types and associated attributes is available [below](/skills/mechanics/projectile#projectile-bullets) | NONE |
| HorizontalRadius | hRadius, hR | The horizontal radius entities will be hit in around the projectile. | 1.25 | | Interval | int, i | How often (in ticks) the projectile updates its position | 1 |
| VerticalRadius | vRadius, vR | The vertical radius entities will be hit in around the projectile. | Horizontal Radius | | HorizontalRadius | hRadius, hR, r | The horizontal radius entities will be hit in around the projectile. | 1.25 |
| Duration | d | The max duration (in ticks) the projectile will persist. | 100 | | VerticalRadius | vRadius, vR | The vertical radius entities will be hit in around the projectile. | 1.25 |
| Duration | maxDuration, md, d | The max duration (in ticks) the projectile will persist. | 400 |
| MaxRange | mr | The maximum range (in blocks) the projectile will travel. | 40 | | MaxRange | mr | The maximum range (in blocks) the projectile will travel. | 40 |
| Velocity | v | The velocity of the projectile | 5 | | Velocity | v | The velocity of the projectile | 5 |
| StartYOffset | syo | Start Y Offset - Lets you offset where on the casting mob the projectile shoots from. | +1 | | DeathDelay| death, dd | Delays the removal of project bullets when the projectile is terminated | 2 |
| StartFOffset | sfo | Start Forward Offset - How far in front of the mob the projectile starts | +1 | | StartYOffset | syo | Lets you offset where on the casting mob the projectile shoots from. | 1 |
| StartSideOffset | sso | Start Side Offset - How far to the side of the mob the projectile starts | 0 | | StartFOffset | forwardoffset, sfo | How far in front of the mob the projectile starts | 1 |
| TargetYOffset | tyo | Target Y Offset - Lets you offset where on the target the projectile shoots at. | +1 | | TargetYOffset | tyo | Lets you offset where on the target the projectile shoots at. | 0 |
| HorizontalOffset | hO | Horizontal Offset will rotate the projectile's horizontal starting velocity around a 360-degree axis. | 0 | | SideOffset | soffset, so | The value of this attribute gets inherited by StartSideOffset and EndSideOffset if no value is specified for them | 0 |
| VerticalOffset | vO | Vertical Offset will rotate the projectile's vertical starting velocity around a 360-degree axis. | 0 | | StartSideOffset | ssoffset, sso | How far to the side of the mob the projectile starts |sideoffset|
| HitPlayers | hp | Whether the projectile will only hit player. | true | | EndSideOffset | endoffset, esoffset, eso | How far to the side of the target location the projectile will end up |sideoffset|
| HitNonPlayers | hnp | Whether the projectile will hit any entities(including caster but not players). | false | | startingdirection | startingdir, startdir, sdir | Start direction of the projectile | |
| HitSelf | | Whether the projectile will hit the caster. | HorizontalOffset | hO | Horizontal Offset will rotate the projectile's horizontal starting velocity around a 360-degree axis | 0 |
| StopAtEntity | sE | Whether the projectile will stop upon hitting a targetable entity. | true | | VerticalOffset | vO | Vertical Offset will rotate the projectile's vertical starting velocity around a 360-degree axis | 0 |
| StopAtBlock | sB | Whether the projectile will stop upon hitting an opaque block. | true |
| HugSurface | hs | Whether or not the projectile should move along the ground. | false |
| HugLiquid | | when using hugSurface will also move on top of liquids | false
| HeightFromSurface | hfs | For NORMAL projectiles, how high above the surface the projectile should glide if HugSurface is set to TRUE. For METEOR projectiles, how high above the surface the projectile starts above the target. | 0.5 |
| PowerAffectsRange | par | Whether a mob's [power level](/Mobs/Power) affects the projectile's range. | true |
| PowerAffectsVelocity | pav | Whether a mob's [power level](/Mobs/Power) affects the projectile's velocity. | true |
| gravity | g | Determines the gravity of the projectile; use fractions (0.1-0.2) for low gravity | 0 |
| Accuracy | ac, a | Determines the accuracy of the projectile | 1 | | Accuracy | ac, a | Determines the accuracy of the projectile | 1 |
| HorizontalNoise | hn | The randomness of the projectile in horizontal direction | 0 | | HorizontalNoise | hn | The randomness of the projectile in horizontal direction |(1-ac)*45 |
| VerticalNoise | vn | The randomness of the projectile in the vertical direction | 0 | | VerticalNoise | vn | The randomness of the projectile in the vertical direction |(1-ac)*4.5|
| Bounce | | Should the projectile bounce. Bounce radius depends on the projectile's hitbox. **Premium Only** Mechanic | false | | StopAtEntity | sE | Whether the projectile will stop upon hitting a targetable entity | true |
| BounceVelocity | | Every time the projectile bounces, its velocity will be multiplied by this value. **Premium Only** Mechanic | 0.9 | StopAtBlock | sB | Whether the projectile will stop upon hitting an opaque block | true |
| hitConditions | | A list of conditions that a target must meet in order for the projectile to be able to hit it. **Premium Only** Mechanic | | | PowerAffectsRange |pa | Whether a mob's [power level](/Mobs/Power) affects the projectile's range| true|
| bulletEnchanted | enchanted | Makes the projectile enchanted. Works for armorstand/item display/item bullets | false | | PowerAffectsVelocity | pav | Whether a mob's [power level](/Mobs/Power) affects the projectile's velocity. | true |
| HitSelf | | Whether the projectile can hit the caster | false |
| HitPlayers | hp | Whether the projectile can hit players | true |
| HitNonPlayers | hnp | Whether the projectile can hit non player entities | false |
| HitTarget | ht | Whether the projectile can hit the mechanic's target | true |
| HitTargetOnly | hto | Whether the projectile can **only** hit the mechanic's target | false |
| ImmuneDelay | immune, id | Sets the immunity delay (when the target can be hit by the projectile again) | 2000 |
| hitConditions | conditions, cond, c | A list of conditions that a target must meet in order for the projectile to be able to hit it. **Premium Only** Mechanic | |
| fromorigin | fo | Whether the projectile should start from the origin of the mechanic | false |
### Projectile-Specific Attributes ### Projectile-Specific Attributes
| Attribute | Aliases | Description | Default |
|-----------|-----------|----------------------------------------------------------------------|---------|
| Type | | The "type" of projectile. Default projectiles are launched from the mob's location towards the target. METEOR type projectiles fall from the sky above the target. | NORMAL | | Type | | The "type" of projectile. Default projectiles are launched from the mob's location towards the target. METEOR type projectiles fall from the sky above the target. | NORMAL |
| gravity | g | Determines the gravity of the projectile; use fractions (0.1-0.2) for low gravity | 0 |
| Bounces | bounce | Should the projectile bounce. Bounce radius depends on the projectile's hitbox. **Premium Only**. | false |
| BounceVelocity | bv | Every time the projectile bounces, its velocity will be multiplied by this value. **Premium Only** . | 0.9 |
| HugSurface| hs | Whether or not the projectile should move along the ground. | false |
| HugLiquid | hugwater, huglava | when using hugSurface will also move on top of liquids | false |
| HeightFromSurface| hfs| For NORMAL projectiles, how high above the surface the projectile should glide if HugSurface is set to TRUE. For METEOR projectiles, how high above the surface the projectile starts above the target. | 0.5 |
| MaxClimbHeight | mch | The number of attempts the projectile will make to **increase** its y-location before terminating itself, when the projectiles is "hugging" either a block or a liquid | 3 |
| MaxDropHeight | mdh | The number of attempts the projectile will make to **decrease** its y-location before terminating itself, when the projectiles is "hugging" either a block or a liquid | 10 |
Special Notes ## Special Notes
-------------
**For the <u>onStart</u> Skill:** onStart skills work in a special way - **For the <u>onStart</u> Skill:** onStart skills work in a special way -
any buff or "special effect" mechanics fired by onStart that have a any buff or "special effect" mechanics fired by onStart that have a
...@@ -86,14 +98,135 @@ that is firing the projectile. ...@@ -86,14 +98,135 @@ that is firing the projectile.
Because of this, meteor projectiles cannot use certain attributes (which Because of this, meteor projectiles cannot use certain attributes (which
ones are pending further testing). ones are pending further testing).
Projectile Bullets
------------------
Projectile mechanics can now specify a bullet type that will represent ## Projectile Bullets
the projectile. No longer are projectiles just limited to particles!
The bullet type that will represent the projectile. These can be specified via the BulletType attribute.
These work with the projectile, missile, and orbital mechanics. These work with the projectile, missile, and orbital mechanics.
| BulletType | Aliases | Description |
|-------------|--------------|---------------------------------------------------------------------------|
| [ARROW][] | | The bullet will be a minecraft projectile |
| [BLOCK][] | | The bullet will be a block |
| [SMALLBLOCK][]| | The bullet will be a small block |
| [ITEM][] | MYTHICITEM | The bullet will be an item |
| [MOB][] | | The bullet will be a mob. If a Mythicmobs, it will retain its skills |
| [TRACKING][]| ARMOR_STAND, ARMORSTAND, PSTAND | The bullet will be an item, but its rotation will be adjusted depending on the projectile's direction |
| [REALTRACKING][] | RTRACKING, REAL_ARMOR_STAND, REALARMORSTAND, STAND | As above, but a real armor stand will also be spawned instead of a packet |
| [DISPLAY][] | | The projectile will be a display entity |
| [TEXT][] | | The projectile will display a line of text |
Examples:
```yaml
- projectile{bulletType=ARROW;arrowType=TRIDENT;...}
- projectile{bulletType=BLOCK;material=STONE;...}
- projectile{bulletType=ITEM;material=MyMythicItem;...}
- projectile{bulletType=MOB;mob=SkeletonKing;...}
```
[ARROW]: /skills/mechanics/projectile#arrow-bullet
[BLOCK]: /skills/mechanics/projectile#block-bullet
[SMALLBLOCK]: /skills/mechanics/projectile#smallblock-bullet
[ITEM]: /skills/mechanics/projectile#item-bullet
[MOB]: /skills/mechanics/projectile#mob-bullet
[TRACKING]: /skills/mechanics/projectile#tracking-bullet
[REALTRACKING]: /skills/mechanics/projectile#realtracking-bullet
[DISPLAY]: /skills/mechanics/projectile#display-bullet
[TEXT]: /skills/mechanics/projectile#text-bullet
### ARROW Bullet
| Attribute | Aliases | Description | Default |
|-----------|-----------|----------------------------------------------------------------------|---------|
| arrowtype | bulletarrowtype | The type of the projectile to use. Can be `NORMAL`,`SPECTRAL`,`TRIDENT` | NORMAL |
### BLOCK Bullet
| Attribute | Aliases | Description | Default |
|-----------|-----------|----------------------------------------------------------------------|---------|
| bulletmaterial | material, mat | The material of the bullet | STONE |
| bulletspin | bspin | The spin of the bullet | 0 |
| audience | | The [Audience][] of the bullet | world |
### SMALLBLOCK Bullet
| Attribute | Aliases | Description | Default |
|-----------|-----------|----------------------------------------------------------------------|---------|
| bulletmaterial | material, mat | The material of the bullet | STONE |
| audience | | The [Audience][] of the bullet | world |
### ITEM Bullet
| Attribute | Aliases | Description | Default |
|-----------|-----------|----------------------------------------------------------------------|---------|
| bulletmaterial | material, mat | The material of the bullet | STONE |
|bulletModel| model | The CustomModelData of the material | 0 |
|bulletColor| | The color of the material, if applicable | |
| bulletmatchdirection | bmd | Should the bullet face where the projectile is facing | false |
| bulletEnchanted | enchanted | Should the material be enchanted | false |
| audience | | The [Audience][] of the bullet | world |
### MOB Bullet
| Attribute | Aliases | Description | Default |
|-----------|-----------|----------------------------------------------------------------------|---------|
| mob | mobType, mm | The mob of the bullet | SkeletalKnight |
| bulletspin | bspin | The spin of the bullet | 0 |
| bulletmatchdirection | bmd | Should the bullet face where the projectile is facing | false |
| bulletKillable | bk | Allow other entities to damage the projectile bullet | false |
### TRACKING Bullet
| Attribute | Aliases | Description | Default |
|-----------|-----------|----------------------------------------------------------------------|---------|
| bulletmaterial | material, mat | The material of the bullet | STONE |
|bulletModel| model | The CustomModelData of the material | 0 |
|bulletColor| | The color of the material, if applicable | |
| bulletEnchanted | enchanted | Should the material be enchanted | false |
| pitch | | The pitch rotation | 0 |
| yaw | | The yaw rotation | 0 |
| roll | | The roll rotation | 0 |
| rotation | rot | The rotation of the bullet, in the x,y,z format | 0,0,0 |
| pitchspeed| ps | The pitch rotation speed | 0 |
| yawspeed | ys | The yaw rotation speed | 0 |
| rollspeed | rs | The roll rotation speed | 0 |
| rotationspeed | rotspeed, rots | The rotation speed of the bullet, in the x,y,z format | 0,0,0 |
| audience | | The [Audience][] of the bullet | world |
### REALTRACKING Bullet
| Attribute | Aliases | Description | Default |
|-----------|-----------|----------------------------------------------------------------------|---------|
| bulletmaterial | material, mat | The material of the bullet | STONE |
|bulletModel| model | The CustomModelData of the material | 0 |
|bulletColor| | The color of the material, if applicable | |
| bulletEnchanted | enchanted | Should the material be enchanted | false |
### DISPLAY Bullet
| Attribute | Aliases | Description | Default |
|-----------|-----------|----------------------------------------------------------------------|---------|
| bulletmaterial | material, mat | The material of the bullet | STONE |
|bulletModel| model | The CustomModelData of the material | 0 |
|bulletColor| | The color of the material, if applicable | |
| bulletEnchanted | enchanted | Should the material be enchanted | false |
| pitch | | The pitch rotation | 0 |
| yaw | | The yaw rotation | 0 |
| roll | | The roll rotation | 0 |
| rotation | rot | The rotation of the bullet, in the x,y,z format | 0,0,0 |
| pitchspeed| ps | The pitch rotation speed | 0 |
| yawspeed | ys | The yaw rotation speed | 0 |
| rollspeed | rs | The roll rotation speed | 0 |
| rotationspeed | rotspeed, rots | The rotation speed of the bullet, in the x,y,z format | 0,0,0 |
|bulletscale| scale | The scale of the bullet |0.5,0.5,0.5|
| audience | | The [Audience][] of the bullet | world |
### TEXT Bullet
| Attribute | Aliases | Description | Default |
|-----------|-----------|----------------------------------------------------------------------|---------|
| bulletText| text | The text of the bullet | * |
| bulletBillboard | billboard | The [billboard type][] of the bullet | CENTER |
|bulletscale| scale | The scale of the bullet |0.5,0.5,0.5|
| backgroundcolor | color | The Background color, in the ARGB format | 64,0,0,0 |
| audience | | The [Audience][] of the bullet | world |
[Audience]: /Skills/Effects#audience
[billboard type]: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/Display.Billboard.html
<!--
Bullet types available are: Bullet types available are:
- **ARROW** - *projectile{bulletType=ARROW;arrowType=(NORMAL/SPECTRAL/TRIDENT);...}* - **ARROW** - *projectile{bulletType=ARROW;arrowType=(NORMAL/SPECTRAL/TRIDENT);...}*
...@@ -112,9 +245,9 @@ with, but will still use all their skills... ...@@ -112,9 +245,9 @@ with, but will still use all their skills...
You can also use the new **bulletSpin=#** option to give your bullets You can also use the new **bulletSpin=#** option to give your bullets
some spin. some spin.
-->
Examples ## Examples
--------
This example shoots a fast-moving ball of ice that damages and slows the This example shoots a fast-moving ball of ice that damages and slows the
first entity it hits: first entity it hits:
......