Struct FluidState 

pub(in worldgen::feature) struct FluidState {
    pub fluid_id: &'static Fluid,
    pub amount: u8,
    pub falling: bool,
}

A fluid state instance with amount and falling properties.

Registered block states cache this value in their immutable state metadata.

Fields

fluid_id: &'static Fluid

The fluid type (water, lava, empty).

amount: u8

The fluid amount (1-8, where 8 is a full block/source).

falling: bool

Whether the fluid is falling (flows downward faster).

Implementations

impl FluidState

pub const EMPTY: FluidState

The empty fluid state.

pub const fn new(fluid: &'static Fluid, amount: u8, falling: bool) -> FluidState

Creates a new fluid state.

pub const fn source(fluid: &'static Fluid) -> FluidState

Creates a source fluid state (amount=8, not falling).

pub const fn flowing( fluid: &'static Fluid, amount: u8, falling: bool, ) -> FluidState

Creates a flowing fluid state.

pub const fn is_empty(&self) -> bool

Returns true if this is the empty fluid.

pub const fn is_source(&self) -> bool

Returns true if this state is owned by a source fluid type.

Vanilla FluidState.isSource() delegates to the owning fluid. Source fluids can still carry FALLING=true through FlowingFluid.getSource.

pub const fn is_full(&self) -> bool

Returns true if this fluid has vanilla’s full amount (8).

This intentionally does not require a source fluid type. Vanilla FluidState.isFull() is getAmount() == 8, so a falling full fluid is full without being a source.

pub const fn is_randomly_ticking(&self) -> bool

Returns whether this fluid receives random ticks.

pub fn own_height(&self) -> f32

Returns the fluid’s own height (0.0 to ~0.89).

pub fn from_block_level(fluid: &'static Fluid, level: u8) -> FluidState

Decodes a fluid state from a liquid block’s LEVEL property (0-15).

• LEVEL 0 = source (amount=8, falling=false)
• LEVEL 1-7 = flowing levels 7-1 (amount = 8 - level)
• LEVEL 8-15 = falling fluid (amount=8, falling=true, but clamped)

pub const fn to_block_level(self) -> u8

Encodes this fluid state to a liquid block’s LEVEL property (0-15).

pub fn create_legacy_block(self) -> BlockStateId

Trait Implementations

impl Clone for FluidState

fn clone(&self) -> FluidState

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for FluidState

impl Debug for FluidState

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Eq for FluidState

impl FluidStateExt for FluidState

fn is_water(&self) -> bool

Returns true if this fluid state contains water.

fn is_lava(&self) -> bool

Returns true if this fluid state contains lava.

impl PartialEq for FluidState

fn eq(&self, other: &FluidState) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for FluidState