From 21ac444f28e2dbc08936d3d0f7bfc75a274feba5 Mon Sep 17 00:00:00 2001 From: Ludovic Marie <136255825+ludovic111@users.noreply.github.com> Date: Tue, 27 Oct 2026 16:16:27 +0100 Subject: [PATCH] refactor: block entity data moves down beside the chunk Step A of the horizon-client crate split. `Chunk.block_entities` held `containers::BlockEntity`, whose payloads were defined across containers, brewing, signs, sculk, mobs::spawner, mobs::trial_spawner, vault, beehive and command_block, so `chunk` reached most of the gameplay code. The enum and every payload type now live in `chunk/block_entity.rs` as plain data (definitions and derives). Every impl block stays in its feature module, and each module re-exports its types under the old path, so callers don't change. Also: - `mobs::Who` moves to `horizon_client_core::who` (the vibration `Info` names it); mobs re-exports it. - `skins::NameOrId` moves beside `SkullSkin`, which holds it; skins re-exports it. - `Spawner.next`, the `Next` enum and `Selector.current` become `pub(crate)`, since their struct now lives in another module. - The vault, spawner and trial_spawner harnesses record `chunk/block_entity.rs`. No behaviour change. Co-Authored-By: Claude Opus 5.5 --- crates/horizon-client-core/src/lib.rs | 1 + crates/horizon-client-core/src/who.rs | 8 + crates/horizon-client/src/beehive.rs | 15 +- crates/horizon-client/src/block_entities.rs | 2 +- crates/horizon-client/src/brewing.rs | 15 +- crates/horizon-client/src/chunk.rs | 4 +- .../horizon-client/src/chunk/block_entity.rs | 409 ++++++++++++++++++ crates/horizon-client/src/command_block.rs | 17 +- crates/horizon-client/src/containers.rs | 174 +------- crates/horizon-client/src/mobs.rs | 7 +- crates/horizon-client/src/mobs/spawner.rs | 44 +- .../horizon-client/src/mobs/trial_spawner.rs | 48 +- crates/horizon-client/src/sculk.rs | 43 +- crates/horizon-client/src/signs.rs | 17 +- crates/horizon-client/src/skins.rs | 8 +- crates/horizon-client/src/vault.rs | 34 +- tools/test_spawner_parity.py | 1 + tools/test_trial_spawner_parity.py | 1 + tools/test_vault_parity.py | 3 +- 19 files changed, 442 insertions(+), 409 deletions(-) create mode 100644 crates/horizon-client-core/src/who.rs create mode 100644 crates/horizon-client/src/chunk/block_entity.rs diff --git a/crates/horizon-client-core/src/lib.rs b/crates/horizon-client-core/src/lib.rs index d839feddf..4c4231359 100644 --- a/crates/horizon-client-core/src/lib.rs +++ b/crates/horizon-client-core/src/lib.rs @@ -24,4 +24,5 @@ pub mod snbt; pub mod sound_source; pub mod text; pub mod uuid; +pub mod who; pub type Result = std::result::Result>; diff --git a/crates/horizon-client-core/src/who.rs b/crates/horizon-client-core/src/who.rs new file mode 100644 index 000000000..63101e879 --- /dev/null +++ b/crates/horizon-client-core/src/who.rs @@ -0,0 +1,8 @@ +//! Who an action came from or is aimed at: the player or a mob by id. + +/// Who caused damage or is being targeted. +#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)] +pub enum Who { + Player, + Mob(u32), +} diff --git a/crates/horizon-client/src/beehive.rs b/crates/horizon-client/src/beehive.rs index 26aa87cfc..d0fa10c18 100644 --- a/crates/horizon-client/src/beehive.rs +++ b/crates/horizon-client/src/beehive.rs @@ -3,6 +3,7 @@ //! the rain, nor through a blocked front, unless the hive is emptied in an //! emergency), honey for every bee coming home with nectar. The host (the game //! or the mob AI probe) loads and adds the bees through [`HiveHost`]. +pub use crate::chunk::block_entity::{Beehive, Occupant}; use crate::mobs::{Mob, Species, bee}; use horizon_core::random::{LegacyRandom, RandomSource}; use horizon_world::nbt::{Compound, Tag}; @@ -38,20 +39,6 @@ const IGNORED_BEE_TAGS: [&str; 25] = [ "UUID", ]; -/// `BeehiveBlockEntity`: the bees inside and the flower one of them knew. -#[derive(Clone, Debug, Default, PartialEq)] -pub struct Beehive { - pub bees: Vec, - pub flower: Option<[i32; 3]>, -} -/// `BeehiveBlockEntity.Occupant`: a bee's tag (with its `id`), its time in -/// the hive and the time it stays at least. -#[derive(Clone, Debug, PartialEq)] -pub struct Occupant { - pub entity_data: Tag, - pub ticks_in_hive: i32, - pub min_ticks_in_hive: i32, -} /// `BeehiveBlockEntity.BeeReleaseStatus`. #[derive(Clone, Copy, Debug, PartialEq, Eq)] pub enum Release { diff --git a/crates/horizon-client/src/block_entities.rs b/crates/horizon-client/src/block_entities.rs index 03fff85ca..944579b83 100644 --- a/crates/horizon-client/src/block_entities.rs +++ b/crates/horizon-client/src/block_entities.rs @@ -23,7 +23,7 @@ //! Which states tick is a table by state id, built by the game from the block //! registry; whether a slot is made is decided when the slot is promoted at //! the start of the next tick, from the block state then. -use crate::containers::BlockEntity; +use crate::chunk::block_entity::BlockEntity; use crate::fast_hash::{FxHashMap, FxHashSet}; use std::collections::HashMap; diff --git a/crates/horizon-client/src/brewing.rs b/crates/horizon-client/src/brewing.rs index b3cda5f90..e058f0fe7 100644 --- a/crates/horizon-client/src/brewing.rs +++ b/crates/horizon-client/src/brewing.rs @@ -2,12 +2,13 @@ //! in vanilla, ported as tables), data-driven `minecraft:brewing` recipes from //! `data/minecraft/recipe/brewing`, potion colours and tooltips, and //! `BrewingStandBlockEntity.serverTick`. +pub use crate::chunk::block_entity::BrewingStand; use crate::{ containers::Providers, items::{ItemStack, Items}, }; use serde_json::Value; -use std::{collections::HashSet, fs, path::Path, sync::Arc}; +use std::{collections::HashSet, fs, path::Path}; pub use horizon_client_core::potions::{ BASE_POTION_COLOR, Category, EFFECTS, EffectDef, POTIONS, PotionDef, effect, namespaced, @@ -190,18 +191,6 @@ impl Brewing { } } -/// `BrewingStandBlockEntity` state. Slots: 0-2 bottles, 3 ingredient, 4 fuel. -#[derive(Clone, Debug, Default)] -pub struct BrewingStand { - pub items: [Option; 5], - pub brew_time: i32, - pub total_brew_time: i32, - pub fuel: i32, - pub total_fuel: i32, - pub speed: f32, - pub ingredient: Option>, - pub last_bottles: Option<[bool; 3]>, -} /// What a brewing tick asks the world to do. #[derive(Clone, Debug, Default, PartialEq)] pub struct BrewTick { diff --git a/crates/horizon-client/src/chunk.rs b/crates/horizon-client/src/chunk.rs index b0dd377c7..c405f5522 100644 --- a/crates/horizon-client/src/chunk.rs +++ b/crates/horizon-client/src/chunk.rs @@ -6,6 +6,8 @@ use horizon_world::nbt::{Compound, Tag}; use horizon_world::registry::BlockStateId; use std::sync::{Arc, OnceLock}; +pub mod block_entity; + pub const MIN_Y: i32 = -64; pub const HEIGHT: i32 = 384; pub const SECTIONS: usize = (HEIGHT / 16) as usize; @@ -149,7 +151,7 @@ pub struct Chunk { /// Newly generated (not loaded from a save): eligible for generation-time spawns. pub fresh: bool, /// Block entities read from a save, moved into the world on arrival. - pub block_entities: Vec<((i32, i32, i32), crate::containers::BlockEntity)>, + pub block_entities: Vec<((i32, i32, i32), block_entity::BlockEntity)>, /// `CustomName` of the container block entities (shown as the screen title). pub block_names: Vec<((i32, i32, i32), String)>, /// Generation postprocessing marks (ProtoChunk.postProcessing) as world diff --git a/crates/horizon-client/src/chunk/block_entity.rs b/crates/horizon-client/src/chunk/block_entity.rs new file mode 100644 index 000000000..0547228d8 --- /dev/null +++ b/crates/horizon-client/src/chunk/block_entity.rs @@ -0,0 +1,409 @@ +//! Block entity data: what a chunk stores for its block entities (`BlockEntity` +//! and its payloads). Plain data, as vanilla's block entities are world data; +//! their behaviour lives with the features that use them (`containers`, +//! `brewing`, `signs`, ...), which re-export these types under their old paths. +use horizon_client_core::{text::Text, who::Who}; +use horizon_items::{banner_layer::BannerLayer, items::ItemStack}; +use horizon_world::{ + level::sculk::SculkSpreader, + nbt::{Compound, Tag}, +}; +use std::{collections::HashMap, sync::Arc}; + +/// An entity's UUID as its four ints (`UUIDUtil.CODEC`). +pub type Uuid = [i32; 4]; + +#[derive(Clone, Copy, Debug, PartialEq, Eq)] +pub enum FurnaceKind { + Furnace, + BlastFurnace, + Smoker, +} +#[derive(Clone, Debug)] +pub struct Furnace { + pub kind: FurnaceKind, + /// input, fuel, result + pub items: [Option; 3], + pub lit_remaining: i32, + pub lit_total: i32, + pub cooking_timer: i32, + pub cooking_total: i32, + pub speed: f32, + /// `AbstractFurnaceBlockEntity.recipesUsed`: how many of each recipe this furnace has + /// made since a player last took from its output. The experience is owed per recipe + /// rather than per item, and a save keeps it as the `RecipesUsed` compound. + pub recipes_used: HashMap, +} +#[derive(Clone, Debug)] +pub enum BlockEntity { + Chest(Vec>), + Furnace(Furnace), + Brewing(Box), + /// Signs and hanging signs (`SignBlockEntity`). + Sign(SignData), + /// `JukeboxBlockEntity`: the record and its `JukeboxSongPlayer`. + Jukebox(Jukebox), + /// `BeaconBlockEntity`. + Beacon(Box), + /// `LecternBlockEntity`: the book and the open page. + Lectern(Lectern), + /// Sculk sensors, shriekers and catalysts (`crate::sculk`). + Sculk(Box), + /// `CreakingHeartBlockEntity`: its protector and the hurt emitter. + CreakingHeart(Box), + /// `BannerBlockEntity`: the pattern layers. + Banner(Banner), + /// `CrafterBlockEntity`. + Crafter(Crafter), + /// `SpawnerBlockEntity` (`crate::mobs::spawner`). + Spawner(Box), + /// `TrialSpawnerBlockEntity` (`crate::mobs::trial_spawner`). + TrialSpawner(Box), + /// `VaultBlockEntity` (`crate::vault`). + Vault(Box), + /// `BeehiveBlockEntity` of beehives and bee nests (`crate::beehive`). + Beehive(Box), + /// `CommandBlockEntity` of the three command blocks (`crate::command_block`). + CommandBlock(Box), + /// `CampfireBlockEntity` of campfires and soul campfires. + Campfire(Box), + /// `SkullBlockEntity` of every skull and head block. + Skull(Skull), + /// `TheEndGatewayBlockEntity`: its age and configured destination. + EndGateway(EndGateway), + /// `DaylightDetectorBlockEntity`: no data, only the ticker + /// (`DaylightDetectorBlock.tickEntity`). + DaylightDetector, + /// `ChiseledBookShelfBlockEntity`: a `Container` of six one-book slots. + ChiseledBookshelf(Box), +} +/// `ChiseledBookShelfBlockEntity`: six slots and `lastInteractedSlot`. +#[derive(Clone, Debug, PartialEq)] +pub struct ChiseledBookshelf { + pub items: [Option; 6], + pub last_slot: i32, +} +impl Default for ChiseledBookshelf { + fn default() -> Self { + Self { + items: Default::default(), + last_slot: -1, + } + } +} +/// `TheEndGatewayBlockEntity`. +#[derive(Clone, Debug, Default, PartialEq, Eq)] +pub struct EndGateway { + pub age: i64, + pub exit_portal: Option<[i32; 3]>, + pub exact_teleport: bool, +} +/// `CampfireBlockEntity`: four cooking slots, each with its +/// `cookingProgress` and `cookingTime` (the recipe's). +#[derive(Clone, Debug, Default, PartialEq)] +pub struct Campfire { + pub items: [Option; 4], + pub progress: [i32; 4], + pub total: [i32; 4], +} +/// `SkullBlockEntity`: the player profile the head shows (kept as loaded: +/// a compound, or a string when it names a player only), the note block +/// sound and `custom_name`. +#[derive(Clone, Debug, Default)] +pub struct Skull { + pub profile: Option, + pub note_block_sound: Option, + pub custom_name: Option, + /// What `profile` draws, read from it once rather than every frame. + pub skin: Option, +} +/// `SkullBlockRenderer.getPlayerSkin` of a head's profile: its skin's URL +/// with the `skins/` sprite it downloads to, and the +/// `DefaultPlayerSkin` drawn until that sprite is there (steve for a +/// profile with no id). +#[derive(Clone, Debug)] +pub struct SkullSkin { + pub download: Option<(String, String)>, + /// `ResolvableProfile.nameOrId` when the profile is `Dynamic` (a name or + /// an id only): the key `skins::Resolver` resolves it by. + pub dynamic: Option, + pub fallback: &'static str, +} +/// `Either`: the key a `Dynamic` `ResolvableProfile` resolves +/// by (`ResolvableProfile.nameOrId`). +#[derive(Clone, Debug, PartialEq, Eq, Hash)] +pub enum NameOrId { + Name(String), + Id(u128), +} +/// `CrafterBlockEntity`: nine slots that can be disabled, the powered flag +/// and the ticks left in the crafting animation. +#[derive(Clone, Debug, Default)] +pub struct Crafter { + pub items: [Option; 9], + pub disabled: [bool; 9], + pub triggered: bool, + pub crafting_ticks: i32, + /// The block state's `triggered` when last ticked (not saved): the block + /// entity flag follows it only when it changes (`CrafterBlock.neighborChanged`). + pub state_triggered: Option, +} +#[derive(Clone, Debug, Default)] +pub struct Banner { + pub layers: Vec, + pub name: Option, + /// Components not consumed by BannerBlockEntity's implicit fields. + pub components: horizon_world::nbt::Compound, +} +/// `CreakingHeartBlockEntity` (the logic is in `game/creaking.rs`). +#[derive(Clone, Debug, Default)] +pub struct CreakingHeart { + /// The protector: its entity id once resolved, and its UUID (the saved form). + pub creaking: Option<(Option, [i32; 4])>, + pub ticks_existed: i64, + pub ticker: i32, + /// Ticks left of the hurt effect (`emitter`) and where it heads. + pub emitter: i32, + pub emitter_target: Option<[f64; 3]>, + pub output_signal: i32, +} +#[derive(Clone, Debug, Default)] +pub struct Lectern { + pub book: Option, + pub page: i32, +} +#[derive(Clone, Debug, Default)] +pub struct Beacon { + pub levels: i32, + /// Effect ids (`minecraft:speed`). + pub primary: Option, + pub secondary: Option, + /// Beam sections (RGB colour, height) and the ones being rebuilt. + pub sections: Vec<(u32, i32)>, + pub checking: Vec<(u32, i32)>, + pub last_check_y: i32, +} +#[derive(Clone, Debug, Default)] +pub struct Jukebox { + pub record: Option, + /// `ticks_since_song_started`, while a song plays. + pub ticks: i64, + pub playing: bool, +} +/// `BrewingStandBlockEntity` state. Slots: 0-2 bottles, 3 ingredient, 4 fuel. +#[derive(Clone, Debug, Default)] +pub struct BrewingStand { + pub items: [Option; 5], + pub brew_time: i32, + pub total_brew_time: i32, + pub fuel: i32, + pub total_fuel: i32, + pub speed: f32, + pub ingredient: Option>, + pub last_bottles: Option<[bool; 3]>, +} +/// One sign side (`SignText`). +#[derive(Clone, Debug, PartialEq, Eq)] +pub struct SignText { + pub lines: [String; 4], + /// `DyeColor` id. + pub color: u8, + pub glowing: bool, +} +/// `SignBlockEntity` / `HangingSignBlockEntity` data. +#[derive(Clone, Debug, Default, PartialEq, Eq)] +pub struct SignData { + pub hanging: bool, + pub front: SignText, + pub back: SignText, + pub waxed: bool, +} +/// `VibrationInfo`. +#[derive(Clone, Copy, Debug, PartialEq)] +pub struct Info { + pub event: &'static str, + pub distance: f32, + pub pos: [f64; 3], + pub source: Option, + pub owner: Option, +} +/// `VibrationSelector`: the closest, then highest-frequency candidate of a tick. +#[derive(Clone, Debug, Default, PartialEq)] +pub struct Selector { + pub(crate) current: Option<(Info, i64)>, +} +/// `VibrationSystem.Data`. +#[derive(Clone, Debug, Default, PartialEq)] +pub struct Data { + pub current: Option, + pub travel: i32, + pub selector: Selector, +} +/// Which sculk block entity this is. +#[derive(Clone, Copy, Debug, PartialEq, Eq)] +pub enum SculkKind { + Sensor, + Calibrated, + Shrieker, + Catalyst, +} +/// `SculkSensorBlockEntity`, `CalibratedSculkSensorBlockEntity`, +/// `SculkShriekerBlockEntity` and `SculkCatalystBlockEntity`. +#[derive(Clone, Debug)] +pub struct SculkEntity { + pub kind: SculkKind, + pub vibration: Data, + /// `last_vibration_frequency` (sensors). + pub last_frequency: i32, + /// `warning_level` (shriekers). + pub warning_level: i32, + /// The catalyst's charge cursors. + pub spreader: SculkSpreader, +} +/// `SpawnData.CustomSpawnRules`: the block and sky light the spawn block +/// must have (inclusive ranges within 0..=15). +#[derive(Clone, Copy, Debug, PartialEq, Eq)] +pub struct CustomSpawnRules { + pub block: (i32, i32), + pub sky: (i32, i32), +} +/// `SpawnData`: the entity to spawn, optional light rules and an equipment +/// table (kept as loaded). +#[derive(Clone, Debug, Default, PartialEq)] +pub struct SpawnData { + pub entity: Compound, + pub custom_spawn_rules: Option, + pub equipment: Option, +} +/// Which `SpawnData` is next: one of the potentials (the same object in +/// vanilla, so changing it changes the potential) or its own. +#[derive(Clone, Debug, PartialEq)] +pub(crate) enum Next { + Potential(usize), + Own(SpawnData), +} +/// `BaseSpawner`. +#[derive(Clone, Debug, PartialEq)] +pub struct Spawner { + pub spawn_delay: i32, + /// `SpawnPotentials`: data and weight. + pub potentials: Vec<(SpawnData, i32)>, + pub(crate) next: Option, + pub min_spawn_delay: i32, + pub max_spawn_delay: i32, + pub spawn_count: i32, + pub max_nearby_entities: i32, + pub required_player_range: i32, + pub spawn_range: i32, + /// The client copy's delay (`spawnDelay` on the client level), which + /// speeds the spin up as the next spawn nears. + pub client_delay: i32, + pub spin: f64, + pub o_spin: f64, +} +/// `TrialSpawnerConfig`. +#[derive(Clone, Debug, PartialEq)] +pub struct TrialConfig { + pub spawn_range: i32, + pub total_mobs: f32, + pub simultaneous_mobs: f32, + pub total_mobs_added_per_player: f32, + pub simultaneous_mobs_added_per_player: f32, + pub ticks_between_spawn: i32, + pub spawn_potentials: Vec<(SpawnData, i32)>, + pub loot_tables_to_eject: Vec<(String, i32)>, + pub items_to_drop_when_ominous: String, +} +/// A `Holder` as saved: a registry id +/// (`minecraft:trial_chamber/breeze/normal`) or an inline config. +#[derive(Clone, Debug, Default, PartialEq)] +pub struct ConfigSlot { + /// The value as loaded, written back as is; None for the default. + pub saved: Option, + pub config: TrialConfig, +} +/// `TrialSpawner` with its `TrialSpawnerStateData`. +#[derive(Clone, Debug, PartialEq)] +pub struct TrialSpawner { + pub normal: ConfigSlot, + pub ominous: ConfigSlot, + pub target_cooldown_length: i32, + pub required_player_range: i32, + pub detected_players: Vec, + pub current_mobs: Vec, + pub cooldown_ends_at: i64, + pub next_mob_spawns_at: i64, + pub total_mobs_spawned: i32, + pub next_spawn_data: Option, + pub ejecting_loot_table: Option, + /// `isOminous`, set from the block on every server tick. + pub is_ominous: bool, + /// The server's display entity exists (`getOrCreateDisplayEntity`): it is + /// made once per loaded block entity and kept. + pub has_display: bool, + pub spin: f64, + pub o_spin: f64, + /// `getDispensingItems`, kept once rolled (not saved): the ominous items + /// and their weights (the rolled counts). + pub dispensing: Option>, +} +/// `VaultConfig`. +#[derive(Clone, Debug, PartialEq)] +pub struct VaultConfig { + pub loot_table: String, + pub activation_range: f64, + pub deactivation_range: f64, + /// None when the config has no key (`ItemStack.EMPTY`): the vault never opens. + pub key_item: Option, + pub override_loot_table_to_display: Option, +} +/// `VaultBlockEntity`: its config, server data and shared data. +#[derive(Clone, Debug, PartialEq)] +pub struct Vault { + pub config: VaultConfig, + /// `VaultServerData`, oldest rewarded player first. + pub rewarded_players: Vec, + pub state_updating_resumes_at: i64, + /// Popped from the end. + pub items_to_eject: Vec, + pub total_ejections_needed: i32, + pub last_insert_fail_timestamp: i64, + /// `VaultSharedData`. + pub display_item: Option, + pub connected_players: Vec, + pub connected_particles_range: f64, + /// The shared data changed since the last tick sent it. + pub shared_dirty: bool, + /// `VaultClientData`: the display item's spin and the previous tick's, in degrees. + pub spin: f32, + pub o_spin: f32, +} +/// `BeehiveBlockEntity`: the bees inside and the flower one of them knew. +#[derive(Clone, Debug, Default, PartialEq)] +pub struct Beehive { + pub bees: Vec, + pub flower: Option<[i32; 3]>, +} +/// `BeehiveBlockEntity.Occupant`: a bee's tag (with its `id`), its time in +/// the hive and the time it stays at least. +#[derive(Clone, Debug, PartialEq)] +pub struct Occupant { + pub entity_data: Tag, + pub ticks_in_hive: i32, + pub min_ticks_in_hive: i32, +} +#[derive(Clone, Debug, PartialEq)] +pub struct CommandBlock { + pub command: String, + pub success_count: i32, + /// `CustomName` as saved (a text component). + pub custom_name: Option, + pub track_output: bool, + pub last_output: Option, + pub update_last_execution: bool, + /// The game time of the last run, -1 for none. + pub last_execution: i64, + pub powered: bool, + pub auto: bool, + pub condition_met: bool, +} diff --git a/crates/horizon-client/src/command_block.rs b/crates/horizon-client/src/command_block.rs index 47f808932..1d3fe16ec 100644 --- a/crates/horizon-client/src/command_block.rs +++ b/crates/horizon-client/src/command_block.rs @@ -1,6 +1,7 @@ //! `CommandBlockEntity` with its `BaseCommandBlock`: the command, the success //! count comparators read, the output it keeps, and the powered, automatic //! and condition flags `CommandBlock.tick` runs on. +pub use crate::chunk::block_entity::CommandBlock; use crate::{ save::{number, text}, text::Text, @@ -76,22 +77,6 @@ pub fn automatic_block(name: &str) -> bool { name == "minecraft:chain_command_block" } -#[derive(Clone, Debug, PartialEq)] -pub struct CommandBlock { - pub command: String, - pub success_count: i32, - /// `CustomName` as saved (a text component). - pub custom_name: Option, - pub track_output: bool, - pub last_output: Option, - pub update_last_execution: bool, - /// The game time of the last run, -1 for none. - pub last_execution: i64, - pub powered: bool, - pub auto: bool, - pub condition_met: bool, -} - impl Default for CommandBlock { fn default() -> Self { Self { diff --git a/crates/horizon-client/src/containers.rs b/crates/horizon-client/src/containers.rs index af867903f..cd232ca94 100644 --- a/crates/horizon-client/src/containers.rs +++ b/crates/horizon-client/src/containers.rs @@ -1,6 +1,10 @@ //! Container block entities: chests/barrels (27 slots) and the three furnace //! kinds, ticking as `AbstractFurnaceBlockEntity.serverTick` with fuel times //! from the data-driven `context_int_provider`/`context_float_provider` files. +pub use crate::chunk::block_entity::{ + Banner, Beacon, BlockEntity, Campfire, ChiseledBookshelf, Crafter, CreakingHeart, EndGateway, + Furnace, FurnaceKind, Jukebox, Lectern, Skull, SkullSkin, +}; use crate::{ crafting::Recipes, items::{ItemStack, Items}, @@ -8,12 +12,6 @@ use crate::{ use serde_json::Value; use std::{collections::HashMap, fs, path::Path, sync::Arc}; -#[derive(Clone, Copy, Debug, PartialEq, Eq)] -pub enum FurnaceKind { - Furnace, - BlastFurnace, - Smoker, -} impl FurnaceKind { pub fn recipe_type(self) -> &'static str { match self { @@ -34,21 +32,6 @@ impl FurnaceKind { } } } -#[derive(Clone, Debug)] -pub struct Furnace { - pub kind: FurnaceKind, - /// input, fuel, result - pub items: [Option; 3], - pub lit_remaining: i32, - pub lit_total: i32, - pub cooking_timer: i32, - pub cooking_total: i32, - pub speed: f32, - /// `AbstractFurnaceBlockEntity.recipesUsed`: how many of each recipe this furnace has - /// made since a player last took from its output. The experience is owed per recipe - /// rather than per item, and a save keeps it as the `RecipesUsed` compound. - pub recipes_used: HashMap, -} /// The key `recipes_used` keeps a recipe under: its full id, as vanilla's `ResourceKey` /// writes it in `RecipesUsed`. Horizon's own recipe ids are file names without the namespace, so /// keeping both forms would write a key twice, and vanilla refuses such a furnace @@ -63,78 +46,6 @@ pub fn recipe_used_key(id: &str) -> String { /// A hopper's slots: the only plain container with five. pub const HOPPER_SLOTS: usize = 5; -#[derive(Clone, Debug)] -pub enum BlockEntity { - Chest(Vec>), - Furnace(Furnace), - Brewing(Box), - /// Signs and hanging signs (`SignBlockEntity`). - Sign(crate::signs::SignData), - /// `JukeboxBlockEntity`: the record and its `JukeboxSongPlayer`. - Jukebox(Jukebox), - /// `BeaconBlockEntity`. - Beacon(Box), - /// `LecternBlockEntity`: the book and the open page. - Lectern(Lectern), - /// Sculk sensors, shriekers and catalysts (`crate::sculk`). - Sculk(Box), - /// `CreakingHeartBlockEntity`: its protector and the hurt emitter. - CreakingHeart(Box), - /// `BannerBlockEntity`: the pattern layers. - Banner(Banner), - /// `CrafterBlockEntity`. - Crafter(Crafter), - /// `SpawnerBlockEntity` (`crate::mobs::spawner`). - Spawner(Box), - /// `TrialSpawnerBlockEntity` (`crate::mobs::trial_spawner`). - TrialSpawner(Box), - /// `VaultBlockEntity` (`crate::vault`). - Vault(Box), - /// `BeehiveBlockEntity` of beehives and bee nests (`crate::beehive`). - Beehive(Box), - /// `CommandBlockEntity` of the three command blocks (`crate::command_block`). - CommandBlock(Box), - /// `CampfireBlockEntity` of campfires and soul campfires. - Campfire(Box), - /// `SkullBlockEntity` of every skull and head block. - Skull(Skull), - /// `TheEndGatewayBlockEntity`: its age and configured destination. - EndGateway(EndGateway), - /// `DaylightDetectorBlockEntity`: no data, only the ticker - /// (`DaylightDetectorBlock.tickEntity`). - DaylightDetector, - /// `ChiseledBookShelfBlockEntity`: a `Container` of six one-book slots. - ChiseledBookshelf(Box), -} -/// `ChiseledBookShelfBlockEntity`: six slots and `lastInteractedSlot`. -#[derive(Clone, Debug, PartialEq)] -pub struct ChiseledBookshelf { - pub items: [Option; 6], - pub last_slot: i32, -} -impl Default for ChiseledBookshelf { - fn default() -> Self { - Self { - items: Default::default(), - last_slot: -1, - } - } -} -/// `TheEndGatewayBlockEntity`. -#[derive(Clone, Debug, Default, PartialEq, Eq)] -pub struct EndGateway { - pub age: i64, - pub exit_portal: Option<[i32; 3]>, - pub exact_teleport: bool, -} -/// `CampfireBlockEntity`: four cooking slots, each with its -/// `cookingProgress` and `cookingTime` (the recipe's). -#[derive(Clone, Debug, Default, PartialEq)] -pub struct Campfire { - pub items: [Option; 4], - pub progress: [i32; 4], - pub total: [i32; 4], -} impl Campfire { /// `placeFood`'s slot: the first empty one, given the item's /// `campfire_cooking` time; it takes one item of `held`. @@ -182,17 +93,6 @@ impl Campfire { changed } } -/// `SkullBlockEntity`: the player profile the head shows (kept as loaded: -/// a compound, or a string when it names a player only), the note block -/// sound and `custom_name`. -#[derive(Clone, Debug, Default)] -pub struct Skull { - pub profile: Option, - pub note_block_sound: Option, - pub custom_name: Option, - /// What `profile` draws, read from it once rather than every frame. - pub skin: Option, -} impl Skull { pub fn new( profile: Option, @@ -208,18 +108,6 @@ impl Skull { } } } -/// `SkullBlockRenderer.getPlayerSkin` of a head's profile: its skin's URL -/// with the `skins/` sprite it downloads to, and the -/// `DefaultPlayerSkin` drawn until that sprite is there (steve for a -/// profile with no id). -#[derive(Clone, Debug)] -pub struct SkullSkin { - pub download: Option<(String, String)>, - /// `ResolvableProfile.nameOrId` when the profile is `Dynamic` (a name or - /// an id only): the key `skins::Resolver` resolves it by. - pub dynamic: Option, - pub fallback: &'static str, -} impl SkullSkin { pub fn of(profile: &horizon_world::nbt::Tag) -> Self { let download = crate::skins::profile_skin_url_nbt(profile).and_then(|url| { @@ -248,18 +136,6 @@ impl SkullSkin { fn is_skull(name: &str) -> bool { name.ends_with("_skull") || (name.ends_with("_head") && name != "minecraft:piston_head") } -/// `CrafterBlockEntity`: nine slots that can be disabled, the powered flag -/// and the ticks left in the crafting animation. -#[derive(Clone, Debug, Default)] -pub struct Crafter { - pub items: [Option; 9], - pub disabled: [bool; 9], - pub triggered: bool, - pub crafting_ticks: i32, - /// The block state's `triggered` when last ticked (not saved): the block - /// entity flag follows it only when it changes (`CrafterBlock.neighborChanged`). - pub state_triggered: Option, -} impl Crafter { /// `slotCanBeDisabled`: only empty slots. pub fn slot_can_be_disabled(&self, slot: usize) -> bool { @@ -299,48 +175,6 @@ impl Crafter { }) } } -#[derive(Clone, Debug, Default)] -pub struct Banner { - pub layers: Vec, - pub name: Option, - /// Components not consumed by BannerBlockEntity's implicit fields. - pub components: horizon_world::nbt::Compound, -} -/// `CreakingHeartBlockEntity` (the logic is in `game/creaking.rs`). -#[derive(Clone, Debug, Default)] -pub struct CreakingHeart { - /// The protector: its entity id once resolved, and its UUID (the saved form). - pub creaking: Option<(Option, [i32; 4])>, - pub ticks_existed: i64, - pub ticker: i32, - /// Ticks left of the hurt effect (`emitter`) and where it heads. - pub emitter: i32, - pub emitter_target: Option<[f64; 3]>, - pub output_signal: i32, -} -#[derive(Clone, Debug, Default)] -pub struct Lectern { - pub book: Option, - pub page: i32, -} -#[derive(Clone, Debug, Default)] -pub struct Beacon { - pub levels: i32, - /// Effect ids (`minecraft:speed`). - pub primary: Option, - pub secondary: Option, - /// Beam sections (RGB colour, height) and the ones being rebuilt. - pub sections: Vec<(u32, i32)>, - pub checking: Vec<(u32, i32)>, - pub last_check_y: i32, -} -#[derive(Clone, Debug, Default)] -pub struct Jukebox { - pub record: Option, - /// `ticks_since_song_started`, while a song plays. - pub ticks: i64, - pub playing: bool, -} impl BlockEntity { pub fn for_block(name: &str) -> Option { if let Some(hanging) = crate::signs::sign_kind(name) { diff --git a/crates/horizon-client/src/mobs.rs b/crates/horizon-client/src/mobs.rs index cd8962754..f52bd8e39 100644 --- a/crates/horizon-client/src/mobs.rs +++ b/crates/horizon-client/src/mobs.rs @@ -503,12 +503,7 @@ impl MobTypes { Ok(Self { types: out }) } } -/// Who caused damage or is being targeted. -#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)] -pub enum Who { - Player, - Mob(u32), -} +pub use horizon_client_core::who::Who; #[derive(Clone, Copy, Debug, PartialEq, Eq)] pub enum DamageKind { PlayerAttack, diff --git a/crates/horizon-client/src/mobs/spawner.rs b/crates/horizon-client/src/mobs/spawner.rs index 78b091b7b..4479ada31 100644 --- a/crates/horizon-client/src/mobs/spawner.rs +++ b/crates/horizon-client/src/mobs/spawner.rs @@ -12,24 +12,11 @@ use super::{ spawn_rules::{self, Reason}, spawn_selection::{self, Category, NaturalLevel}, }; +use crate::chunk::block_entity::Next; +pub use crate::chunk::block_entity::{CustomSpawnRules, SpawnData, Spawner}; use horizon_core::{geometry::Aabb, geometry::Vec3, random::RandomSource}; use horizon_world::nbt::{Compound, JavaString, Tag}; -/// `SpawnData.CustomSpawnRules`: the block and sky light the spawn block -/// must have (inclusive ranges within 0..=15). -#[derive(Clone, Copy, Debug, PartialEq, Eq)] -pub struct CustomSpawnRules { - pub block: (i32, i32), - pub sky: (i32, i32), -} -/// `SpawnData`: the entity to spawn, optional light rules and an equipment -/// table (kept as loaded). -#[derive(Clone, Debug, Default, PartialEq)] -pub struct SpawnData { - pub entity: Compound, - pub custom_spawn_rules: Option, - pub equipment: Option, -} impl SpawnData { /// The `SpawnData` constructor: an `id` that is a valid identifier is /// stored normalised (`zombie` becomes `minecraft:zombie`), any other is @@ -200,33 +187,6 @@ fn encode_range((lo, hi): (i32, i32)) -> Tag { } } -/// Which `SpawnData` is next: one of the potentials (the same object in -/// vanilla, so changing it changes the potential) or its own. -#[derive(Clone, Debug, PartialEq)] -enum Next { - Potential(usize), - Own(SpawnData), -} - -/// `BaseSpawner`. -#[derive(Clone, Debug, PartialEq)] -pub struct Spawner { - pub spawn_delay: i32, - /// `SpawnPotentials`: data and weight. - pub potentials: Vec<(SpawnData, i32)>, - next: Option, - pub min_spawn_delay: i32, - pub max_spawn_delay: i32, - pub spawn_count: i32, - pub max_nearby_entities: i32, - pub required_player_range: i32, - pub spawn_range: i32, - /// The client copy's delay (`spawnDelay` on the client level), which - /// speeds the spin up as the next spawn nears. - pub client_delay: i32, - pub spin: f64, - pub o_spin: f64, -} impl Default for Spawner { fn default() -> Self { Self { diff --git a/crates/horizon-client/src/mobs/trial_spawner.rs b/crates/horizon-client/src/mobs/trial_spawner.rs index 2314d9f45..e789f14fb 100644 --- a/crates/horizon-client/src/mobs/trial_spawner.rs +++ b/crates/horizon-client/src/mobs/trial_spawner.rs @@ -13,6 +13,7 @@ use super::{ spawn_selection, spawner::{self, SpawnData, SpawnerLevel, SpawnerSpawn}, }; +pub use crate::chunk::block_entity::{ConfigSlot, TrialConfig, TrialSpawner}; use horizon_core::{position::BlockPos, random::RandomSource}; use horizon_world::nbt::{Compound, JavaString, Tag}; use std::{collections::HashMap, path::Path, sync::OnceLock}; @@ -32,19 +33,6 @@ const TICKS_BETWEEN_ITEM_SPAWNERS: i64 = 160; /// Bad Omen. pub const TRIAL_OMEN_TICKS_PER_LEVEL: i32 = 18000; -/// `TrialSpawnerConfig`. -#[derive(Clone, Debug, PartialEq)] -pub struct TrialConfig { - pub spawn_range: i32, - pub total_mobs: f32, - pub simultaneous_mobs: f32, - pub total_mobs_added_per_player: f32, - pub simultaneous_mobs_added_per_player: f32, - pub ticks_between_spawn: i32, - pub spawn_potentials: Vec<(SpawnData, i32)>, - pub loot_tables_to_eject: Vec<(String, i32)>, - pub items_to_drop_when_ominous: String, -} impl Default for TrialConfig { /// `TrialSpawnerConfig.Builder`'s defaults. fn default() -> Self { @@ -202,15 +190,6 @@ fn identifier(t: Option<&Tag>) -> Option { } } -/// A `Holder` as saved: a registry id -/// (`minecraft:trial_chamber/breeze/normal`) or an inline config. -#[derive(Clone, Debug, Default, PartialEq)] -pub struct ConfigSlot { - /// The value as loaded, written back as is; None for the default. - pub saved: Option, - pub config: TrialConfig, -} - /// `TrialSpawnerState`. #[derive(Clone, Copy, Debug, Default, PartialEq, Eq)] pub enum TrialState { @@ -335,31 +314,6 @@ pub trait TrialSpawnerLevel: SpawnerLevel { fn seed(&self) -> i64; } -/// `TrialSpawner` with its `TrialSpawnerStateData`. -#[derive(Clone, Debug, PartialEq)] -pub struct TrialSpawner { - pub normal: ConfigSlot, - pub ominous: ConfigSlot, - pub target_cooldown_length: i32, - pub required_player_range: i32, - pub detected_players: Vec, - pub current_mobs: Vec, - pub cooldown_ends_at: i64, - pub next_mob_spawns_at: i64, - pub total_mobs_spawned: i32, - pub next_spawn_data: Option, - pub ejecting_loot_table: Option, - /// `isOminous`, set from the block on every server tick. - pub is_ominous: bool, - /// The server's display entity exists (`getOrCreateDisplayEntity`): it is - /// made once per loaded block entity and kept. - pub has_display: bool, - pub spin: f64, - pub o_spin: f64, - /// `getDispensingItems`, kept once rolled (not saved): the ominous items - /// and their weights (the rolled counts). - pub dispensing: Option>, -} impl Default for TrialSpawner { fn default() -> Self { Self { diff --git a/crates/horizon-client/src/sculk.rs b/crates/horizon-client/src/sculk.rs index eefedaa98..97a2187cb 100644 --- a/crates/horizon-client/src/sculk.rs +++ b/crates/horizon-client/src/sculk.rs @@ -1,6 +1,7 @@ //! Game events and the vibration system (`GameEvent`, `VibrationSystem`, //! `VibrationSelector`) shared by sculk sensors, shriekers and wardens, the //! sculk block entities and the per-player warden spawn tracker. +pub use crate::chunk::block_entity::{Data, Info, SculkEntity, SculkKind, Selector}; use crate::mobs::Who; use horizon_core::{ geometry::{Direction, Vec3, traverse_blocks}, @@ -185,20 +186,6 @@ pub fn valid_vibration(listens: bool, event: &str, ctx: &Context) -> bool { !ctx.dampening_state } -/// `VibrationInfo`. -#[derive(Clone, Copy, Debug, PartialEq)] -pub struct Info { - pub event: &'static str, - pub distance: f32, - pub pos: [f64; 3], - pub source: Option, - pub owner: Option, -} -/// `VibrationSelector`: the closest, then highest-frequency candidate of a tick. -#[derive(Clone, Debug, Default, PartialEq)] -pub struct Selector { - current: Option<(Info, i64)>, -} impl Selector { pub fn add_candidate(&mut self, new: Info, tick: i64) { if self.should_replace(&new, tick) { @@ -233,13 +220,6 @@ impl Selector { self.current } } -/// `VibrationSystem.Data`. -#[derive(Clone, Debug, Default, PartialEq)] -pub struct Data { - pub current: Option, - pub travel: i32, - pub selector: Selector, -} /// What one `VibrationSystem.Ticker.tick` did. #[derive(Clone, Debug, Default, PartialEq)] pub struct Tick { @@ -382,27 +362,6 @@ pub fn is_occluded( true } -/// Which sculk block entity this is. -#[derive(Clone, Copy, Debug, PartialEq, Eq)] -pub enum SculkKind { - Sensor, - Calibrated, - Shrieker, - Catalyst, -} -/// `SculkSensorBlockEntity`, `CalibratedSculkSensorBlockEntity`, -/// `SculkShriekerBlockEntity` and `SculkCatalystBlockEntity`. -#[derive(Clone, Debug)] -pub struct SculkEntity { - pub kind: SculkKind, - pub vibration: Data, - /// `last_vibration_frequency` (sensors). - pub last_frequency: i32, - /// `warning_level` (shriekers). - pub warning_level: i32, - /// The catalyst's charge cursors. - pub spreader: SculkSpreader, -} impl SculkEntity { pub fn new(kind: SculkKind) -> Self { Self { diff --git a/crates/horizon-client/src/signs.rs b/crates/horizon-client/src/signs.rs index 799210797..50559e9ae 100644 --- a/crates/horizon-client/src/signs.rs +++ b/crates/horizon-client/src/signs.rs @@ -1,6 +1,7 @@ //! Sign block entities (`SignBlockEntity`, `SignText`): two four-line text //! sides with a dye colour and glow, saved in vanilla's `front_text` / //! `back_text` NBT layout. +pub use crate::chunk::block_entity::{SignData, SignText}; use horizon_world::nbt::Tag; /// `DyeColor` names and `getTextColor` values by id. @@ -24,14 +25,6 @@ pub const DYE_TEXT: [(&str, u32); 16] = [ ]; const BLACK: u8 = 15; -/// One sign side (`SignText`). -#[derive(Clone, Debug, PartialEq, Eq)] -pub struct SignText { - pub lines: [String; 4], - /// `DyeColor` id. - pub color: u8, - pub glowing: bool, -} impl Default for SignText { fn default() -> Self { Self { @@ -61,14 +54,6 @@ impl SignText { } } -/// `SignBlockEntity` / `HangingSignBlockEntity` data. -#[derive(Clone, Debug, Default, PartialEq, Eq)] -pub struct SignData { - pub hanging: bool, - pub front: SignText, - pub back: SignText, - pub waxed: bool, -} impl SignData { pub fn id(&self) -> &'static str { if self.hanging { diff --git a/crates/horizon-client/src/skins.rs b/crates/horizon-client/src/skins.rs index 740208973..76bb79f6c 100644 --- a/crates/horizon-client/src/skins.rs +++ b/crates/horizon-client/src/skins.rs @@ -160,13 +160,7 @@ pub(crate) fn nbt_text(tag: Option<&horizon_world::nbt::Tag>) -> Option } } -/// `Either`: the key a `Dynamic` `ResolvableProfile` resolves -/// by (`ResolvableProfile.nameOrId`). -#[derive(Clone, Debug, PartialEq, Eq, Hash)] -pub enum NameOrId { - Name(String), - Id(u128), -} +pub use crate::chunk::block_entity::NameOrId; /// `GameProfile` as `fetchProfile` returns it: the account's id, name and /// property map (its `textures` property is the skin). diff --git a/crates/horizon-client/src/vault.rs b/crates/horizon-client/src/vault.rs index 38e5d29d7..919ba8e56 100644 --- a/crates/horizon-client/src/vault.rs +++ b/crates/horizon-client/src/vault.rs @@ -7,6 +7,7 @@ //! the next one. The level's random draws the display item and throws the //! rewards; the loot tables go through the caller, so the game and a //! differential test world roll them the same way. +pub use crate::chunk::block_entity::{Vault, VaultConfig}; use crate::items::ItemStack; use horizon_core::random::RandomSource; use horizon_world::nbt::{Compound, Tag}; @@ -26,17 +27,6 @@ const UNLOCKING_DELAY: i64 = 14; const INSERT_FAIL_SOUND_BUFFER: i64 = 15; const STATE_DELAY: i64 = 20; -/// `VaultConfig`. -#[derive(Clone, Debug, PartialEq)] -pub struct VaultConfig { - pub loot_table: String, - pub activation_range: f64, - pub deactivation_range: f64, - /// None when the config has no key (`ItemStack.EMPTY`): the vault never opens. - pub key_item: Option, - pub override_loot_table_to_display: Option, -} - impl Default for VaultConfig { /// `VaultConfig.DEFAULT`: the trial key and the trial chambers' reward. fn default() -> Self { @@ -169,28 +159,6 @@ pub trait VaultLevel { /// the table has one. pub type Roll<'a, R> = dyn FnMut(&str, &mut R, bool) -> Vec + 'a; -/// `VaultBlockEntity`: its config, server data and shared data. -#[derive(Clone, Debug, PartialEq)] -pub struct Vault { - pub config: VaultConfig, - /// `VaultServerData`, oldest rewarded player first. - pub rewarded_players: Vec, - pub state_updating_resumes_at: i64, - /// Popped from the end. - pub items_to_eject: Vec, - pub total_ejections_needed: i32, - pub last_insert_fail_timestamp: i64, - /// `VaultSharedData`. - pub display_item: Option, - pub connected_players: Vec, - pub connected_particles_range: f64, - /// The shared data changed since the last tick sent it. - pub shared_dirty: bool, - /// `VaultClientData`: the display item's spin and the previous tick's, in degrees. - pub spin: f32, - pub o_spin: f32, -} - impl Default for Vault { fn default() -> Self { Self { diff --git a/tools/test_spawner_parity.py b/tools/test_spawner_parity.py index 34f6ec726..f94324cc9 100644 --- a/tools/test_spawner_parity.py +++ b/tools/test_spawner_parity.py @@ -232,6 +232,7 @@ def main(): oracle = lab.ROOT / 'mods/horizon/src/test/java/dev/horizonlab/parity/VanillaNaturalSpawnOracle.java' sources = [oracle, Path(__file__), lab.ROOT / 'crates/horizon-client/examples/probe/natural_spawn_fixture.rs', lab.ROOT / 'crates/horizon-client/src/mobs/spawner.rs', + lab.ROOT / 'crates/horizon-client/src/chunk/block_entity.rs', lab.ROOT / 'crates/horizon-client/src/mobs/spawn_selection.rs', lab.ROOT / 'crates/horizon-client/src/mobs/spawn_rules.rs'] tested = base.source_hashes(sources) diff --git a/tools/test_trial_spawner_parity.py b/tools/test_trial_spawner_parity.py index 43d26338a..6f588b785 100644 --- a/tools/test_trial_spawner_parity.py +++ b/tools/test_trial_spawner_parity.py @@ -197,6 +197,7 @@ def main(): sources = [oracle, Path(__file__), lab.ROOT / 'crates/horizon-client/examples/probe/natural_spawn_fixture.rs', lab.ROOT / 'crates/horizon-client/src/mobs/trial_spawner.rs', lab.ROOT / 'crates/horizon-client/src/mobs/spawner.rs', + lab.ROOT / 'crates/horizon-client/src/chunk/block_entity.rs', lab.ROOT / 'crates/horizon-client/src/mobs/spawn_selection.rs', lab.ROOT / 'crates/horizon-client/src/mobs/spawn_rules.rs'] tested = base.source_hashes(sources) diff --git a/tools/test_vault_parity.py b/tools/test_vault_parity.py index 00e6422f5..d3025623d 100644 --- a/tools/test_vault_parity.py +++ b/tools/test_vault_parity.py @@ -174,7 +174,8 @@ def main(): resources = lab.LOCAL / 'horizon-client/26.3' oracle = lab.ROOT / 'mods/horizon/src/test/java/dev/horizonlab/parity/VanillaNaturalSpawnOracle.java' sources = [oracle, Path(__file__), lab.ROOT / 'crates/horizon-client/examples/probe/natural_spawn_fixture.rs', - lab.ROOT / 'crates/horizon-client/src/vault.rs'] + lab.ROOT / 'crates/horizon-client/src/vault.rs', + lab.ROOT / 'crates/horizon-client/src/chunk/block_entity.rs'] tested = base.source_hashes(sources) inputs = build / 'inputs.txt' cases = corpus()