Skip to main content

Type Alias: EntityUpdate

type EntityUpdate = {
  id: string | number;
  update: ComponentUpdates | EntityDirective | AnyContinuousUpdate;
};

Defined in: livelink.clients/livelink.agent/sources/data/EventMapping.ts:190

One entity driven by an event: the id addressing it, and what the event does to it. This is what an EventMapping.updates function returns — one of these, or an array of them.

Properties​

id​

id: string | number;

Defined in: livelink.clients/livelink.agent/sources/data/EventMapping.ts:196

The unique id of the object this update addresses — whatever that object is in the use case (an AGV serial number, a machine part id, ...). It is resolved to an actual scene entity through the mapping's EventMapping.entities.

update​

update:
  | ComponentUpdates
  | EntityDirective
  | AnyContinuousUpdate;

Defined in: livelink.clients/livelink.agent/sources/data/EventMapping.ts:202

What the event does to that entity: component patches, a whole-entity EntityDirective, or a continuous update for something that keeps moving between events.