JSPrismarine

API reference / @jsprismarine/worldgen / FluidStatus

Class: FluidStatus ​

Defined in: chunk/FluidPicker.ts:16

A fluid surface: everything strictly below fluidLevel is fluidType, above it is air.

Constructors ​

Constructor ​

new FluidStatus(fluidLevel, fluidType): FluidStatus

Defined in: chunk/FluidPicker.ts:17

Parameters ​

fluidLevel ​

number

The y level the fluid fills up to, exclusive.

fluidType ​

string

The Java block state identifier of the fluid.

Returns ​

FluidStatus

Properties ​

fluidLevel ​

readonly fluidLevel: number

Defined in: chunk/FluidPicker.ts:19

The y level the fluid fills up to, exclusive.

fluidType ​

readonly fluidType: string

Defined in: chunk/FluidPicker.ts:21

The Java block state identifier of the fluid.

Methods ​

at() ​

at(blockY): string

Defined in: chunk/FluidPicker.ts:25

Returns the block that fills one y level: the fluid below the level, air at or above.

Parameters ​

blockY ​

number

Returns ​

string

equals() ​

equals(other): boolean

Defined in: chunk/FluidPicker.ts:30

Whether two statuses describe the same fluid at the same level.

Parameters ​

other ​

FluidStatus

Returns ​

boolean