veloren_common/terrain/
block.rs

1use super::{
2    SpriteKind,
3    sprite::{self, RelativeNeighborPosition},
4};
5use crate::{
6    comp::{fluid_dynamics::LiquidKind, tool::ToolKind},
7    consts::FRIC_GROUND,
8    effect::BuffEffect,
9    make_case_elim, rtsim,
10    vol::FilledVox,
11};
12use num_derive::FromPrimitive;
13use num_traits::FromPrimitive;
14use serde::{Deserialize, Serialize};
15use std::ops::Deref;
16use strum::{Display, EnumIter, EnumString};
17use vek::*;
18
19make_case_elim!(
20    block_kind,
21    #[derive(
22        Copy,
23        Clone,
24        Debug,
25        Hash,
26        Eq,
27        PartialEq,
28        Serialize,
29        Deserialize,
30        FromPrimitive,
31        EnumString,
32        EnumIter,
33        Display,
34    )]
35    #[repr(u8)]
36    pub enum BlockKind {
37        Air = 0x00, // Air counts as a fluid
38        Water = 0x01,
39        // 0x02 <= x < 0x10 are reserved for other fluids. These are 2^n aligned to allow bitwise
40        // checking of common conditions. For example, `is_fluid` is just `block_kind &
41        // 0x0F == 0` (this is a very common operation used in meshing that could do with
42        // being *very* fast).
43        Rock = 0x10,
44        WeakRock = 0x11, // Explodable
45        Lava = 0x12,     // TODO: Reevaluate whether this should be in the rock section
46        GlowingRock = 0x13,
47        GlowingWeakRock = 0x14,
48        // 0x12 <= x < 0x20 is reserved for future rocks
49        Grass = 0x20, // Note: *not* the same as grass sprites
50        Snow = 0x21,
51        // Snow to use with sites, to not attract snowfall particles
52        ArtSnow = 0x22,
53        // 0x21 <= x < 0x30 is reserved for future grasses
54        Earth = 0x30,
55        Sand = 0x31,
56        // 0x32 <= x < 0x40 is reserved for future earths/muds/gravels/sands/etc.
57        Wood = 0x40,
58        Leaves = 0x41,
59        GlowingMushroom = 0x42,
60        Ice = 0x43,
61        ArtLeaves = 0x44,
62        // 0x43 <= x < 0x50 is reserved for future tree parts
63        // Covers all other cases (we sometimes have bizarrely coloured misc blocks, and also we
64        // often want to experiment with new kinds of block without allocating them a
65        // dedicated block kind.
66        Misc = 0xFE,
67    }
68);
69
70impl BlockKind {
71    #[inline]
72    pub const fn is_air(&self) -> bool { matches!(self, BlockKind::Air) }
73
74    /// Determine whether the block kind is a gas or a liquid. This does not
75    /// consider any sprites that may occupy the block (the definition of
76    /// fluid is 'a substance that deforms to fit containers')
77    #[inline]
78    pub const fn is_fluid(&self) -> bool { *self as u8 & 0xF0 == 0x00 }
79
80    #[inline]
81    pub const fn is_liquid(&self) -> bool { self.is_fluid() && !self.is_air() }
82
83    #[inline]
84    pub const fn liquid_kind(&self) -> Option<LiquidKind> {
85        Some(match self {
86            BlockKind::Water => LiquidKind::Water,
87            BlockKind::Lava => LiquidKind::Lava,
88            _ => return None,
89        })
90    }
91
92    /// Determine whether the block is filled (i.e: fully solid). Right now,
93    /// this is the opposite of being a fluid.
94    #[inline]
95    pub const fn is_filled(&self) -> bool { !self.is_fluid() }
96
97    /// Determine whether the block has an RGB color stored in the attribute
98    /// fields.
99    #[inline]
100    pub const fn has_color(&self) -> bool { self.is_filled() }
101
102    /// Determine whether the block is 'terrain-like'. This definition is
103    /// arbitrary, but includes things like rocks, soils, sands, grass, and
104    /// other blocks that might be expected to the landscape. Plant matter and
105    /// snow are *not* included.
106    #[inline]
107    pub const fn is_terrain(&self) -> bool {
108        matches!(
109            self,
110            BlockKind::Rock
111                | BlockKind::WeakRock
112                | BlockKind::GlowingRock
113                | BlockKind::GlowingWeakRock
114                | BlockKind::Grass
115                | BlockKind::Earth
116                | BlockKind::Sand
117        )
118    }
119}
120
121/// # Format
122///
123/// ```ignore
124/// BBBBBBBB CCCCCCCC AAAAAIII IIIIIIII
125/// ```
126/// - `0..8`  : BlockKind
127/// - `8..16` : Category
128/// - `16..N` : Attributes (many fields)
129/// - `N..32` : Sprite ID
130///
131/// `N` is per-category. You can match on the category byte to find the length
132/// of the ID field.
133///
134/// Attributes are also per-category. Each category specifies its own list of
135/// attribute fields.
136///
137/// Why is the sprite ID at the end? Simply put, it makes masking faster and
138/// easier, which is important because extracting the `SpriteKind` is a more
139/// commonly performed operation than extracting attributes.
140#[derive(Copy, Clone, Debug, Eq, Hash, PartialEq, Serialize, Deserialize)]
141pub struct Block {
142    kind: BlockKind,
143    data: [u8; 3],
144}
145
146impl FilledVox for Block {
147    fn default_non_filled() -> Self { Block::air(SpriteKind::Empty) }
148
149    fn is_filled(&self) -> bool { self.kind.is_filled() }
150}
151
152impl Deref for Block {
153    type Target = BlockKind;
154
155    fn deref(&self) -> &Self::Target { &self.kind }
156}
157
158impl Block {
159    pub const MAX_HEIGHT: f32 = 3.0;
160
161    /* Constructors */
162
163    #[inline]
164    pub const fn from_raw(kind: BlockKind, data: [u8; 3]) -> Self { Self { kind, data } }
165
166    // TODO: Rename to `filled`, make caller guarantees stronger
167    #[inline]
168    #[track_caller]
169    pub const fn new(kind: BlockKind, color: Rgb<u8>) -> Self {
170        if kind.is_filled() {
171            Self::from_raw(kind, [color.r, color.g, color.b])
172        } else {
173            // Works because `SpriteKind::Empty` has no attributes
174            let data = (SpriteKind::Empty as u32).to_be_bytes();
175            Self::from_raw(kind, [data[1], data[2], data[3]])
176        }
177    }
178
179    // Only valid if `block_kind` is unfilled, so this is just a private utility
180    // method
181    #[inline]
182    pub fn unfilled(kind: BlockKind, sprite: SpriteKind) -> Self {
183        #[cfg(debug_assertions)]
184        assert!(!kind.is_filled());
185
186        Self::from_raw(kind, sprite.to_initial_bytes())
187    }
188
189    #[inline]
190    pub fn air(sprite: SpriteKind) -> Self { Self::unfilled(BlockKind::Air, sprite) }
191
192    #[inline]
193    pub const fn empty() -> Self {
194        // Works because `SpriteKind::Empty` has no attributes
195        let data = (SpriteKind::Empty as u32).to_be_bytes();
196        Self::from_raw(BlockKind::Air, [data[1], data[2], data[3]])
197    }
198
199    #[inline]
200    pub fn water(sprite: SpriteKind) -> Self { Self::unfilled(BlockKind::Water, sprite) }
201
202    /* Sprite decoding */
203
204    #[inline(always)]
205    pub const fn get_sprite(&self) -> Option<SpriteKind> {
206        if !self.kind.is_filled() {
207            SpriteKind::from_block(*self)
208        } else {
209            None
210        }
211    }
212
213    #[inline(always)]
214    pub(super) const fn sprite_category_byte(&self) -> u8 { self.data[0] }
215
216    #[inline(always)]
217    pub const fn sprite_category(&self) -> Option<sprite::Category> {
218        if self.kind.is_filled() {
219            None
220        } else {
221            sprite::Category::from_block(*self)
222        }
223    }
224
225    /// Build this block with the given sprite attribute set.
226    #[inline]
227    pub fn with_attr<A: sprite::Attribute>(
228        mut self,
229        attr: A,
230    ) -> Result<Self, sprite::AttributeError<core::convert::Infallible>> {
231        self.set_attr(attr)?;
232        Ok(self)
233    }
234
235    /// Set the given attribute of this block's sprite.
236    #[inline]
237    pub fn set_attr<A: sprite::Attribute>(
238        &mut self,
239        attr: A,
240    ) -> Result<(), sprite::AttributeError<core::convert::Infallible>> {
241        match self.sprite_category() {
242            Some(category) => category.write_attr(self, attr),
243            None => Err(sprite::AttributeError::NotPresent),
244        }
245    }
246
247    /// Get the given attribute of this block's sprite.
248    #[inline]
249    pub fn get_attr<A: sprite::Attribute>(&self) -> Result<A, sprite::AttributeError<A::Error>> {
250        match self.sprite_category() {
251            Some(category) => category.read_attr(*self),
252            None => Err(sprite::AttributeError::NotPresent),
253        }
254    }
255
256    pub fn sprite_z_rot(&self) -> Option<f32> {
257        self.get_attr::<sprite::Ori>()
258            .ok()
259            .map(|ori| std::f32::consts::PI * 0.25 * ori.0 as f32)
260    }
261
262    pub fn sprite_mirror_vec(&self) -> Vec3<f32> {
263        Vec3::new(
264            self.get_attr::<sprite::MirrorX>().map(|m| m.0),
265            self.get_attr::<sprite::MirrorY>().map(|m| m.0),
266            self.get_attr::<sprite::MirrorZ>().map(|m| m.0),
267        )
268        .map(|b| match b.unwrap_or(false) {
269            true => -1.0,
270            false => 1.0,
271        })
272    }
273
274    #[inline(always)]
275    pub(super) const fn data(&self) -> [u8; 3] { self.data }
276
277    #[inline(always)]
278    pub(super) const fn with_data(mut self, data: [u8; 3]) -> Self {
279        self.data = data;
280        self
281    }
282
283    #[inline(always)]
284    pub(super) const fn to_be_u32(self) -> u32 {
285        u32::from_be_bytes([self.kind as u8, self.data[0], self.data[1], self.data[2]])
286    }
287
288    #[inline]
289    pub fn get_color(&self) -> Option<Rgb<u8>> {
290        if self.has_color() {
291            Some(self.data.into())
292        } else {
293            None
294        }
295    }
296
297    /// Returns the rtsim resource, if any, that this block corresponds to. If
298    /// you want the scarcity of a block to change with rtsim's resource
299    /// depletion tracking, you can do so by editing this function.
300    // TODO: Return type should be `Option<&'static [(rtsim::TerrainResource, f32)]>` to allow
301    // fractional quantities and multiple resources per sprite
302    #[inline]
303    pub fn get_rtsim_resource(&self) -> Option<rtsim::TerrainResource> {
304        match self.get_sprite()? {
305            SpriteKind::Stones => Some(rtsim::TerrainResource::Stone),
306            SpriteKind::Twigs
307                | SpriteKind::Wood
308                | SpriteKind::Bamboo
309                | SpriteKind::Hardwood
310                | SpriteKind::Ironwood
311                | SpriteKind::Frostwood
312                | SpriteKind::Eldwood => Some(rtsim::TerrainResource::Wood),
313            SpriteKind::Amethyst
314                | SpriteKind::Ruby
315                | SpriteKind::Sapphire
316                | SpriteKind::Emerald
317                | SpriteKind::Topaz
318                | SpriteKind::Diamond
319                | SpriteKind::CrystalHigh
320                | SpriteKind::CrystalLow => Some(rtsim::TerrainResource::Gem),
321            SpriteKind::Bloodstone
322                | SpriteKind::Coal
323                | SpriteKind::Cobalt
324                | SpriteKind::Copper
325                | SpriteKind::Iron
326                | SpriteKind::Tin
327                | SpriteKind::Silver
328                | SpriteKind::Gold => Some(rtsim::TerrainResource::Ore),
329
330            SpriteKind::LongGrass
331                | SpriteKind::MediumGrass
332                | SpriteKind::ShortGrass
333                | SpriteKind::LargeGrass
334                | SpriteKind::GrassBlue
335                | SpriteKind::SavannaGrass
336                | SpriteKind::TallSavannaGrass
337                | SpriteKind::RedSavannaGrass
338                | SpriteKind::JungleRedGrass
339                | SpriteKind::Fern => Some(rtsim::TerrainResource::Grass),
340            SpriteKind::BlueFlower
341                | SpriteKind::PinkFlower
342                | SpriteKind::PurpleFlower
343                | SpriteKind::RedFlower
344                | SpriteKind::WhiteFlower
345                | SpriteKind::YellowFlower
346                | SpriteKind::Sunflower
347                | SpriteKind::Moonbell
348                | SpriteKind::Pyrebloom => Some(rtsim::TerrainResource::Flower),
349            SpriteKind::Reed
350                | SpriteKind::Flax
351                | SpriteKind::WildFlax
352                | SpriteKind::Cotton
353                | SpriteKind::Corn
354                | SpriteKind::WheatYellow
355                | SpriteKind::WheatGreen => Some(rtsim::TerrainResource::Plant),
356            SpriteKind::Apple
357                | SpriteKind::Pumpkin
358                | SpriteKind::Beehive // TODO: Not a fruit, but kind of acts like one
359                | SpriteKind::Coconut => Some(rtsim::TerrainResource::Fruit),
360            SpriteKind::Lettuce
361                | SpriteKind::Carrot
362                | SpriteKind::Tomato
363                | SpriteKind::Radish
364                | SpriteKind::Turnip => Some(rtsim::TerrainResource::Vegetable),
365            SpriteKind::Mushroom
366                | SpriteKind::CaveMushroom
367                | SpriteKind::CeilingMushroom
368                | SpriteKind::RockyMushroom
369                | SpriteKind::LushMushroom
370                | SpriteKind::GlowMushroom => Some(rtsim::TerrainResource::Mushroom),
371
372            SpriteKind::Chest
373                | SpriteKind::ChestBuried
374                | SpriteKind::PotionMinor
375                | SpriteKind::DungeonChest0
376                | SpriteKind::DungeonChest1
377                | SpriteKind::DungeonChest2
378                | SpriteKind::DungeonChest3
379                | SpriteKind::DungeonChest4
380                | SpriteKind::DungeonChest5
381                | SpriteKind::CoralChest
382                | SpriteKind::HaniwaUrn
383                | SpriteKind::TerracottaChest
384                | SpriteKind::SahaginChest
385                | SpriteKind::Crate
386                | SpriteKind::CommonLockedChest => Some(rtsim::TerrainResource::Loot),
387            _ => None,
388        }
389        // Don't count collected sprites.
390        // TODO: we may want to have rtsim still spawn these sprites when depleted by spawning them
391        // in the "collected" state, see `into_collected` for sprites that would need this.
392        .filter(|_|  matches!(self.get_attr(), Ok(sprite::Collectable(false)) | Err(_)))
393    }
394
395    #[inline]
396    pub fn get_glow(&self) -> Option<u8> {
397        let glow_level = match self.kind() {
398            BlockKind::Lava => 24,
399            BlockKind::GlowingRock | BlockKind::GlowingWeakRock => 10,
400            BlockKind::GlowingMushroom => 20,
401            _ => match self.get_sprite()? {
402                SpriteKind::StreetLamp | SpriteKind::StreetLampTall | SpriteKind::BonfireMLit => 24,
403                SpriteKind::Ember | SpriteKind::FireBlock => 20,
404                SpriteKind::WallLamp
405                | SpriteKind::WallLampSmall
406                | SpriteKind::WallLampWizard
407                | SpriteKind::WallLampMesa
408                | SpriteKind::WallSconce
409                | SpriteKind::FireBowlGround
410                | SpriteKind::MesaLantern
411                | SpriteKind::LampTerracotta
412                | SpriteKind::ChristmasOrnament
413                | SpriteKind::CliffDecorBlock
414                | SpriteKind::Orb
415                | SpriteKind::Candle => 16,
416                SpriteKind::DiamondLight => 30,
417                SpriteKind::VeloriteFrag
418                | SpriteKind::GrassBlueShort
419                | SpriteKind::GrassBlueMedium
420                | SpriteKind::GrassBlueLong
421                | SpriteKind::CavernLillypadBlue
422                | SpriteKind::MycelBlue
423                | SpriteKind::Mold
424                | SpriteKind::CeilingMushroom => 6,
425                SpriteKind::CaveMushroom
426                | SpriteKind::GlowMushroom
427                | SpriteKind::CookingPot
428                | SpriteKind::CrystalHigh
429                | SpriteKind::LanternFlower
430                | SpriteKind::CeilingLanternFlower
431                | SpriteKind::LanternPlant
432                | SpriteKind::CeilingLanternPlant
433                | SpriteKind::CrystalLow => 10,
434                SpriteKind::SewerMushroom => 16,
435                SpriteKind::Lodestone => 3,
436                SpriteKind::Lantern
437                | SpriteKind::LanternpostWoodLantern
438                | SpriteKind::LanternAirshipWallBlackS
439                | SpriteKind::LanternAirshipWallBrownS
440                | SpriteKind::LanternAirshipWallChestnutS
441                | SpriteKind::LanternAirshipWallRedS
442                | SpriteKind::LanternAirshipGroundBlackS
443                | SpriteKind::LanternAirshipGroundBrownS
444                | SpriteKind::LanternAirshipGroundChestnutS
445                | SpriteKind::LanternAirshipGroundRedS
446                | SpriteKind::LampMetalShinglesCyan
447                | SpriteKind::LampMetalShinglesRed => 24,
448                SpriteKind::Velorite | SpriteKind::TerracottaStatue => 8,
449                SpriteKind::SeashellLantern | SpriteKind::GlowIceCrystal => 16,
450                SpriteKind::SeaDecorEmblem => 12,
451                SpriteKind::SeaDecorBlock
452                | SpriteKind::HaniwaKeyDoor
453                | SpriteKind::VampireKeyDoor => 10,
454                _ => return None,
455            },
456        };
457
458        if self
459            .get_attr::<sprite::LightEnabled>()
460            .map_or(true, |l| l.0)
461        {
462            Some(glow_level)
463        } else {
464            None
465        }
466    }
467
468    // minimum block, attenuation
469    #[inline]
470    pub fn get_max_sunlight(&self) -> (u8, f32) {
471        match self.kind() {
472            BlockKind::Water => (0, 0.4),
473            BlockKind::Leaves => (9, 255.0),
474            BlockKind::ArtLeaves => (9, 255.0),
475            BlockKind::Wood => (6, 2.0),
476            BlockKind::Snow => (6, 2.0),
477            BlockKind::ArtSnow => (6, 2.0),
478            BlockKind::Ice => (4, 2.0),
479            _ if self.is_opaque() => (0, 255.0),
480            _ => (0, 0.0),
481        }
482    }
483
484    // Filled blocks or sprites
485    #[inline]
486    pub fn is_solid(&self) -> bool {
487        self.get_sprite()
488            .map(|s| s.solid_height().is_some())
489            .unwrap_or(!matches!(self.kind, BlockKind::Lava))
490    }
491
492    pub fn valid_collision_dir(
493        &self,
494        entity_aabb: Aabb<f32>,
495        block_aabb: Aabb<f32>,
496        move_dir: Vec3<f32>,
497    ) -> bool {
498        self.get_sprite().is_none_or(|sprite| {
499            sprite.valid_collision_dir(entity_aabb, block_aabb, move_dir, self)
500        })
501    }
502
503    /// Can this block be exploded? If so, what 'power' is required to do so?
504    /// Note that we don't really define what 'power' is. Consider the units
505    /// arbitrary and only important when compared to one-another.
506    #[inline]
507    pub fn explode_power(&self) -> Option<f32> {
508        // Explodable means that the terrain sprite will get removed anyway,
509        // so all is good for empty fluids.
510        match self.kind() {
511            BlockKind::Leaves => Some(0.25),
512            BlockKind::ArtLeaves => Some(0.25),
513            BlockKind::Grass => Some(0.5),
514            BlockKind::WeakRock => Some(0.75),
515            BlockKind::Snow => Some(0.1),
516            BlockKind::Ice => Some(0.5),
517            BlockKind::Wood => Some(4.5),
518            BlockKind::Lava => None,
519            _ => self.get_sprite().and_then(|sprite| match sprite {
520                sprite if sprite.is_defined_as_container() => None,
521                SpriteKind::Keyhole
522                | SpriteKind::KeyDoor
523                | SpriteKind::BoneKeyhole
524                | SpriteKind::BoneKeyDoor
525                | SpriteKind::OneWayWall
526                | SpriteKind::KeyholeBars
527                | SpriteKind::DoorBars => None,
528                SpriteKind::Anvil
529                | SpriteKind::Cauldron
530                | SpriteKind::CookingPot
531                | SpriteKind::CraftingBench
532                | SpriteKind::Forge
533                | SpriteKind::Loom
534                | SpriteKind::SpinningWheel
535                | SpriteKind::DismantlingBench
536                | SpriteKind::RepairBench
537                | SpriteKind::TanningRack
538                | SpriteKind::Chest
539                | SpriteKind::DungeonChest0
540                | SpriteKind::DungeonChest1
541                | SpriteKind::DungeonChest2
542                | SpriteKind::DungeonChest3
543                | SpriteKind::DungeonChest4
544                | SpriteKind::DungeonChest5
545                | SpriteKind::CoralChest
546                | SpriteKind::HaniwaUrn
547                | SpriteKind::HaniwaKeyDoor
548                | SpriteKind::HaniwaKeyhole
549                | SpriteKind::VampireKeyDoor
550                | SpriteKind::VampireKeyhole
551                | SpriteKind::MyrmidonKeyDoor
552                | SpriteKind::MyrmidonKeyhole
553                | SpriteKind::MinotaurKeyhole
554                | SpriteKind::HaniwaTrap
555                | SpriteKind::HaniwaTrapTriggered
556                | SpriteKind::ChestBuried
557                | SpriteKind::CommonLockedChest
558                | SpriteKind::TerracottaChest
559                | SpriteKind::SahaginChest
560                | SpriteKind::SeaDecorBlock
561                | SpriteKind::SeaDecorChain
562                | SpriteKind::SeaDecorWindowHor
563                | SpriteKind::SeaDecorWindowVer
564                | SpriteKind::WitchWindow
565                | SpriteKind::Rope
566                | SpriteKind::MetalChain
567                | SpriteKind::IronSpike
568                | SpriteKind::HotSurface
569                | SpriteKind::FireBlock
570                | SpriteKind::GlassBarrier
571                | SpriteKind::GlassKeyhole
572                | SpriteKind::SahaginKeyhole
573                | SpriteKind::SahaginKeyDoor
574                | SpriteKind::TerracottaKeyDoor
575                | SpriteKind::TerracottaKeyhole
576                | SpriteKind::TerracottaStatue
577                | SpriteKind::TerracottaBlock => None,
578                SpriteKind::EnsnaringVines
579                | SpriteKind::EnsnaringWeb
580                | SpriteKind::SeaUrchin
581                | SpriteKind::IceSpike
582                | SpriteKind::DiamondLight => Some(0.1),
583                _ => Some(0.25),
584            }),
585        }
586    }
587
588    /// Whether the block containes a sprite that is collectible.
589    ///
590    /// Note, this is based on [`SpriteKind::collectible_info`] and accounts for
591    /// if the [`Collectable`][`sprite::Collectable`] sprite attr is `false`.
592    #[inline]
593    pub fn is_collectible(&self) -> bool {
594        self.get_sprite()
595            .is_some_and(|s| s.collectible_info().is_some())
596            && matches!(self.get_attr(), Ok(sprite::Collectable(true)) | Err(_))
597    }
598
599    /// Can this sprite be picked up to yield an item without a tool?
600    ///
601    /// Note, this is based on [`SpriteKind::collectible_info`] and accounts for
602    /// if the [`Collectable`][`sprite::Collectable`] sprite attr is `false`.
603    #[inline]
604    pub fn is_directly_collectible(&self) -> bool {
605        // NOTE: This doesn't require `SpriteCfg` because `SpriteCfg::loot_table` is
606        // only expected to be set for `collectible_info.is_some()` sprites!
607        self.get_sprite()
608            .is_some_and(|s| s.collectible_info() == Some(None))
609            && matches!(self.get_attr(), Ok(sprite::Collectable(true)) | Err(_))
610    }
611
612    #[inline]
613    pub fn is_mountable(&self) -> bool { self.mount_offset().is_some() }
614
615    /// Get the position and direction to mount this block if any.
616    pub fn mount_offset(&self) -> Option<(Vec3<f32>, Vec3<f32>)> {
617        self.get_sprite().and_then(|sprite| sprite.mount_offset())
618    }
619
620    pub fn mount_buffs(&self) -> Option<Vec<BuffEffect>> {
621        self.get_sprite().and_then(|sprite| sprite.mount_buffs())
622    }
623
624    pub fn is_controller(&self) -> bool {
625        self.get_sprite()
626            .is_some_and(|sprite| sprite.is_controller())
627    }
628
629    #[inline]
630    pub fn is_bonkable(&self) -> bool {
631        match self.get_sprite() {
632            Some(
633                SpriteKind::Apple | SpriteKind::Beehive | SpriteKind::Coconut | SpriteKind::Bomb,
634            ) => self.is_solid(),
635            _ => false,
636        }
637    }
638
639    #[inline]
640    pub fn is_owned(&self) -> bool {
641        self.get_attr::<sprite::Owned>()
642            .is_ok_and(|sprite::Owned(b)| b)
643    }
644
645    /// The tool required to mine this block. For blocks that cannot be mined,
646    /// `None` is returned.
647    #[inline]
648    pub fn mine_tool(&self) -> Option<ToolKind> {
649        match self.kind() {
650            BlockKind::WeakRock | BlockKind::Ice | BlockKind::GlowingWeakRock => {
651                Some(ToolKind::Pick)
652            },
653            _ => self.get_sprite().and_then(|s| s.mine_tool()),
654        }
655    }
656
657    #[inline]
658    pub fn is_opaque(&self) -> bool {
659        match self.get_sprite() {
660            Some(
661                SpriteKind::Keyhole
662                | SpriteKind::KeyDoor
663                | SpriteKind::KeyholeBars
664                | SpriteKind::DoorBars,
665            ) => true,
666            Some(_) => false,
667            None => self.kind().is_filled(),
668        }
669    }
670
671    #[inline]
672    pub fn solid_height(&self) -> f32 {
673        self.get_sprite()
674            .map(|s| s.solid_height().unwrap_or(0.0))
675            .unwrap_or(1.0)
676    }
677
678    /// Get the friction constant used to calculate surface friction when
679    /// walking/climbing. Currently has no units.
680    #[inline]
681    pub fn get_friction(&self) -> f32 {
682        match self.kind() {
683            BlockKind::Ice => FRIC_GROUND * 0.1,
684            _ => FRIC_GROUND,
685        }
686    }
687
688    /// Get the traction permitted by this block as a proportion of the friction
689    /// applied.
690    ///
691    /// 1.0 = default, 0.0 = completely inhibits movement, > 1.0 = potential for
692    /// infinite acceleration (in a vacuum).
693    #[inline]
694    pub fn get_traction(&self) -> f32 {
695        match self.kind() {
696            BlockKind::Snow | BlockKind::ArtSnow => 0.8,
697            _ => 1.0,
698        }
699    }
700
701    /// Apply a light toggle to this block, if possible
702    pub fn with_toggle_light(self, enable: bool) -> Option<Self> {
703        self.with_attr(sprite::LightEnabled(enable)).ok()
704    }
705
706    #[inline]
707    pub fn kind(&self) -> BlockKind { self.kind }
708
709    /// If possible, copy the sprite/color data of the other block.
710    #[inline]
711    #[must_use]
712    pub fn with_data_of(mut self, other: Block) -> Self {
713        if self.is_filled() == other.is_filled() {
714            self = self.with_data(other.data());
715        }
716        self
717    }
718
719    /// If this block is a fluid, replace its sprite.
720    #[inline]
721    #[must_use]
722    pub fn with_sprite(self, sprite: SpriteKind) -> Self {
723        match self.try_with_sprite(sprite) {
724            Ok(b) => b,
725            Err(b) => b,
726        }
727    }
728
729    /// If this block is a fluid, replace its sprite.
730    ///
731    /// Returns block in `Err` if the sprite was not replaced.
732    #[inline]
733    pub fn try_with_sprite(self, sprite: SpriteKind) -> Result<Self, Self> {
734        if self.is_filled() {
735            Err(self)
736        } else {
737            Ok(Self::unfilled(self.kind, sprite))
738        }
739    }
740
741    /// If this block can have orientation, give it a new orientation.
742    #[inline]
743    #[must_use]
744    pub fn with_ori(self, ori: u8) -> Option<Self> { self.with_attr(sprite::Ori(ori)).ok() }
745
746    /// If this block can have adjacent sprites, give it its AdjacentType
747    #[inline]
748    #[must_use]
749    pub fn with_adjacent_type(self, adj: RelativeNeighborPosition) -> Option<Self> {
750        self.with_attr(sprite::AdjacentType(adj as u8)).ok()
751    }
752
753    /// Remove the terrain sprite or solid aspects of a block
754    #[inline]
755    #[must_use]
756    pub fn into_vacant(self) -> Self {
757        if self.is_fluid() {
758            Block::unfilled(self.kind(), SpriteKind::Empty)
759        } else {
760            // FIXME: Figure out if there's some sensible way to determine what medium to
761            // replace a filled block with if it's removed.
762            Block::air(SpriteKind::Empty)
763        }
764    }
765
766    /// Apply the effect of collecting the sprite in this block.
767    ///
768    /// This sets the `Collectable` attribute to `false` for some sprites like
769    /// `Lettuce`. Other sprites will simply be removed via
770    /// [`into_vacant`][Self::into_vacant].
771    #[inline]
772    #[must_use]
773    pub fn into_collected(self) -> Self {
774        match self.get_sprite() {
775            Some(SpriteKind::Lettuce) => self.with_attr(sprite::Collectable(false)).expect(
776                "Setting collectable will not fail since this sprite has Collectable attribute",
777            ),
778            _ => self.into_vacant(),
779        }
780    }
781
782    /// Attempt to convert a [`u32`] to a block
783    #[inline]
784    #[must_use]
785    pub fn from_u32(x: u32) -> Option<Self> {
786        let [bk, r, g, b] = x.to_le_bytes();
787        let block = Self {
788            kind: BlockKind::from_u8(bk)?,
789            data: [r, g, b],
790        };
791
792        (block.kind.is_filled() || SpriteKind::from_block(block).is_some()).then_some(block)
793    }
794
795    #[inline]
796    pub fn to_u32(self) -> u32 {
797        u32::from_le_bytes([self.kind as u8, self.data[0], self.data[1], self.data[2]])
798    }
799}
800
801const _: () = assert!(core::mem::size_of::<BlockKind>() == 1);
802const _: () = assert!(core::mem::size_of::<Block>() == 4);
veloren_common/terrain/block.rs

veloren_common/terrain/
block.rs
