Struct FluidState 

#[non_exhaustive]
pub struct FluidState {
    pub fluid: FluidKey,
    pub amount: u8,
    pub falling: bool,
    pub source: bool,
}

A fluid state copied from the engine. For engine-built values, amount is zero exactly for the empty fluid. A mod may change a placement event’s copy; that mod-provided data is forwarded to later Parts and is never consumed by the engine.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

fluid: FluidKey

Registered fluid identity.

amount: u8

Fluid amount; zero only for empty, otherwise 1 through 8.

falling: bool

Whether the fluid is falling.

source: bool

Whether the engine identifies this as a source.

Implementations

impl FluidState

pub fn is_empty(self) -> bool

Whether this is the empty fluid.

pub fn is_source(self) -> bool

Whether the engine identifies this state as a source.

pub fn matches(self, constraints: &[StateConstraint]) -> bool

Match carried vanilla properties locally. Unknown names or noncanonical values do not match. Validate against host.fluid_states() separately for indexed errors.

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 PartialEq for FluidState

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FluidState

impl Wire for FluidState

const MIN: usize

Minimum encoded size, used to reject impossible collection lengths.

fn put(&self, out: &mut Writer)

Encodes this value, recording failures on the writer.

fn put_owned(self, out: &mut Writer)

Consumes owned data when a resource’s ownership must cross the boundary.

fn take(input: &mut Reader<'_>) -> Result<FluidState, WireError>

Decodes one value, leaving any following bytes for the caller.