Changes

Page history
Update RequiredDamagePercent: to reflect 1 = 100% authored by mikekevie's avatar mikekevie
Hide whitespace changes
Inline Side-by-side
drops/FancyDrops.md
View page @ ac097922
Have you ever thought that drops were a bit *too* plain? Did you want them to sparkle a bit more? Do not worry then: this page documents how that can be done! Have you ever thought that drops were a bit *too* plain? Did you want them to sparkle a bit more? Do not worry then: this page documents how that can be done!
But remember! Fancy Drops are only available for **Mythic, [MMOItems](/drops/Drops#drop-types), [Droptables](/drops/DropTables) or Vanilla items**! But remember! Fancy Drops are only available for **Mythic, [MMOItems](/drops/Drops#drop-types), [Droptables](/drops/DropTables) or Vanilla items**!
[[_TOC_]] [[_TOC_]]
## Drop Options ## Drop Options
This is an additional field on the mob config, `DropOptions`, that allows you to determine various behaviors regarding the drops. This is an additional field on the mob config, `DropOptions`, that allows you to determine various behaviors regarding the drops.
```yaml ```yaml
DropOptions: DropOptions:
DropMethod: FANCY DropMethod: FANCY
ShowDeathChatMessage: false ShowDeathChatMessage: false
ShowDeathHologram: false ShowDeathHologram: false
PerPlayerDrops: false PerPlayerDrops: false
ClientSideDrops: false ClientSideDrops: false
Lootsplosion: false Lootsplosion: false
HologramItemNames: false HologramItemNames: false
ItemGlowByDefault: false ItemGlowByDefault: false
ItemBeamByDefault: false ItemBeamByDefault: false
ItemVFXByDefault: false ItemVFXByDefault: false
ItemVFX: ItemVFX:
Material: STONE Material: STONE
Model: 0 Model: 0
RequiredDamagePercent: 1 RequiredDamagePercent: 0.1
HologramTimeout: 6000 HologramTimeout: 6000
HologramMessage: HologramMessage:
- ... - ...
- ... - ...
ChatMessage: ChatMessage:
- ... - ...
- ... - ...
``` ```
### DropMethod ### DropMethod
Can be one of two values: Can be one of two values:
- `VANILLA`, which keeps all of the "normal" drop behaviors - `VANILLA`, which keeps all of the "normal" drop behaviors
- `FANCY`, which enables damage tracking, scoreboards and more advanced drop effects. Drops can also be rolled for every participant instead of only once if the relevant config is set to allow it. - `FANCY`, which enables damage tracking, scoreboards and more advanced drop effects. Drops can also be rolled for every participant instead of only once if the relevant config is set to allow it.
So, in essence, this must be set to `FANCY` in order for the rest of the page to work So, in essence, this must be set to `FANCY` in order for the rest of the page to work
Defaults to `VANILLA` Defaults to `VANILLA`
```yaml ```yaml
DropOptions: DropOptions:
DropMethod: FANCY DropMethod: FANCY
``` ```
### ShowDeathChatMessage ### ShowDeathChatMessage
Whether to show the death chat message to the players. Whether to show the death chat message to the players.
Defaults to `false`. Defaults to `false`.
```yaml ```yaml
DropOptions: DropOptions:
ShowDeathChatMessage: true ShowDeathChatMessage: true
``` ```
### ShowDeathHologram ### ShowDeathHologram
Whether to show the death hologram to the players. Whether to show the death hologram to the players.
Defaults to `false`. Defaults to `false`.
```yaml ```yaml
DropOptions: DropOptions:
ShowDeathHologram: true ShowDeathHologram: true
``` ```
### PerPlayerDrops ### PerPlayerDrops
Whether to calculate the drops of the mob separately for each player involved. Essentially, the drops will be rolled one time for each player. Whether to calculate the drops of the mob separately for each player involved. Essentially, the drops will be rolled one time for each player.
> **This is a [Paper-Only] feature!** > **This is a [Paper-Only] feature!**
```yaml ```yaml
DropOptions: DropOptions:
PerPlayerDrops: true PerPlayerDrops: true
``` ```
### ClientSideDrops ### ClientSideDrops
Whether drops should be seen per-player, in a client side manner. In essence, with this enabled, every player will only be able to see the loot that they themselves gained. Whether drops should be seen per-player, in a client side manner. In essence, with this enabled, every player will only be able to see the loot that they themselves gained.
```yaml ```yaml
DropOptions: DropOptions:
ClientSideDrops: false ClientSideDrops: false
``` ```
### Lootsplosion ### Lootsplosion
Whether the drops should do a lootsplosion effect by default. Whether the drops should do a lootsplosion effect by default.
```yaml ```yaml
DropOptions: DropOptions:
Lootsplosion: true Lootsplosion: true
``` ```
### HologramItemNames ### HologramItemNames
Whether the items should have a hologram name to display them by default. Whether the items should have a hologram name to display them by default.
```yaml ```yaml
DropOptions: DropOptions:
HologramItemNames: true HologramItemNames: true
``` ```
### ItemGlowByDefault ### ItemGlowByDefault
Whether items should glow by default. Whether items should glow by default.
Using this option seems to add an NBT to the dropped items that makes them unstackable with other items not obtained this way. Using this option seems to add an NBT to the dropped items that makes them unstackable with other items not obtained this way.
```yaml ```yaml
DropOptions: DropOptions:
ItemGlowByDefault: true ItemGlowByDefault: true
``` ```
### ItemBeamByDefault ### ItemBeamByDefault
Whether items should have a beam by default. Whether items should have a beam by default.
```yaml ```yaml
DropOptions: DropOptions:
ItemBeamByDefault: true ItemBeamByDefault: true
``` ```
### ItemVFXByDefault ### ItemVFXByDefault
Whether items should have a vfx by default. Whether items should have a vfx by default.
```yaml ```yaml
DropOptions: DropOptions:
ItemVFXByDefault: true ItemVFXByDefault: true
``` ```
### ItemVFX ### ItemVFX
Options regarding the default VFX of the items Options regarding the default VFX of the items
```yaml ```yaml
DropOptions: DropOptions:
ItemVFX: ItemVFX:
Material: STONE # The default material of the vfx Material: STONE # The default material of the vfx
Model: 0 # The default model of the vfx Model: 0 # The default model of the vfx
``` ```
### RequiredDamagePercent ### RequiredDamagePercent
The required amount of damage to inflict on the mob, quantified as percent of its health, in order for the drops to be generated for the specific player. The required amount of damage to inflict on the mob, quantified as percent of its health, in order for the drops to be generated for the specific player.
```yaml ```yaml
DropOptions: DropOptions:
RequiredDamagePercent: 1 RequiredDamagePercent: 0.1
``` ```
### HologramTimeout ### HologramTimeout
The amount of time after which the hologram that spawns when the mob dies should disappear The amount of time after which the hologram that spawns when the mob dies should disappear
Defaults to `6000` Defaults to `6000`
```yaml ```yaml
DropOptions: DropOptions:
HologramTimeout: 6000 HologramTimeout: 6000
``` ```
### HologramMessage ### HologramMessage
What the hologram that spawns when the mob dies should say. Is able to use specific placeholders. What the hologram that spawns when the mob dies should say. Is able to use specific placeholders.
```yaml ```yaml
DropOptions: DropOptions:
HologramMessage: HologramMessage:
- '<#FF9B00>========================' - '<#FF9B00>========================'
- '<mob.name> - <mob.hp>HP' - '<mob.name> - <mob.hp>HP'
- '' - ''
- '<#FFA300>1st Place | <1.name> | <1.damage>' - '<#FFA300>1st Place | <1.name> | <1.damage>'
- '<#D1FFFF>2nd Place | <2.name> | <2.damage>' - '<#D1FFFF>2nd Place | <2.name> | <2.damage>'
- '<#D1FFFF>3rd Place | <3.name> | <3.damage>' - '<#D1FFFF>3rd Place | <3.name> | <3.damage>'
- '<#E57A00>4th Place | <4.name> | <4.damage>' - '<#E57A00>4th Place | <4.name> | <4.damage>'
- '<#E57A00>5th Place | <5.name> | <5.damage>' - '<#E57A00>5th Place | <5.name> | <5.damage>'
- '' - ''
- 'Your rank: #<player.rank> | <player.damage>' - 'Your rank: #<player.rank> | <player.damage>'
- '<#FF9B00>========================' - '<#FF9B00>========================'
``` ```
> If there is no player at a specified rank (for instance, if a mob was killed by less than 5 players) then the line where the placeholder is used will not be shown > If there is no player at a specified rank (for instance, if a mob was killed by less than 5 players) then the line where the placeholder is used will not be shown
### ChatMessage ### ChatMessage
What the message send to the players when the mob dies should say. Is able to use specific placeholders. What the message send to the players when the mob dies should say. Is able to use specific placeholders.
```yaml ```yaml
DropOptions: DropOptions:
ChatMessage: ChatMessage:
- '<#F28800>====================================' - '<#F28800>===================================='
- '<#FFA300>BOSS DEFEATED!' - '<#FFA300>BOSS DEFEATED!'
- '<#F2B600><mob.name>' - '<#F2B600><mob.name>'
- '' - ''
- '<#ffe259>1st Place »<#ffe259> <1.name> - <1.damage>' - '<#ffe259>1st Place »<#ffe259> <1.name> - <1.damage>'
- '<#D1FFFF>2nd Place »<#D1FFFF> <2.name> - <2.damage>' - '<#D1FFFF>2nd Place »<#D1FFFF> <2.name> - <2.damage>'
- '<#D1FFFF>3rd Place »<#D1FFFF> <3.name> - <3.damage>' - '<#D1FFFF>3rd Place »<#D1FFFF> <3.name> - <3.damage>'
- '<#E57A00>4th Place »<#E57A00> <4.name> - <4.damage>' - '<#E57A00>4th Place »<#E57A00> <4.name> - <4.damage>'
- '<#E57A00>5th Place »<#E57A00> <5.name> - <5.damage>' - '<#E57A00>5th Place »<#E57A00> <5.name> - <5.damage>'
- '' - ''
- '<#F2B600>Your rank: #<player.rank> - <player.damage> (<pity> Pity)' - '<#F2B600>Your rank: #<player.rank> - <player.damage> (<pity> Pity)'
- '<#F28800>====================================' - '<#F28800>===================================='
``` ```
> If there is no player at a specified rank (for instance, if a mob was killed by less than 5 players) then the line where the placeholder is used will not be shown > If there is no player at a specified rank (for instance, if a mob was killed by less than 5 players) then the line where the placeholder is used will not be shown
## Drop Attributes ## Drop Attributes
Other than the options written above, you can also determine specific behaviors for each drop of the mob, by writing them as inline attributes Other than the options written above, you can also determine specific behaviors for each drop of the mob, by writing them as inline attributes
```yaml ```yaml
Drops: Drops:
- amber_1{itemglow=true;itemglowcolor=GOLD;hn=true;lootsplosion=true;vfxmaterial=POTION;vfxdata=21;vfxc=#55ff55} 1 1 - amber_1{itemglow=true;itemglowcolor=GOLD;hn=true;lootsplosion=true;vfxmaterial=POTION;vfxdata=21;vfxc=#55ff55} 1 1
``` ```
| Attribute | Aliases | Description | Default | | Attribute | Aliases | Description | Default |
|-----------|-----------|----------------------------------------------------------------------|---------| |-----------|-----------|----------------------------------------------------------------------|---------|
| lootsplosion | lootsplosionenabled, ls | Whether the drop should move outwards once generated | | | lootsplosion | lootsplosionenabled, ls | Whether the drop should move outwards once generated | |
| clientsidedrops | clientsidedropsenabled, csd | Whether the drop should be client side | | | clientsidedrops | clientsidedropsenabled, csd | Whether the drop should be client side | |
| hologramname | hologramnameenabled, hn | Whether the drop should have a hologram displaying its name | | | hologramname | hologramnameenabled, hn | Whether the drop should have a hologram displaying its name | |
| itemglow | itemglowenabled, ig | Whether the drop should glow | | | itemglow | itemglowenabled, ig | Whether the drop should glow | |
| itemglowcolor | glowcolor, gc | The color of the glow, if set | | | itemglowcolor | glowcolor, gc | The color of the glow, if set | |
| itembeam | itembeamenabled, ib | Whether the drop should generate a particle beam above itself | | | itembeam | itembeamenabled, ib | Whether the drop should generate a particle beam above itself | |
| itembeamcolor | beamcolor, bc | The color of the beam, if set | | | itembeamcolor | beamcolor, bc | The color of the beam, if set | |
| itemvfx | ivfx, vfx | Whether the drop should have a item vfx | | | itemvfx | ivfx, vfx | Whether the drop should have a item vfx | |
| vfxmaterial | vfxmat, vfxm | The material of the vfx | | | vfxmaterial | vfxmat, vfxm | The material of the vfx | |
| vfxdata | vfxd | The data of the vfx | 0 | | vfxdata | vfxd | The data of the vfx | 0 |
| vfxmodel | vfxitemmodel | The item model of the vfx. Minecraft 1.21.3+ | | | vfxmodel | vfxitemmodel | The item model of the vfx. Minecraft 1.21.3+ | |
| vfxcolor | vfxc, color | The color of the vfx | | | vfxcolor | vfxc, color | The color of the vfx | |
| pityModifier | pitymod, pmod | The modifier of the pity | 0.0 | | pityModifier | pitymod, pmod | The modifier of the pity | 0.0 |
| resetpity | resetp, rp | Whether the pity should be reset | false | | resetpity | resetp, rp | Whether the pity should be reset | false |
| pcategory | pitycategory, category | The category of the pity | DEFAULT | | pcategory | pitycategory, category | The category of the pity | DEFAULT |
| damage | mindamage, min | The minimum amount of damage that must have been inflicted on the mob in order for this drop to be able to be generated for the player | 0.0 | | damage | mindamage, min | The minimum amount of damage that must have been inflicted on the mob in order for this drop to be able to be generated for the player | 0.0 |
| top | placement, required | The placement in the damage leaderboard required for this drop to be generated for the player | 2147483647 | | top | placement, required | The placement in the damage leaderboard required for this drop to be generated for the player | 2147483647 |
| billboarding | billboard, bill | The [billboarding] of the hologram | VERTICAL | | billboarding | billboard, bill | The [billboarding] of the hologram | VERTICAL |
| brightness | bright, b | The brightness of the hologram | 0 | | brightness | bright, b | The brightness of the hologram | 0 |
| fortune | | Whether this drop should be affected by the fortune enchant | false | | fortune | | Whether this drop should be affected by the fortune enchant | false |
| fortuneMod | | How much each level of the fortune enchant impact the drop amount | | | fortuneMod | | How much each level of the fortune enchant impact the drop amount | |
### Fortune ### Fortune
Fortune drop amount calculation: Fortune drop amount calculation:
```math ```math
amount = min(1, floor(<random.float.0to1> * (2 + fortuneLevel) * fortuneMod ) ) * amount amount = min(1, floor(<random.float.0to1> * (2 + fortuneLevel) * fortuneMod ) ) * amount
``` ```
### Example ### Example
```yaml ```yaml
Drops: Drops:
- amber_1{itemglow=true;itemglowcolor=GOLD;hn=true;lootsplosion=true;vfxmaterial=POTION;vfxdata=21;vfxc=#55ff55} 1 1 - amber_1{itemglow=true;itemglowcolor=GOLD;hn=true;lootsplosion=true;vfxmaterial=POTION;vfxdata=21;vfxc=#55ff55} 1 1
- adamantium_ore{itemglow=true;itemglowcolor=WHITE;hn=true;lootsplosion=true;vfxmaterial=POTION;vfxdata=21;vfxc=#55ff55} 1 1 - adamantium_ore{itemglow=true;itemglowcolor=WHITE;hn=true;lootsplosion=true;vfxmaterial=POTION;vfxdata=21;vfxc=#55ff55} 1 1
- amethyst_1{itemglow=true;itemglowcolor=YELLOW;hn=true;lootsplosion=true;vfxmaterial=POTION;vfxdata=21;vfxc=#55ff55} 1 1 - amethyst_1{itemglow=true;itemglowcolor=YELLOW;hn=true;lootsplosion=true;vfxmaterial=POTION;vfxdata=21;vfxc=#55ff55} 1 1
- andesite_bricks{itemglow=true;itemglowcolor=LIGHT_PURPLE;hn=true;lootsplosion=true;vfxmaterial=POTION;vfxdata=21;vfxc=#55ff55} 1 1 - andesite_bricks{itemglow=true;itemglowcolor=LIGHT_PURPLE;hn=true;lootsplosion=true;vfxmaterial=POTION;vfxdata=21;vfxc=#55ff55} 1 1
- bananarang{itemglow=true;itemglowcolor=RED;hn=true;lootsplosion=true;vfxmaterial=POTION;vfxdata=21;vfxc=#55ff55} 1 1 - bananarang{itemglow=true;itemglowcolor=RED;hn=true;lootsplosion=true;vfxmaterial=POTION;vfxdata=21;vfxc=#55ff55} 1 1
- augment_sword_midas_6{itemglow=true;itemglowcolor=AQUA;hn=true;lootsplosion=true;vfxmaterial=POTION;vfxdata=21;vfxc=#55ff55} 1 1 - augment_sword_midas_6{itemglow=true;itemglowcolor=AQUA;hn=true;lootsplosion=true;vfxmaterial=POTION;vfxdata=21;vfxc=#55ff55} 1 1
- blue_stained_tiles{itemglow=true;itemglowcolor=GREEN;hn=true;lootsplosion=true;vfxmaterial=POTION;vfxdata=21;vfxc=#55ff55} 1 1 - blue_stained_tiles{itemglow=true;itemglowcolor=GREEN;hn=true;lootsplosion=true;vfxmaterial=POTION;vfxdata=21;vfxc=#55ff55} 1 1
- black_stained_tiles{itemglow=true;itemglowcolor=BLUE;hn=true;lootsplosion=true;vfxmaterial=POTION;vfxdata=21;vfxc=#55ff55} 1 1 - black_stained_tiles{itemglow=true;itemglowcolor=BLUE;hn=true;lootsplosion=true;vfxmaterial=POTION;vfxdata=21;vfxc=#55ff55} 1 1
- bismuth_2{itemglow=true;itemglowcolor=DARK_RED;hn=true;lootsplosion=true;vfxmaterial=POTION;vfxmodel="mythic:effects/item_beam_3"} 1 1 - bismuth_2{itemglow=true;itemglowcolor=DARK_RED;hn=true;lootsplosion=true;vfxmaterial=POTION;vfxmodel="mythic:effects/item_beam_3"} 1 1
``` ```
<!-- LINKS --> <!-- LINKS -->
[billboarding]: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/Display.Billboard.html [billboarding]: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/Display.Billboard.html
[Paper-Only]: https://papermc.io/downloads/all [Paper-Only]: https://papermc.io/downloads/all
\ No newline at end of file