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

Function: pieceFacts()

pieceFacts(mesh): PieceFacts | undefined

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

What the level audit (@foi/world's auditLevel) knows of a piece of the shared kits by its mesh (street/bench): its tags, what it rests on, where its anchors stand, whether people walk into it (a building with upper floors); undefined for any other mesh (a level's own ground and paint, a block), which the audit does not judge as a piece.

Parameters

mesh

string

Returns

PieceFacts | undefined