DriftCapture · function

proposeEntities

Each region as a proposal.

Explained in DriftCapture.

function proposeEntities(regions: readonly Region[], options?: ProposeOptions): EntityProposal[]
import { proposeEntities } from '@driftengine/capture';

Parameters

ParameterTypeDescription
regionsreadonly Region[]
options?ProposeOptions

In depth

An unlabelled region is scenery, whatever its shape: drawn, solid, and doing nothing. A named region small enough to pick up is offered as movable, and the floor — the largest surface a character could stand on — is offered with a navigation surface. Nothing here is decided; a consumer reads components as a starting point and overrides whatever it likes.