azalea_entity/
particle.rs

1use azalea_block::BlockState;
2use azalea_buf::AzBuf;
3use azalea_core::{color::RgbColor, position::BlockPos};
4use azalea_inventory::ItemStack;
5use azalea_registry::ParticleKind;
6use azalea_world::MinecraftEntityId;
7use bevy_ecs::component::Component;
8
9// the order of this enum must be kept in sync with ParticleKind, otherwise
10// we get errors parsing particles.
11
12/// A [`ParticleKind`] with data potentially attached to it.
13#[derive(Component, Clone, Debug, AzBuf, PartialEq)]
14pub enum Particle {
15    AngryVillager,
16    Block(BlockParticle),
17    BlockMarker(BlockParticle),
18    Bubble,
19    Cloud,
20    CopperFireFlame,
21    Crit,
22    DamageIndicator,
23    DragonBreath,
24    DrippingLava,
25    FallingLava,
26    LandingLava,
27    DrippingWater,
28    FallingWater,
29    Dust(DustParticle),
30    DustColorTransition(DustColorTransitionParticle),
31    Effect,
32    ElderGuardian,
33    EnchantedHit,
34    Enchant,
35    EndRod,
36    EntityEffect(ColorParticle),
37    ExplosionEmitter,
38    Explosion,
39    Gust,
40    SmallGust,
41    GustEmitterLarge,
42    GustEmitterSmall,
43    SonicBoom,
44    FallingDust(BlockParticle),
45    Firework,
46    Fishing,
47    Flame,
48    Infested,
49    CherryLeaves,
50    PaleOakLeaves,
51    TintedLeaves,
52    SculkSoul,
53    SculkCharge(SculkChargeParticle),
54    SculkChargePop,
55    SoulFireFlame,
56    Soul,
57    Flash,
58    HappyVillager,
59    Composter,
60    Heart,
61    InstantEffect,
62    Item(ItemParticle),
63    Vibration(VibrationParticle),
64    Trail,
65    ItemSlime,
66    ItemCobweb,
67    ItemSnowball,
68    LargeSmoke,
69    Lava,
70    Mycelium,
71    Note,
72    Poof,
73    Portal,
74    Rain,
75    Smoke,
76    WhiteSmoke,
77    Sneeze,
78    Spit,
79    SquidInk,
80    SweepAttack,
81    TotemOfUndying,
82    Underwater,
83    Splash,
84    Witch,
85    BubblePop,
86    CurrentDown,
87    BubbleColumnUp,
88    Nautilus,
89    Dolphin,
90    CampfireCosySmoke,
91    CampfireSignalSmoke,
92    DrippingHoney,
93    FallingHoney,
94    LandingHoney,
95    FallingNectar,
96    FallingSporeBlossom,
97    Ash,
98    CrimsonSpore,
99    WarpedSpore,
100    SporeBlossomAir,
101    DrippingObsidianTear,
102    FallingObsidianTear,
103    LandingObsidianTear,
104    ReversePortal,
105    WhiteAsh,
106    SmallFlame,
107    Snowflake,
108    DrippingDripstoneLava,
109    FallingDripstoneLava,
110    DrippingDripstoneWater,
111    FallingDripstoneWater,
112    GlowSquidInk,
113    Glow,
114    WaxOn,
115    WaxOff,
116    ElectricSpark,
117    Scrape,
118    Shriek(ShriekParticle),
119    EggCrack,
120    DustPlume,
121    TrialSpawnerDetection,
122    TrialSpawnerDetectionOminous,
123    VaultConnection,
124    DustPillar,
125    OminousSpawning,
126    RaidOmen,
127    TrialOmen,
128    BlockCrumble,
129    Firefly,
130}
131
132impl From<ParticleKind> for Particle {
133    /// Convert a particle kind into particle data.
134    ///
135    /// If the particle has data attached (like block particles), then it's set
136    /// to the default.
137    fn from(kind: ParticleKind) -> Self {
138        // this is mostly just here so it fails to compile when a new particle is added
139        // to ParticleKind, since `Particle` has to be updated manually
140        match kind {
141            ParticleKind::AngryVillager => Self::AngryVillager,
142            ParticleKind::Block => Self::Block(BlockParticle::default()),
143            ParticleKind::BlockMarker => Self::BlockMarker(BlockParticle::default()),
144            ParticleKind::Bubble => Self::Bubble,
145            ParticleKind::Cloud => Self::Cloud,
146            ParticleKind::Crit => Self::Crit,
147            ParticleKind::DamageIndicator => Self::DamageIndicator,
148            ParticleKind::DragonBreath => Self::DragonBreath,
149            ParticleKind::DrippingLava => Self::DrippingLava,
150            ParticleKind::FallingLava => Self::FallingLava,
151            ParticleKind::LandingLava => Self::LandingLava,
152            ParticleKind::DrippingWater => Self::DrippingWater,
153            ParticleKind::FallingWater => Self::FallingWater,
154            ParticleKind::Dust => Self::Dust(DustParticle::default()),
155            ParticleKind::DustColorTransition => {
156                Self::DustColorTransition(DustColorTransitionParticle::default())
157            }
158            ParticleKind::Effect => Self::Effect,
159            ParticleKind::ElderGuardian => Self::ElderGuardian,
160            ParticleKind::EnchantedHit => Self::EnchantedHit,
161            ParticleKind::Enchant => Self::Enchant,
162            ParticleKind::EndRod => Self::EndRod,
163            ParticleKind::EntityEffect => Self::EntityEffect(ColorParticle::default()),
164            ParticleKind::ExplosionEmitter => Self::ExplosionEmitter,
165            ParticleKind::Explosion => Self::Explosion,
166            ParticleKind::Gust => Self::Gust,
167            ParticleKind::SonicBoom => Self::SonicBoom,
168            ParticleKind::FallingDust => Self::FallingDust(BlockParticle::default()),
169            ParticleKind::Firework => Self::Firework,
170            ParticleKind::Fishing => Self::Fishing,
171            ParticleKind::Flame => Self::Flame,
172            ParticleKind::CherryLeaves => Self::CherryLeaves,
173            ParticleKind::PaleOakLeaves => Self::PaleOakLeaves,
174            ParticleKind::TintedLeaves => Self::TintedLeaves,
175            ParticleKind::SculkSoul => Self::SculkSoul,
176            ParticleKind::SculkCharge => Self::SculkCharge(SculkChargeParticle::default()),
177            ParticleKind::SculkChargePop => Self::SculkChargePop,
178            ParticleKind::SoulFireFlame => Self::SoulFireFlame,
179            ParticleKind::Soul => Self::Soul,
180            ParticleKind::Flash => Self::Flash,
181            ParticleKind::HappyVillager => Self::HappyVillager,
182            ParticleKind::Composter => Self::Composter,
183            ParticleKind::Heart => Self::Heart,
184            ParticleKind::InstantEffect => Self::InstantEffect,
185            ParticleKind::Item => Self::Item(ItemParticle::default()),
186            ParticleKind::Vibration => Self::Vibration(VibrationParticle::default()),
187            ParticleKind::ItemSlime => Self::ItemSlime,
188            ParticleKind::ItemSnowball => Self::ItemSnowball,
189            ParticleKind::LargeSmoke => Self::LargeSmoke,
190            ParticleKind::Lava => Self::Lava,
191            ParticleKind::Mycelium => Self::Mycelium,
192            ParticleKind::Note => Self::Note,
193            ParticleKind::Poof => Self::Poof,
194            ParticleKind::Portal => Self::Portal,
195            ParticleKind::Rain => Self::Rain,
196            ParticleKind::Smoke => Self::Smoke,
197            ParticleKind::WhiteSmoke => Self::WhiteSmoke,
198            ParticleKind::Sneeze => Self::Sneeze,
199            ParticleKind::Spit => Self::Spit,
200            ParticleKind::SquidInk => Self::SquidInk,
201            ParticleKind::SweepAttack => Self::SweepAttack,
202            ParticleKind::TotemOfUndying => Self::TotemOfUndying,
203            ParticleKind::Underwater => Self::Underwater,
204            ParticleKind::Splash => Self::Splash,
205            ParticleKind::Witch => Self::Witch,
206            ParticleKind::BubblePop => Self::BubblePop,
207            ParticleKind::CurrentDown => Self::CurrentDown,
208            ParticleKind::BubbleColumnUp => Self::BubbleColumnUp,
209            ParticleKind::Nautilus => Self::Nautilus,
210            ParticleKind::Dolphin => Self::Dolphin,
211            ParticleKind::CampfireCosySmoke => Self::CampfireCosySmoke,
212            ParticleKind::CampfireSignalSmoke => Self::CampfireSignalSmoke,
213            ParticleKind::DrippingHoney => Self::DrippingHoney,
214            ParticleKind::FallingHoney => Self::FallingHoney,
215            ParticleKind::LandingHoney => Self::LandingHoney,
216            ParticleKind::FallingNectar => Self::FallingNectar,
217            ParticleKind::FallingSporeBlossom => Self::FallingSporeBlossom,
218            ParticleKind::Ash => Self::Ash,
219            ParticleKind::CrimsonSpore => Self::CrimsonSpore,
220            ParticleKind::WarpedSpore => Self::WarpedSpore,
221            ParticleKind::SporeBlossomAir => Self::SporeBlossomAir,
222            ParticleKind::DrippingObsidianTear => Self::DrippingObsidianTear,
223            ParticleKind::FallingObsidianTear => Self::FallingObsidianTear,
224            ParticleKind::LandingObsidianTear => Self::LandingObsidianTear,
225            ParticleKind::ReversePortal => Self::ReversePortal,
226            ParticleKind::WhiteAsh => Self::WhiteAsh,
227            ParticleKind::SmallFlame => Self::SmallFlame,
228            ParticleKind::Snowflake => Self::Snowflake,
229            ParticleKind::DrippingDripstoneLava => Self::DrippingDripstoneLava,
230            ParticleKind::FallingDripstoneLava => Self::FallingDripstoneLava,
231            ParticleKind::DrippingDripstoneWater => Self::DrippingDripstoneWater,
232            ParticleKind::FallingDripstoneWater => Self::FallingDripstoneWater,
233            ParticleKind::GlowSquidInk => Self::GlowSquidInk,
234            ParticleKind::Glow => Self::Glow,
235            ParticleKind::WaxOn => Self::WaxOn,
236            ParticleKind::WaxOff => Self::WaxOff,
237            ParticleKind::ElectricSpark => Self::ElectricSpark,
238            ParticleKind::Scrape => Self::Scrape,
239            ParticleKind::Shriek => Self::Shriek(ShriekParticle::default()),
240            ParticleKind::EggCrack => Self::EggCrack,
241            ParticleKind::DustPlume => Self::DustPlume,
242            ParticleKind::SmallGust => Self::SmallGust,
243            ParticleKind::GustEmitterLarge => Self::GustEmitterLarge,
244            ParticleKind::GustEmitterSmall => Self::GustEmitterSmall,
245            ParticleKind::Infested => Self::Infested,
246            ParticleKind::ItemCobweb => Self::ItemCobweb,
247            ParticleKind::TrialSpawnerDetection => Self::TrialSpawnerDetection,
248            ParticleKind::TrialSpawnerDetectionOminous => Self::TrialSpawnerDetectionOminous,
249            ParticleKind::VaultConnection => Self::VaultConnection,
250            ParticleKind::DustPillar => Self::DustPillar,
251            ParticleKind::OminousSpawning => Self::OminousSpawning,
252            ParticleKind::RaidOmen => Self::RaidOmen,
253            ParticleKind::TrialOmen => Self::TrialOmen,
254            ParticleKind::Trail => Self::Trail,
255            ParticleKind::BlockCrumble => Self::BlockCrumble,
256            ParticleKind::Firefly => Self::Firefly,
257            ParticleKind::CopperFireFlame => Self::CopperFireFlame,
258        }
259    }
260}
261
262impl Default for Particle {
263    fn default() -> Self {
264        Self::EntityEffect(ColorParticle::default())
265    }
266}
267
268#[derive(Debug, Clone, AzBuf, Default, PartialEq)]
269pub struct BlockParticle {
270    pub block_state: BlockState,
271}
272#[derive(Debug, Clone, AzBuf, Default, PartialEq)]
273pub struct DustParticle {
274    pub color: RgbColor,
275    /// The scale, will be clamped between 0.01 and 4.
276    pub scale: f32,
277}
278
279#[derive(Debug, Clone, AzBuf, Default, PartialEq)]
280pub struct DustColorTransitionParticle {
281    pub from: RgbColor,
282    pub to: RgbColor,
283    /// The scale, will be clamped between 0.01 and 4.
284    pub scale: f32,
285}
286
287#[derive(Debug, Clone, AzBuf, Default, PartialEq)]
288pub struct ColorParticle {
289    pub color: RgbColor,
290}
291
292#[derive(Debug, Clone, AzBuf, Default, PartialEq)]
293pub struct ItemParticle {
294    pub item: ItemStack,
295}
296
297#[derive(Debug, Clone, AzBuf, Default, PartialEq)]
298pub struct VibrationParticle {
299    pub position: PositionSource,
300    #[var]
301    pub ticks: u32,
302}
303
304#[derive(Debug, Clone, AzBuf, PartialEq)]
305pub enum PositionSource {
306    Block(BlockPos),
307    Entity {
308        #[var]
309        id: MinecraftEntityId,
310        y_offset: f32,
311    },
312}
313impl Default for PositionSource {
314    fn default() -> Self {
315        // bad default but hopefully it never gets used anyways
316        Self::Block(BlockPos::default())
317    }
318}
319
320#[derive(Debug, Clone, AzBuf, Default, PartialEq)]
321pub struct SculkChargeParticle {
322    pub roll: f32,
323}
324
325#[derive(Debug, Clone, AzBuf, Default, PartialEq)]
326pub struct ShriekParticle {
327    #[var]
328    pub delay: i32, // The time in ticks before the particle is displayed
329}
azalea_entity/particle.rs

azalea_entity/
particle.rs
