Type Alias: FindEntityQuery

type FindEntityQuery =
    | {
          rtid: RTID;
      }
    | {
          euid: UUID;
          linkage: UUID[];
      }
    | {
          euid: UUID;
      }
    | {
          names: string[];
      }
    | {
          mandatory_components: keyof ComponentsRecord[];
          forbidden_components?: keyof ComponentsRecord[];
      };

Defined in: node_modules/@3dverse/livelink.core/dist/sources/EntityUtils.d.ts:63

Find entity query to find entities based on different criteria.

Type declaration

{
    rtid: RTID;
}

Name	Type	Description
rtid	RTID	The RTID of the entity to find.

{
  euid: UUID;
  linkage: UUID[];
}

Name	Type	Description
euid	UUID	The EUID of the entity to find.
linkage	UUID[]	The exact linkage of the entity to find starting from the topmost linker.

{
    euid: UUID;
}

Name	Type	Description
euid	UUID	The EUID of the entity to find. No linkage is provided in this case. All entities with the same EUID are returned.

{
  names: string[];
}

Name	Type	Description
names	string[]	The names of the entities to find.

{
  mandatory_components: keyof ComponentsRecord[];
  forbidden_components?: keyof ComponentsRecord[];
}

Name	Type	Description
mandatory_components	keyof ComponentsRecord[]	The components that the entities must have.
forbidden_components?	keyof ComponentsRecord[]	The components that the entities must not have.