Home
API: forms

Interface: PairParams

lifecycle-kit

lifecycle-kit


lifecycle-kit / forms / PairParams

Interface: PairParams

Defined in: forms/rules/pair.ts:5

Properties

attachment

readonly attachment: Vec2

Defined in: forms/rules/pair.ts:12

Where the pair attaches, in the parent's coordinate space.

x is the station along the body and is shared by both members; y is the offset to one side, and the other member takes -y.


part

readonly part: string

Defined in: forms/rules/pair.ts:14

Anatomical part name, e.g. "leg", "antenna", "fin".


siteIndex?

readonly optional siteIndex?: number

Defined in: forms/rules/pair.ts:21

Index of this attachment site along the body — the segment a repeat placed it at. Left and right members are tagged 2*siteIndex and 2*siteIndex+1 so every appendage in a repeated body gets a distinct index without the two rules needing to coordinate beyond this offset.