Large worlds · interface

CellStreamOptions

Explained in Coordinates and units.

interface CellStreamOptions
import type { CellStreamOptions } from '@driftengine/core';

Properties

NameTypeDescription
storereadonlyCellStore
sizereadonlynumberCell edge length, world units.
radiusreadonlynumberHow far around a view cells are wanted.
hysteresisreadonlynumberHow many pumps a cell may go unwanted before it is dropped.
originreadonlyoptionalArrayLike<number>The render origin the predicted views are relative to. Absent means the world origin.
projectionreadonlyoptionalArrayLike<number>The projection the predicted views are drawn through. With it, a stream also wants the cells those views look into, out to its far plane; without it, only the cells within radius.
maxCellsreadonlyoptionalnumberThe most cells one view's query may walk. See CellGrid.