Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RanDelta

Delta about what game logic got ran.

Hierarchy

Index

Properties

Properties

data

data: { invalid?: undefined | string; player: GameObjectReference; returned: unknown; run: RunEvent["data"] }

Data about why the run/ran occurred.

Type declaration

  • Optional invalid?: undefined | string

    A human readable string explaining why this run was invalid.

  • player: GameObjectReference

    The player that requested this game logic be ran.

  • returned: unknown

    The value returned from the run function from the game server to the game client.

  • run: RunEvent["data"]

    The data about what was requested be run.

game

game: Partial<BaseGame & UnknownObject>

The state of the game, but ONLY changed keys.

A game delta is probably the most complex part of understanding communication in the cadre framework. Refer to these docs for more help: https://github.com/siggame/Cadre/blob/master/gamelog-format.md#deltas.

type

type: "ran"

The type of delta, or reason it occurred.

Generated using TypeDoc