FluidState

A state of a fluid.

Functions

Converts this fluid state in to its corresponding block state.

abstract fun <T : Comparable<T>> getProperty(property: Property<T>): T?

Gets the value for the given property, or returns null if there is no value for the given property.

abstract fun hasProperty(property: Property<*>): Boolean

Checks if the given property has a value on this state.

If this fluid state is empty.

abstract fun isSource(): Boolean

If this fluid state is a source fluid.

Gets the value for the given property, or throws an IllegalArgumentException if there is no value for the given property.

abstract fun <T : Comparable<T>> setProperty(property: Property<T>, value: T): FluidState

Sets the value for the given property to the given value and returns the resulting state.

@get:JvmName(name = "availableProperties")

abstract val availableProperties: @Unmodifiable Set<Property<*>>

All of the properties that can be set on this state.

@get:JvmName(name = "fluid")

abstract val fluid: Fluid

The fluid this is a state of.

@get:JvmName(name = "level")

abstract val level: Int

The level of this fluid state.

@get:JvmName(name = "properties")

abstract val properties: @Unmodifiable Map<Property<*>, Comparable<*>>

All of the properties that are currently set on this state.