Skip to main content

EntityTypeRegistration

@zylem/game-lib

@zylem/game-lib / catalog / EntityTypeRegistration

Interface: EntityTypeRegistration

Defined in: packages/game-lib/src/lib/entities/entity-registry.ts:30

A registered entity type: what the palette shows, plus how to build it.

Extends​

Properties​

create​

create: EntityTypeFactory

Defined in: packages/game-lib/src/lib/entities/entity-registry.ts:31

defaultProps?​

optional defaultProps?: Record<string, unknown>

Defined in: packages/bridge/src/protocol.ts:294

Creation options the palette entry defaults to.

Inherited from​

EntityTypeDescriptor.defaultProps

description?​

optional description?: string

Defined in: packages/bridge/src/protocol.ts:292

Inherited from​

EntityTypeDescriptor.description

group?​

optional group?: string

Defined in: packages/bridge/src/protocol.ts:291

Group heading in the palette.

Inherited from​

EntityTypeDescriptor.group

icon?​

optional icon?: string

Defined in: packages/bridge/src/protocol.ts:287

Inline SVG markup for the palette entry and armed Add button.

Inherited from​

EntityTypeDescriptor.icon

id​

id: string

Defined in: packages/bridge/src/protocol.ts:284

Inherited from​

EntityTypeDescriptor.id

label​

label: string

Defined in: packages/bridge/src/protocol.ts:285

Inherited from​

EntityTypeDescriptor.label

tags?​

optional tags?: string[]

Defined in: packages/bridge/src/protocol.ts:289

Searched alongside label, and used for palette grouping.

Inherited from​

EntityTypeDescriptor.tags