Skip to main content

Type Alias: EntityDirective

type EntityDirective = "delete" | "hide" | "show";

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

A whole-entity action, written instead of component patches when an event does not change the entity but changes whether it is there at all — a device leaving the fleet, a machine part going out of service.

  • "delete" removes the entity from the scene (and forgets its resolution, so a later event carrying the same id resolves — or respawns — it);
  • "hide" / "show" toggle entity.is_visible, keeping the entity and its resolution.

Both "delete" and "hide" also stop a continuous update driving that id — nothing visible is moving, so nothing should be written for it. "delete" drops the entity's state with it; "hide" keeps it, so a later event resumes the motion from where it stopped rather than from the beginning.