Interface SampleFieldOptions

Options of InstanceStates.sampleField.

interface SampleFieldOptions {
    channels: readonly StateChannel[];
    mode: "max" | "replace";
    stride: number;
}

Index

Properties

channels mode stride

Properties

channels

channels: readonly StateChannel[]

Channels to copy. Default: all four.

mode

mode: "max" | "replace"

max keeps the larger value (scars stay), replace copies the field. Default max.

stride

stride: number

Floats per instance in positions (x at 0, z at 2). Default 3.