Interface OverlayAreaOptions<LiteModeEnabled>

Options for the overlayArea function.

interface OverlayAreaOptions<LiteModeEnabled extends boolean = false> {
    blockMask?: Globals.modules.cmds.BlockMask;
    integrity?: number;
    layers?: number;
    liteMode?: LiteModeEnabled;
    minMSBetweenTickWaits?: number;
    onlySolid?: boolean;
    pillarSequencePatternMode?: boolean;
    replacemode?: boolean;
}

Type Parameters

  • LiteModeEnabled extends boolean = false

Properties

blockMask? integrity? layers? liteMode? minMSBetweenTickWaits? onlySolid? pillarSequencePatternMode? replacemode?

Properties

OptionalblockMask

blockMask?: Globals.modules.cmds.BlockMask

The block mask to use to determine which blocks to overlay.

If not specified, all blocks will be overlayed.

Default

undefined

Optionalintegrity

integrity?: number

The integrity of the fill generation.

Default

1

Optionallayers

layers?: number

The number of layers to generate.

Default

1

OptionalliteMode

liteMode?: LiteModeEnabled

Whether to skip keeping track of how many blocks were actually changed.

Default

false

OptionalminMSBetweenTickWaits

minMSBetweenTickWaits?: number

The shortest the generation can run for before pausing until the next tick.

See

config.system.defaultMinMSBetweenTickWaits

Default

config.system.defaultMinMSBetweenTickWaits

OptionalonlySolid

onlySolid?: boolean

Whether to only overlay solid blocks (passable and liquid blocks may be replaced).

Default

false

OptionalpillarSequencePatternMode

pillarSequencePatternMode?: boolean

Whether to use the same index for all sequence block patterns at each x and z location.

Default

false

Optionalreplacemode

replacemode?: boolean

Whether or not to clear container blocks before replacing them.

Default

false

Settings

Member Visibility

On This Page

Properties