mat/azalea
1
2
Fork 0
mirror of https://github.com/mat-1/azalea.git synced 2025-08-02 06:16:04 +00:00
Code Issues Projects Releases Packages Activity

rename the Block trait to BlockTrait to disambiguate with azalea_registry::Block

Browse source
This commit is contained in:
mat 2025-06-02 19:23:59 -03:30
parent abf995a702
commit 7517a207db
15 changed files with 40 additions and 41 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
azalea-block/README.md
View file

@ -23,20 +23,20 @@ let block_state: BlockState = azalea_block::blocks::CobblestoneWall {
let block_state: BlockState = azalea_registry::Block::Jukebox.into();
```
## Block trait
## BlockTrait
The [`Block`] trait represents a type of a block. With the the [`Block`] trait, you can get some extra things like the string block ID and some information about the block's behavior. Also, the structs that implement the trait contain the block attributes as fields so it's more convenient to get them. Note that this is often used as `Box<dyn Block>`.
If for some reason you don't want the `Block` trait, set default-features to false.
The [`BlockTrait`] trait represents a type of a block. With [`BlockTrait`], you can get some extra things like the string block ID and some information about the block's behavior. Also, the structs that implement the trait contain the block attributes as fields so it's more convenient to get them. Note that this is often used as `Box<dyn BlockTrait>`.
If for some reason you don't want `BlockTrait`, set `default-features = false`.
```
# use azalea_block::{Block, BlockState};
# use azalea_block::{BlockTrait, BlockState};
# let block_state = BlockState::from(azalea_registry::Block::Jukebox);
let block = Box::<dyn Block>::from(block_state);
let block = Box::<dyn BlockTrait>::from(block_state);
```
```
# use azalea_block::{Block, BlockState};
# use azalea_block::{BlockTrait, BlockState};
# let block_state: BlockState = azalea_registry::Block::Jukebox.into();
if let Some(jukebox) = Box::<dyn Block>::from(block_state).downcast_ref::<azalea_block::blocks::Jukebox>() {
if let Some(jukebox) = Box::<dyn BlockTrait>::from(block_state).downcast_ref::<azalea_block::blocks::Jukebox>() {
// ...
}
```

6
azalea-block/azalea-block-macros/src/lib.rs
View file

@ -660,7 +660,7 @@ pub fn make_block_states(input: TokenStream) -> TokenStream {
#block_struct_fields
}
impl Block for #block_struct_name {
impl BlockTrait for #block_struct_name {
fn behavior(&self) -> BlockBehavior {
#block_behavior
}
@ -785,7 +785,7 @@ pub fn make_block_states(input: TokenStream) -> TokenStream {
#block_structs
impl From<BlockState> for Box<dyn Block> {
impl From<BlockState> for Box<dyn BlockTrait> {
fn from(block_state: BlockState) -> Self {
let b = block_state.id();
match b {
@ -794,7 +794,7 @@ pub fn make_block_states(input: TokenStream) -> TokenStream {
}
}
}
impl From<azalea_registry::Block> for Box<dyn Block> {
impl From<azalea_registry::Block> for Box<dyn BlockTrait> {
fn from(block: azalea_registry::Block) -> Self {
match block {
#from_registry_block_to_block_match

12
azalea-block/src/block_state.rs
View file

@ -5,7 +5,7 @@ use std::{
use azalea_buf::{AzaleaRead, AzaleaReadVar, AzaleaWrite, AzaleaWriteVar, BufReadError};
use crate::Block;
use crate::BlockTrait;
/// The type that's used internally to represent a block state ID.
///
@ -121,14 +121,14 @@ impl Debug for BlockState {
f,
"BlockState(id: {}, {:?})",
self.id,
Box::<dyn Block>::from(*self)
Box::<dyn BlockTrait>::from(*self)
)
}
}
impl From<BlockState> for azalea_registry::Block {
fn from(value: BlockState) -> Self {
Box::<dyn Block>::from(value).as_registry_block()
Box::<dyn BlockTrait>::from(value).as_registry_block()
}
}
@ -149,11 +149,11 @@ mod tests {
#[test]
fn test_from_blockstate() {
let block: Box<dyn Block> = Box::<dyn Block>::from(BlockState::AIR);
let block: Box<dyn BlockTrait> = Box::<dyn BlockTrait>::from(BlockState::AIR);
assert_eq!(block.id(), "air");
let block: Box<dyn Block> =
Box::<dyn Block>::from(BlockState::from(azalea_registry::Block::FloweringAzalea));
let block: Box<dyn BlockTrait> =
Box::<dyn BlockTrait>::from(BlockState::from(azalea_registry::Block::FloweringAzalea));
assert_eq!(block.id(), "flowering_azalea");
}

2
azalea-block/src/generated.rs
View file

@ -2,7 +2,7 @@ use std::fmt::Debug;
use azalea_block_macros::make_block_states;
use crate::{Block, BlockBehavior, BlockState, BlockStates, Property};
use crate::{BlockTrait, BlockBehavior, BlockState, BlockStates, Property};
make_block_states! {
Properties => {

6
azalea-block/src/lib.rs
View file

@ -15,7 +15,7 @@ pub use block_state::BlockState;
pub use generated::{blocks, properties};
pub use range::BlockStates;
pub trait Block: Debug + Any {
pub trait BlockTrait: Debug + Any {
fn behavior(&self) -> BlockBehavior;
/// Get the Minecraft ID for this block. For example `stone` or
/// `grass_block`.
@ -27,8 +27,8 @@ pub trait Block: Debug + Any {
/// `azalea_registry::Block` doesn't contain any state data.
fn as_registry_block(&self) -> azalea_registry::Block;
}
impl dyn Block {
pub fn downcast_ref<T: Block>(&self) -> Option<&T> {
impl dyn BlockTrait {
pub fn downcast_ref<T: BlockTrait>(&self) -> Option<&T> {
(self as &dyn Any).downcast_ref::<T>()
}
}

1
azalea-block/src/range.rs
View file

@ -1,7 +1,6 @@
use std::{
collections::{HashSet, hash_set},
ops::{Add, RangeInclusive},
sync::LazyLock,
};
use crate::{BlockState, block_state::BlockStateIntegerRepr};

8
azalea-client/src/plugins/mining.rs
View file

@ -1,4 +1,4 @@
use azalea_block::{Block, BlockState, fluid_state::FluidState};
use azalea_block::{BlockTrait, BlockState, fluid_state::FluidState};
use azalea_core::{direction::Direction, game_type::GameMode, position::BlockPos, tick::GameTick};
use azalea_entity::{FluidOnEyes, Physics, mining::get_mine_progress};
use azalea_inventory::ItemStack;
@ -300,7 +300,7 @@ fn handle_mining_queued(
});
}
let block = Box::<dyn Block>::from(target_block_state);
let block = Box::<dyn BlockTrait>::from(target_block_state);
let held_item = inventory.held_item();
@ -469,7 +469,7 @@ pub fn handle_finish_mining_block_observer(
return;
};
let registry_block = Box::<dyn Block>::from(block_state).as_registry_block();
let registry_block = Box::<dyn BlockTrait>::from(block_state).as_registry_block();
if !can_use_game_master_blocks(abilities, permission_level)
&& matches!(
registry_block,
@ -603,7 +603,7 @@ pub fn continue_mining_block(
commands.entity(entity).remove::<Mining>();
continue;
}
let block = Box::<dyn Block>::from(target_block_state);
let block = Box::<dyn BlockTrait>::from(target_block_state);
**mine_progress += get_mine_progress(
block.as_ref(),
current_mining_item.kind(),

6
azalea-entity/src/mining.rs
View file

@ -1,4 +1,4 @@
use azalea_block::{Block, BlockBehavior};
use azalea_block::{BlockTrait, BlockBehavior};
use azalea_core::tier::get_item_tier;
use azalea_registry as registry;
@ -13,7 +13,7 @@ use crate::{FluidOnEyes, Physics, effects};
/// The player inventory is needed to check your armor and offhand for modifiers
/// to your mining speed.
pub fn get_mine_progress(
block: &dyn Block,
block: &dyn BlockTrait,
held_item: registry::Item,
player_inventory: &azalea_inventory::Menu,
fluid_on_eyes: &FluidOnEyes,
@ -41,7 +41,7 @@ pub fn get_mine_progress(
/ divider as f32
}
fn has_correct_tool_for_drops(block: &dyn Block, tool: registry::Item) -> bool {
fn has_correct_tool_for_drops(block: &dyn BlockTrait, tool: registry::Item) -> bool {
if !block.behavior().requires_correct_tool_for_drops {
return true;
}

4
azalea-entity/src/plugin/mod.rs
View file

@ -135,7 +135,7 @@ pub fn update_on_climbable(
let block_pos = BlockPos::from(position);
let block_state_at_feet = instance.get_block_state(&block_pos).unwrap_or_default();
let block_at_feet = Box::<dyn azalea_block::Block>::from(block_state_at_feet);
let block_at_feet = Box::<dyn azalea_block::BlockTrait>::from(block_state_at_feet);
let registry_block_at_feet = block_at_feet.as_registry_block();
**on_climbable = azalea_registry::tags::blocks::CLIMBABLE.contains(&registry_block_at_feet)
@ -162,7 +162,7 @@ fn is_trapdoor_useable_as_ladder(
.get_block_state(&block_pos.down(1))
.unwrap_or_default();
let registry_block_below =
Box::<dyn azalea_block::Block>::from(block_below).as_registry_block();
Box::<dyn azalea_block::BlockTrait>::from(block_below).as_registry_block();
if registry_block_below != azalea_registry::Block::Ladder {
return false;
}

2
azalea-physics/src/collision/mod.rs
View file

@ -379,7 +379,7 @@ pub fn legacy_blocks_motion(block: BlockState) -> bool {
pub fn legacy_calculate_solid(block: BlockState) -> bool {
// force_solid has to be checked before anything else
let block_trait = Box::<dyn azalea_block::Block>::from(block);
let block_trait = Box::<dyn azalea_block::BlockTrait>::from(block);
if let Some(solid) = block_trait.behavior().force_solid {
return solid;
}

6
azalea-physics/src/lib.rs
View file

@ -8,7 +8,7 @@ pub mod travel;
use std::collections::HashSet;
use azalea_block::{Block, BlockState, fluid_state::FluidState, properties};
use azalea_block::{BlockTrait, BlockState, fluid_state::FluidState, properties};
use azalea_core::{
math,
position::{BlockPos, Vec3},
@ -492,7 +492,7 @@ fn block_jump_factor(world: &Instance, position: &Position) -> f32 {
.get_block_state(&get_block_pos_below_that_affects_movement(position));
let block_at_pos_jump_factor = if let Some(block) = block_at_pos {
Box::<dyn Block>::from(block).behavior().jump_factor
Box::<dyn BlockTrait>::from(block).behavior().jump_factor
} else {
1.
};
@ -501,7 +501,7 @@ fn block_jump_factor(world: &Instance, position: &Position) -> f32 {
}
if let Some(block) = block_below {
Box::<dyn Block>::from(block).behavior().jump_factor
Box::<dyn BlockTrait>::from(block).behavior().jump_factor
} else {
1.
}

4
azalea-physics/src/travel.rs
View file

@ -1,4 +1,4 @@
use azalea_block::{Block, BlockState, fluid_state::FluidState};
use azalea_block::{BlockTrait, BlockState, fluid_state::FluidState};
use azalea_core::{
aabb::AABB,
position::{BlockPos, Vec3},
@ -124,7 +124,7 @@ fn travel_in_air(
.chunks
.get_block_state(&block_pos_below)
.unwrap_or(BlockState::AIR);
let block_below: Box<dyn Block> = block_state_below.into();
let block_below: Box<dyn BlockTrait> = block_state_below.into();
let block_friction = block_below.behavior().friction;
let inertia = if physics.on_ground() {

4
azalea-registry/src/lib.rs
View file

@ -278,10 +278,10 @@ enum Attribute {
registry! {
/// An enum of every type of block in the game. To represent a block *state*,
/// use [`azalea_block::BlockState`] or the [`azalea_block::Block`] trait.
/// use [`azalea_block::BlockState`] or [`azalea_block::BlockTrait`].
///
/// [`azalea_block::BlockState`]: https://docs.rs/azalea-block/latest/azalea_block/struct.BlockState.html
/// [`azalea_block::Block`]: https://docs.rs/azalea-block/latest/azalea_block/trait.Block.html
/// [`azalea_block::BlockTrait`]: https://docs.rs/azalea-block/latest/azalea_block/trait.BlockTrait.html
enum Block {
Air => "minecraft:air",
Stone => "minecraft:stone",

2
azalea-world/src/heightmap.rs
View file

@ -44,7 +44,7 @@ fn motion_blocking(block_state: BlockState) -> bool {
impl HeightmapKind {
pub fn is_opaque(self, block_state: BlockState) -> bool {
let block = Box::<dyn azalea_block::Block>::from(block_state);
let block = Box::<dyn azalea_block::BlockTrait>::from(block_state);
let registry_block = block.as_registry_block();
match self {
HeightmapKind::WorldSurfaceWg => !block_state.is_air(),

4
azalea/src/auto_tool.rs
View file

@ -1,4 +1,4 @@
use azalea_block::{Block, BlockState, fluid_state::FluidKind};
use azalea_block::{BlockState, BlockTrait, fluid_state::FluidKind};
use azalea_client::{Client, inventory::Inventory};
use azalea_entity::{FluidOnEyes, Physics};
use azalea_inventory::{ItemStack, Menu, components};
@ -52,7 +52,7 @@ pub fn accurate_best_tool_in_hotbar_for_block(
let mut best_speed = 0.;
let mut best_slot = None;
let block = Box::<dyn Block>::from(block);
let block = Box::<dyn BlockTrait>::from(block);
let registry_block = block.as_registry_block();
if matches!(