Skip to main content

Type Alias: EntityUpdate

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

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

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:43

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;

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

What the event does to that entity: component patches, or a whole-entity EntityDirective.