Skip to main content

FluidState

Struct FluidState 

Source
pub struct FluidState {
    pub fluid_id: FluidRef,
    pub amount: u8,
    pub falling: bool,
}
Expand description

A fluid state instance with amount and falling properties.

This is computed on-demand from block states rather than stored.

Fields§

§fluid_id: FluidRef

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§

Source§

impl FluidState

Source

pub const EMPTY: Self

The empty fluid state.

Source

pub const fn new(fluid: FluidRef, amount: u8, falling: bool) -> Self

Creates a new fluid state.

Source

pub const fn source(fluid: FluidRef) -> Self

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

Source

pub const fn flowing(fluid: FluidRef, amount: u8, falling: bool) -> Self

Creates a flowing fluid state.

Source

pub const fn is_empty(&self) -> bool

Returns true if this is the empty fluid.

Source

pub const fn is_source(&self) -> bool

Returns true if this is a source block (full fluid, not falling).

Checks both the registry fluid_id.is_source flag (primary discriminator, equivalent to vanilla checking if the type is a SourceFluid) and the data invariant amount == 8 && !falling, guarding against malformed chunk data.

Source

pub fn own_height(&self) -> f32

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

Source

pub const fn from_block_level(fluid: FluidRef, level: u8) -> Self

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)
Source

pub const fn to_block_level(self) -> u8

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

Trait Implementations§

Source§

impl Clone for FluidState

Source§

fn clone(&self) -> FluidState

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for FluidState

Source§

impl Debug for FluidState

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for FluidState

Source§

impl FluidStateExt for FluidState

Source§

fn is_water(&self) -> bool

Returns true if this fluid state contains water.
Source§

fn is_lava(&self) -> bool

Returns true if this fluid state contains lava.
Source§

impl PartialEq for FluidState

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for FluidState

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more