Skip to content

GitLab

orbital · Changes

Page history
updated layout and informations authored by Lxlp's avatar Lxlp
Hide whitespace changes
Inline Side-by-side
Showing with 66 additions and 62 deletions
skills/mechanics/orbital.md
View page @ 2b58f6da
Mechanic: Orbital
=================
## Description
The Orbital skill fires a special type of
[projectile](/skills/mechanics/projectile) that will orbit around the
......@@ -11,83 +10,82 @@ fire shield, and is a very complex skill to master.
Added projectile bullets to Orbital in MM 4.11. See how to use them on the [projectiles mechanic](/skills/mechanics/projectile) page.
Attributes
----------
| Attribute | Aliases | Description | Default Value |
|---------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|
| onStart | oS | Meta-Skill executed when the orbital first starts. | None |
| onTick | oT | Meta-Skill executed every [interval] ticks at the orbital's origin location. | None |
| onHit | oH | Meta-Skill executed when the projectile hits something. Targets hit are inherited by the meta-skill. | None |
| onEnd | oE | Meta-Skill executed when the projectile ends. | None |
| AuraName | buffName, debuffName | Optional name, required to use associated mechanics & conditions that reference a specific aura. | None |
| Charges | c | If set, the orbital will stop after firing this many times. | 0 |
| Duration | d | The max duration (in ticks) the orbital will persist. | 100 |
| Interval | i | How often (in ticks) the orbital updates its position | 4 |
| Radius | r | The radius of the orbit around the target. | 4 |
| HitRadius | hr | The radius around the orbital that something will be hit. | 1 |
| VerticalHitRadius | vhr, vr | The radius around the orbital that something will be hit. | 1 |
| Points | p | How many "points" that comprise the circle that makes up the orbit. More points will make the circle more defined, but will also increase the time it takes to complete an orbit. | 32 |
| XRotation | rotx, rx | Rotates the orbital along the X axis. Rotation is done in radians, i.e. 3.14 is half a rotation, 6.28 is a full rotation. | 0 |
| YRotation | roty, ry | Rotates the orbital along the Y axis. Rotation is done in radians, i.e. 3.14 is half a rotation, 6.28 is a full rotation. | 0 |
| ZRotation | rotz, rz | Rotates the orbital along the Z axis. Rotation is done in radians, i.e. 3.14 is half a rotation, 6.28 is a full rotation. | 0 |
| XOffset | ox | Offsets the orbital along the X axis of the target. | 0 |
| YOffset | oy | Offsets the orbital along the Y axis of the target. | 0 |
| ZOffset | oz | Offsets the orbital along the Z axis of the target. | 0 |
| AngularVelocityX | avx, vx | Modifies the angular velocity of the orbital on the X axis. | 0 |
| AngularVelocityY | avy, vy | Modifies the angular velocity of the orbital on the Y axis. | 0 |
| AngularVelocityZ | avz, vz | Modifies the angular velocity of the orbital on the Z axis. | 0 |
| HitPlayers | hp | Whether can hit players. | true |
| HitNonPlayers | hnp | Whether can hit non players. | false |
| HitSelf | hs | Whether can hit caster. | false |
| CancelOnGiveDamage | cogd | Whether end after given damage to other entities. | false |
| CancelOnTakeDamage | cotd | Whether end after taken damage from other entities. | false |
| CancelOnDeath | cod | Whether end after caster death. | true |
| CancelOnTeleport | cot | Whether end after caster teleported. | false |
| CancelOnChangeWorld | cocw | Whether end after caster join other world. | false |
| CancelOnSkillUse | cosu | Whether end after caster spell a skill. | false |
| CancelOnQuit | coq | whether end after caster quit. | true |
## Attributes
| Attribute | Aliases | Description | Default |
|-----------|-----------|----------------------------------------------------------------------|---------|
| onStart | oS | Meta-Skill executed when the orbital first starts | |
| onTick | oT | Meta-Skill executed every [interval] ticks at the orbital's origin location | |
| onHit | oH | Meta-Skill executed when the projectile hits something. Targets hit are inherited by the meta-skill | |
| onEnd | oE | Meta-Skill executed when the projectile ends | |
| auraName | buffName, debuffName | Optional name, required to use associated mechanics & conditions that reference a specific aura, and to make the aura be able to stack | |
| charges | c | If set, the orbital will stop after firing this many times | |
| duration | d | The max duration (in ticks) the orbital will persist | 100 |
| interval | i | How often (in ticks) the orbital updates its position | 1 |
| radius | r | The radius of the orbit around the target | 4 |
| hitRadius | hr | The radius around the orbital in which targets can be hit | 1 |
| verticalHitRadius | vhr, vr | The y component of the hitradius | `hitradius` |
| points | p | How many "points" that comprise the circle that makes up the orbit. More points will make the circle more defined, but will also increase the time it takes to complete an orbit | 32 |
| startingpoint | sp | The starting step of the orbital aura | 0 |
| tickinterpolation | interpolation, ti | Interpolates additional points between each tick of the projectile, running onTick multiple times | 0 |
| xRotation | rotx, rx | Rotates the orbital along the X axis. Rotation is done in radians, i.e. `3.14` is half a rotation, `6.28` is a full rotation | 0 |
| yRotation | roty, ry | Rotates the orbital along the Y axis. Rotation is done in radians, i.e. 3.14 is half a rotation, 6.28 is a full rotation | 0 |
| zRotation | rotz, rz | Rotates the orbital along the Z axis. Rotation is done in radians, i.e. 3.14 is half a rotation, 6.28 is a full rotation | 0 |
| xOffset | ox | Offsets the orbital along the X axis of the target | 0 |
| yOffset | oy | Offsets the orbital along the Y axis of the target | 0 |
| zOffset | oz | Offsets the orbital along the Z axis of the target | 0 |
| angularVelocityX | avx, vx | Modifies the angular velocity of the orbital on the X axis | 0 |
| angularVelocityY | avy, vy | Modifies the angular velocity of the orbital on the Y axis | 0 |
| angularVelocityZ | avz, vz | Modifies the angular velocity of the orbital on the Z axis | 0 |
| rotate | | Whether the orbital should rotate | true |
| reversed | reverse, backwards | Whether the orbital should rotate in the opposite direction | false |
| hitPlayers | hp | Whether can hit players | true |
| hitNonPlayers | hnp| Whether can hit non players | false |
| hitSelf | hs | Whether can hit caster | false |
| cancelOnGiveDamage | cogd | Whether end after given damage to other entities | false |
| cancelOnTakeDamage | cotd | Whether end after taken damage from other entities | false |
| cancelOnDeath | cod| Whether end after caster death | true |
| cancelOnTeleport | cot| Whether end after caster teleported | false |
| cancelOnChangeWorld | cocw | Whether end after caster join other world | false |
| cancelOnSkillUse | cosu | Whether end after caster spell a skill | false |
| cancelOnQuit | coq | Whether end after caster quit | true |
| hugsurface | hs | Whether or not the orbital should move along the ground | false |
| hugliquid | hugwater, huglava | Whether using `hugSurface` will also make the orbital move on top of liquids | false |
| heightfromsurface | hsf | How high above the surface the orbital should glide if `HugSurface` is set to `true` | 0.5 |
| maxclimbheight | mch | The number of attempts the projectile will make to **increase** its y-location by 1 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 by 1 before terminating itself, when the projectiles is "hugging" either a block or a liquid| 10|
| bullettype | bullet, b | The [Projectile Bullet Type](skills/mechanics/projectile#projectile-bullets). Also makes the orbital inherits every related attribute | NONE |
> This mechanic inherits every attribute of the [Aura](/mythiccraft/MythicMobs/-/wikis/skills/mechanics/aura) mechanic
Special Notes
-------------
### onStart Attribute
onStart skills work in a special way - any buff or "special effect" mechanics fired by onStart that have a
duration (such as ParticleTornado) will attach to the projectile for their duration, which allows for some interesting effects.
**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
duration (such as ParticleTornado) will attach to the projectile for
their duration, which allows for some interesting effects.
### onTick Attribute
Using the **@origin** targeter will cause any skills or effects to target the projectile's location. This is the intended way to configure how the projectile looks.
**For the <u>onTick</u> Skill:** using the **@origin** targeter will
cause any skills or effects to target the projectile's location. This is
the intended way to configure how the projectile looks.
### onHit Attribute
Any targets the projectile hits are passed to the skill inherently. Any targeters you put in the onHit skill will *override* these and cause your skill to likely not work as you intend.
**For the <u>onHit</u> Skill:** Any targets the projectile hits are
passed to the skill inherently. Any targeters you put in the onHit skill
will *override* these and cause your skill to likely not work as you
intend.
### onEnd Attribute
Special effects for the projectile's end also use **@origin**. Also, If you want entities near the end-point of the projectile to be hit in a certain way (such as a final large fireball explosion) you can use the **@PlayersNearOrigin{r=[radius]}** targeter.
**For the <u>onEnd</u> Skill:** Special effects for the projectile's end
also use **@origin**. Also, If you want entities near the end-point of
the projectile to be hit in a certain way (such as a final large
fireball explosion) you can use the **@PlayersNearOrigin{r=[radius]}**
targeter.
Examples
--------
## Examples
This example puts an icy-looking orbital shield around the mob when it
is hit sometimes, that will last for 10 seconds or until it is triggered
once:
**Mob File**
```yaml
# Mob File
Mob:
Type: SKELETON
Skills:
- skill{s=IceShield} @self ~onDamaged 0.2
```
**Skills File**
```yaml
# Skills File
IceShield:
Skills:
- orbital{onTick=IceShield-Tick;onHit=IceShield-Hit;points=20;interval=1;duration=200;charges=1}
......@@ -106,6 +104,7 @@ This example shows how the orbital can be removed via the [Auraremove](`auraremo
<br>The mob `ExampleMob` create the shield from the previous example once it gets damaged with a 20% chance, but unlike the previous example this time the orbital also has an auraName attribute. When the mob receives a REMOVESHIELD signal, he will both remove the orbital via the auraremove mechanic and the orbital's auraName while also sending a SHIELDREMOVED signal back to the trigger of the metaskill
```yaml
# Mob File
ExampleMob:
Type: ZOMBIE
Skills:
......@@ -114,6 +113,7 @@ ExampleMob:
```
```yaml
# Skills File
IceShield:
Skills:
- orbital{
......@@ -124,4 +124,8 @@ IceShield-Remove:
Skills:
- auraremove{aura=IceShield}
- signal{s=SHIELDREMOVED} @trigger
```
\ No newline at end of file
```
## Aliases
- [x] o
\ No newline at end of file