FinishedDelta | @cadre/ts-utils

Data bout a player finishing an order.

Index

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

Data about what order they finished.

Optional invalid?: undefined | string

A message to the human player as to why what they finished (probably the returned value) is invalid.
order: OrderEvent["data"]

The data about the order they finished.
player: GameObjectReference

The player that said they finished an order.
Optional returned?: unknown

An optional return value they returned.

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: "finished"

The type of delta, or reason it occurred.