steel_core/behavior/blocks/fluid/

bubble_column_block.rs

use std::sync::Arc;

use steel_macros::block_behavior;
use steel_registry::blocks::BlockRef;
use steel_registry::blocks::block_state_ext::BlockStateExt as _;
use steel_registry::blocks::properties::{BlockStateProperties, Direction};
use steel_registry::item_stack::ItemStack;
use steel_registry::sound_events;
use steel_registry::vanilla_block_tags::BlockTag;
use steel_registry::vanilla_blocks;
use steel_registry::vanilla_fluid_tags::FluidTag;
use steel_registry::vanilla_fluids;
use steel_registry::vanilla_items;
use steel_utils::types::UpdateFlags;
use steel_utils::{BlockPos, BlockStateId};

use crate::behavior::context::BlockPlaceContext;
use crate::behavior::{
    BLOCK_BEHAVIORS, BlockCollisionContext, block::BlockBehavior, block::PickupResult,
};
use crate::entity::{Entity, InsideBlockEffectCollector};
use crate::player::Player;
use crate::world::{
    ConditionalBlockSetResult, LevelAccessor, LevelReader, ScheduledTickAccess, World,
};

/// Vanilla `BubbleColumnBlock` column propagation and fluid state.
#[block_behavior]
pub struct BubbleColumnBlock {
    block: BlockRef,
}

impl BubbleColumnBlock {
    /// Creates a bubble column block behavior.
    #[must_use]
    pub const fn new(block: BlockRef) -> Self {
        Self { block }
    }

    pub(super) fn update_column(
        bubble_column: BlockRef,
        level: &dyn LevelAccessor,
        occupy_at: BlockPos,
        below_state: BlockStateId,
    ) {
        Self::update_column_with_state(
            bubble_column,
            level,
            occupy_at,
            level.get_block_state(occupy_at),
            below_state,
        );
    }

    fn update_column_with_state(
        bubble_column: BlockRef,
        level: &dyn LevelAccessor,
        occupy_at: BlockPos,
        occupy_state: BlockStateId,
        below_state: BlockStateId,
    ) {
        if !Self::can_occupy(bubble_column, occupy_state) {
            return;
        }

        let column_state = Self::column_state(bubble_column, below_state, occupy_state);
        level.set_block_state(occupy_at, column_state, UpdateFlags::UPDATE_CLIENTS);

        let mut pos = occupy_at.above();
        while Self::can_occupy(bubble_column, level.get_block_state(pos)) {
            if !level.set_block_state(pos, column_state, UpdateFlags::UPDATE_CLIENTS) {
                return;
            }
            pos = pos.above();
        }
    }

    pub(super) fn can_occupy(bubble_column: BlockRef, occupy_state: BlockStateId) -> bool {
        if occupy_state.get_block() == bubble_column {
            return true;
        }

        let fluid_state = occupy_state.get_fluid_state();
        fluid_state
            .fluid_id
            .has_tag(&FluidTag::BUBBLE_COLUMN_CAN_OCCUPY)
            && occupy_state.get_block() == &vanilla_blocks::WATER
            && fluid_state.is_source()
            && fluid_state.amount >= 8
    }

    fn column_state(
        bubble_column: BlockRef,
        below_state: BlockStateId,
        occupy_state: BlockStateId,
    ) -> BlockStateId {
        if below_state.get_block() == bubble_column {
            return below_state;
        }
        if below_state
            .get_block()
            .has_tag(&BlockTag::ENABLES_BUBBLE_COLUMN_PUSH_UP)
        {
            return bubble_column
                .default_state()
                .set_value(&BlockStateProperties::DRAG, false);
        }
        if below_state
            .get_block()
            .has_tag(&BlockTag::ENABLES_BUBBLE_COLUMN_DRAG_DOWN)
        {
            return bubble_column
                .default_state()
                .set_value(&BlockStateProperties::DRAG, true);
        }

        if occupy_state.get_block() == bubble_column {
            vanilla_blocks::WATER.default_state()
        } else {
            occupy_state
        }
    }

    fn is_open_above(level: &dyn LevelReader, pos: BlockPos) -> bool {
        let above_pos = pos.above();
        let above_state = level.get_block_state(above_pos);
        let behavior = BLOCK_BEHAVIORS.get_behavior(above_state.get_block());
        behavior
            .get_collision_shape(above_state, level, pos, BlockCollisionContext::empty())
            .is_empty()
            && above_state.get_fluid_state().is_empty()
    }

    fn apply_entity_effect(
        state: BlockStateId,
        level: &dyn LevelReader,
        pos: BlockPos,
        entity: &dyn Entity,
        is_precise: bool,
    ) {
        if !is_precise {
            return;
        }

        let drag_down = state.get_value(&BlockStateProperties::DRAG);
        if Self::is_open_above(level, pos) {
            entity.on_above_bubble_column(drag_down, pos);
        } else {
            entity.on_inside_bubble_column(drag_down);
        }
    }
}

impl BlockBehavior for BubbleColumnBlock {
    fn get_state_for_placement(&self, _context: &BlockPlaceContext<'_>) -> Option<BlockStateId> {
        Some(self.block.default_state())
    }

    fn can_survive(&self, _state: BlockStateId, world: &dyn LevelReader, pos: BlockPos) -> bool {
        let below = world.get_block_state(pos.below());
        below.get_block() == self.block
            || below
                .get_block()
                .has_tag(&BlockTag::ENABLES_BUBBLE_COLUMN_PUSH_UP)
            || below
                .get_block()
                .has_tag(&BlockTag::ENABLES_BUBBLE_COLUMN_DRAG_DOWN)
    }

    fn update_shape(
        &self,
        state: BlockStateId,
        world: &dyn ScheduledTickAccess,
        pos: BlockPos,
        direction: Direction,
        _neighbor_pos: BlockPos,
        neighbor_state: BlockStateId,
    ) -> BlockStateId {
        let delay = world.fluid_tick_delay(&vanilla_fluids::WATER);
        let _ = world.schedule_fluid_tick_default(pos, &vanilla_fluids::WATER, delay);

        if !self.can_survive(state, world, pos)
            || direction == Direction::Down
            || (direction == Direction::Up
                && neighbor_state.get_block() != self.block
                && Self::can_occupy(self.block, neighbor_state))
        {
            let _ = world.schedule_block_tick_default(pos, self.block, 5);
        }

        state
    }

    fn tick(&self, state: BlockStateId, world: &Arc<World>, pos: BlockPos) {
        Self::update_column_with_state(
            self.block,
            world,
            pos,
            state,
            world.get_block_state(pos.below()),
        );
    }

    fn entity_inside(
        &self,
        state: BlockStateId,
        world: &Arc<World>,
        pos: BlockPos,
        entity: &dyn Entity,
        _effect_collector: &mut InsideBlockEffectCollector,
        is_precise: bool,
    ) {
        Self::apply_entity_effect(state, world.as_ref(), pos, entity, is_precise);
    }

    fn pickup_block(
        &self,
        world: &Arc<World>,
        pos: BlockPos,
        state: BlockStateId,
        _player: Option<&Player>,
    ) -> Option<PickupResult> {
        if world.set_block_if_unchanged(
            pos,
            state,
            vanilla_blocks::AIR.default_state(),
            UpdateFlags::UPDATE_ALL_IMMEDIATE,
        ) != ConditionalBlockSetResult::Changed
        {
            return None;
        }
        Some(PickupResult {
            filled_bucket: ItemStack::new(&vanilla_items::WATER_BUCKET),
            sound: Some(&sound_events::ITEM_BUCKET_FILL),
        })
    }
}

#[cfg(test)]
mod tests {
    use std::sync::Weak;

    use glam::DVec3;
    use steel_registry::entity_type::EntityTypeRef;
    use steel_registry::init_vanilla_registry;
    use steel_registry::vanilla_entities;
    use steel_utils::locks::SyncMutex;

    use super::*;
    use crate::behavior::init_behaviors;
    use crate::entity::EntityBase;
    use crate::test_support::TestLevel;

    #[derive(Debug, Clone, Copy, PartialEq, Eq)]
    enum BubbleColumnCall {
        Above { drag_down: bool, pos: BlockPos },
        Inside { drag_down: bool },
    }

    struct RecordingEntity {
        base: EntityBase,
        calls: SyncMutex<Vec<BubbleColumnCall>>,
    }

    impl RecordingEntity {
        fn new() -> Self {
            Self {
                base: EntityBase::new(
                    1,
                    DVec3::ZERO,
                    vanilla_entities::ITEM.dimensions,
                    Weak::new(),
                ),
                calls: SyncMutex::new(Vec::new()),
            }
        }

        fn calls(&self) -> Vec<BubbleColumnCall> {
            self.calls.lock().clone()
        }
    }

    crate::entity::impl_test_downcast_type!(RecordingEntity);

    impl Entity for RecordingEntity {
        fn base(&self) -> &EntityBase {
            &self.base
        }

        fn entity_type(&self) -> EntityTypeRef {
            &vanilla_entities::ITEM
        }

        fn on_above_bubble_column(&self, drag_down: bool, pos: BlockPos) {
            self.calls
                .lock()
                .push(BubbleColumnCall::Above { drag_down, pos });
        }

        fn on_inside_bubble_column(&self, drag_down: bool) {
            self.calls
                .lock()
                .push(BubbleColumnCall::Inside { drag_down });
        }
    }

    fn bubble_column_state(drag_down: bool) -> BlockStateId {
        vanilla_blocks::BUBBLE_COLUMN
            .default_state()
            .set_value(&BlockStateProperties::DRAG, drag_down)
    }

    #[test]
    fn bubble_column_update_shape_schedules_water_and_column_tick() {
        init_vanilla_registry();
        let behavior = BubbleColumnBlock::new(&vanilla_blocks::BUBBLE_COLUMN);
        let level = TestLevel::default();
        let state = vanilla_blocks::BUBBLE_COLUMN.default_state();

        let updated = behavior.update_shape(
            state,
            &level,
            BlockPos::ZERO,
            Direction::Down,
            BlockPos::ZERO.below(),
            vanilla_blocks::SOUL_SAND.default_state(),
        );

        assert_eq!(updated, state);
        assert!(level.scheduled_water_tick());
        assert!(
            level
                .scheduled_block_ticks
                .borrow()
                .iter()
                .any(|tick| tick.block == &vanilla_blocks::BUBBLE_COLUMN && tick.delay == 5)
        );
    }

    #[test]
    fn bubble_column_update_column_uses_push_up_and_drag_down_blocks() {
        init_vanilla_registry();
        init_behaviors();
        let level = TestLevel::default()
            .with_block(BlockPos::ZERO, vanilla_blocks::WATER.default_state())
            .with_block(
                BlockPos::ZERO.above(),
                vanilla_blocks::WATER.default_state(),
            );

        BubbleColumnBlock::update_column(
            &vanilla_blocks::BUBBLE_COLUMN,
            &level,
            BlockPos::ZERO,
            vanilla_blocks::SOUL_SAND.default_state(),
        );

        let placed = level.placed_blocks.borrow();
        assert_eq!(placed.len(), 2);
        assert!(placed.iter().all(|placed| {
            placed.state.get_block() == &vanilla_blocks::BUBBLE_COLUMN
                && !placed.state.get_value(&BlockStateProperties::DRAG)
        }));
    }

    #[test]
    fn precise_entity_with_open_block_above_uses_above_bubble_column_hook() {
        init_vanilla_registry();
        init_behaviors();
        let level = TestLevel::default();
        let entity = RecordingEntity::new();
        let pos = BlockPos::ZERO;

        BubbleColumnBlock::apply_entity_effect(
            bubble_column_state(false),
            &level,
            pos,
            &entity,
            true,
        );

        assert_eq!(
            entity.calls(),
            vec![BubbleColumnCall::Above {
                drag_down: false,
                pos
            }]
        );
    }

    #[test]
    fn precise_entity_with_fluid_above_stays_inside_bubble_column() {
        init_vanilla_registry();
        init_behaviors();
        let level = TestLevel::default().with_block(
            BlockPos::ZERO.above(),
            vanilla_blocks::WATER.default_state(),
        );
        let entity = RecordingEntity::new();

        BubbleColumnBlock::apply_entity_effect(
            bubble_column_state(true),
            &level,
            BlockPos::ZERO,
            &entity,
            true,
        );

        assert_eq!(
            entity.calls(),
            vec![BubbleColumnCall::Inside { drag_down: true }]
        );
    }

    #[test]
    fn imprecise_entity_does_not_apply_bubble_column_effect() {
        init_vanilla_registry();
        init_behaviors();
        let level = TestLevel::default();
        let entity = RecordingEntity::new();

        BubbleColumnBlock::apply_entity_effect(
            bubble_column_state(false),
            &level,
            BlockPos::ZERO,
            &entity,
            false,
        );

        assert_eq!(entity.calls(), Vec::new());
    }
}