five-on-it / packages/catalogue/src/entries / CatalogueEntry

Interface: CatalogueEntry

Defined in: packages/catalogue/src/entries.ts:69

One thing a game may name.

Properties

doc

doc: string

Defined in: packages/catalogue/src/entries.ts:77

What it does and how to use it.

---

example?

optional example?: unknown

Defined in: packages/catalogue/src/entries.ts:79

A piece of a level spec or a game document that uses it.

---

id

id: string

Defined in: packages/catalogue/src/entries.ts:71

<kind>.<name>: template.grid-town, building.office, vehicle.box-truck, action.showText.

---

kind

kind: "building" | "theme" | "value" | "item" | "vehicle" | "anchor" | "district" | "phone" | "action" | "place" | "verb" | "tag" | "actor" | "template" | "props" | "tile" | "family" | "kit-piece" | "rule" | "event" | "condition" | "setting"

Defined in: packages/catalogue/src/entries.ts:73

What it is.

---

params?

optional params?: Record<string, string>

Defined in: packages/catalogue/src/entries.ts:81

Its parameters: what each takes.

---

piece?

optional piece?: KitPieceInfo

Defined in: packages/catalogue/src/entries.ts:83

A kit-piece entry's record in the kit library: its footprint, tags, anchors, collider…

---

title

title: string

Defined in: packages/catalogue/src/entries.ts:75

Its name as a game writes it.