Skip to main content

Type Alias: EntityResponse

type EntityResponse = {
  components: EntityCore;
  ancestors?: EntityResponse[];
  is_visible: boolean;
  children_rtid: RTID[];
};

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

The response to a find entity query.

Properties​

components​

components: EntityCore;

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

The components of the entity.

ancestors?​

optional ancestors: EntityResponse[];

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

The ancestors of the entity.

If undefined, the ancestors were not requested, and it should not be assumed that the entity has no ancestors.

It defined and empty, the entity has no ancestors.

Otherwise, it contains the ancestors of the entity starting with the topmost ancestor (the one that has no parent) going all the way down to the direct parent of the entity.

is_visible​

is_visible: boolean;

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

` The visibility state of the entity.

children_rtid​

children_rtid: RTID[];

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

RTIDs of the entity's children.