Interface Game<P, R>

Core entry point for a pretty-chitty game. This needs to ultimately provide:

A way to generate players
A way to generate the root chit
An async run method to actually execute the game logic
A library of chits, buttons and canvases

See documentation on Turn for more details on how to structure your game logic.

interface Game<P extends PlayerChit, R extends RootChit<P>> {
    get theme(): GameTheme;
    get name(): string;
    get chitLibrary(): IChitLibrary<P, R>;
    get canvasLibrary(): ICanvasLibrary;
    get buttonLibrary(): IButtonLibrary;
    tokenMap?: { [key: string]: TokenDefinition };
    run(setup: Turn<GameResult<P>, P, R>, rootChit: R): Promise<GameResult<P>>;
    renderDefaultRootChit?(spec: ChitRenderSpec): void;
}

Type Parameters

P extends PlayerChit
R extends RootChit<P>

Index

Accessors

theme name chitLibrary canvasLibrary buttonLibrary

Methods

run renderDefaultRootChit?

Properties

Accessors

theme

get theme(): GameTheme
Returns GameTheme
- Defined in game/Game.ts:41

name

get name(): string
Returns string
- Defined in game/Game.ts:42

chitLibrary

get chitLibrary(): IChitLibrary<P, R>
Returns IChitLibrary<P, R>
- Defined in game/Game.ts:43

canvasLibrary

get canvasLibrary(): ICanvasLibrary
Returns ICanvasLibrary
- Defined in game/Game.ts:44

buttonLibrary

get buttonLibrary(): IButtonLibrary
Returns IButtonLibrary
- Defined in game/Game.ts:45

Methods

run

run(setup: Turn<GameResult<P>, P, R>, rootChit: R): Promise<GameResult<P>>
Parameters
- setup: Turn<GameResult<P>, P, R>
- rootChit: R
Returns Promise<GameResult<P>>
- Defined in game/Game.ts:48

`Optional`renderDefaultRootChit

renderDefaultRootChit?(spec: ChitRenderSpec): void
Useful if you want consistent lighting and ornaments for all of your panels
Parameters
- spec: ChitRenderSpec
Returns void
- Defined in game/Game.ts:54

Properties

`Optional`tokenMap

tokenMap?: { [key: string]: TokenDefinition }