Skip to main content

FindEntityQuery

@3dverse/livelink v0.8.10

@3dverse/livelink / FindEntityQuery

Type Alias: FindEntityQuery

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; }

rtid​

rtid: RTID

The RTID of the entity to find.

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

euid​

euid: UUID

The EUID of the entity to find.

linkage​

linkage: UUID[]

The exact linkage of the entity to find starting from the topmost linker.

{ euid: UUID; }

euid​

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[]; }

names​

names: string[]

The names of the entities to find.

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

mandatory_components​

mandatory_components: keyof ComponentsRecord[]

The components that the entities must have.

forbidden_components?​

optional forbidden_components: keyof ComponentsRecord[]

The components that the entities must not have.