Class BlockLiquidContainerComponentBeta

For blocks that can contain a liquid (e.g., a cauldron), this is a base component for liquid containers.

Hierarchy (View Summary)

Properties

block fillLevel typeId

Methods

isValid isValidLiquid

Properties

Readonly Betablock

block: Block

Remarks

Block instance that this component pertains to.

BetafillLevel

fillLevel: number

Remarks

Relative fill level of the liquid container.

This property can't be edited in read-only mode.

Readonly BetatypeId

typeId: string

Remarks

Identifier of the component.

Methods

isValid

  • isValid(): boolean
    Beta

    Returns boolean

    Whether the component is valid.

    Remarks

    Returns whether the component is valid. A component is considered valid if its owner is valid, in addition to any addition to any additional validation required by the component.

isValidLiquid

  • isValidLiquid(): boolean
    Beta

    Returns boolean

    True if this liquid container still exists, is valid and contains the expected liquid type.

    Remarks

    Returns true if this reference to a liquid container is still valid and contains the liquid of the type you have a reference for (for example, if the block is unloaded, no longer a liquid container or contains lava when you have a potion container component, isValidLiquid will not be true.)

Settings

Member Visibility

On This Page

Properties
Methods