Five On It

Appearance

five-on-it / packages/catalogue/src/kit-pieces / KitPieceInfo

Interface: KitPieceInfo ​

Defined in: packages/catalogue/src/kit-pieces.ts:33

One piece of the kit library.

Properties ​

anchors? ​

optional anchors?: Record<string, KitAnchorInfo>

Defined in: packages/catalogue/src/kit-pieces.ts:51

Its named points, by name.

bounds ​

bounds: object

Defined in: packages/catalogue/src/kit-pieces.ts:45

Its bounding box around its origin (m), the game's frame.

max ​

max: Point

min ​

min: Point

breakable? ​

optional breakable?: number

Defined in: packages/catalogue/src/kit-pieces.ts:53

Its mass (kg) when a fast car knocks it loose; absent for a piece planted for good.

collider ​

collider: ColliderShape

Defined in: packages/catalogue/src/kit-pieces.ts:41

How it collides: as its triangles, its convex hull, or not at all.

footprint ​

footprint: object

Defined in: packages/catalogue/src/kit-pieces.ts:43

Its size (m): width along x (across its front), depth along z (front to back), height along y.

depth ​

depth: number

height ​

height: number

width ​

width: number

id ​

id: string

Defined in: packages/catalogue/src/kit-pieces.ts:37

Its name in the kit (bench): a recipe names it <kit>/<id>.

kind ​

kind: PieceKind

Defined in: packages/catalogue/src/kit-pieces.ts:39

What it is for the navigation and the maps.

kit ​

kit: string

Defined in: packages/catalogue/src/kit-pieces.ts:35

The kit it is a piece of (street).

look? ​

optional look?: string

Defined in: packages/catalogue/src/kit-pieces.ts:61

The colour its variant leans to (brick, glass), which a district's theme prefers.

parts? ​

optional parts?: string[]

Defined in: packages/catalogue/src/kit-pieces.ts:59

The pieces of its kit placed with it (a walk-in building's upper floors).

render? ​

optional render?: false

Defined in: packages/catalogue/src/kit-pieces.ts:63

false for a collider nobody sees.

rests? ​

optional rests?: PieceRests

Defined in: packages/catalogue/src/kit-pieces.ts:55

What it stands on when it is not the ground: the water (a boat, at its waterline), a carriageway (a traffic cone).

roads? ​

optional roads?: PieceRoad[]

Defined in: packages/catalogue/src/kit-pieces.ts:57

The roads it carries, in its own frame (a road piece).

roof? ​

optional roof?: object

Defined in: packages/catalogue/src/kit-pieces.ts:69

A building's flat roof: its height over the origin (m) and the free places on it, the freest first, each [x, z, radius] in the piece's frame (m). Absent for a pitched roof and for what is no building.

spots ​

spots: [number, number, number][]

y ​

y: number

tags ​

tags: string[]

Defined in: packages/catalogue/src/kit-pieces.ts:49

Its sidecar's OpenStreetMap-style tags (amenity=hospital), or, where it has none, words derived from its kit, kind and id (street, prop, bench, seat).

triangles ​

triangles: number

Defined in: packages/catalogue/src/kit-pieces.ts:47

How many triangles it is drawn with.