Skip to main content

Type Alias: EntityProvider

type EntityProvider =
| {
name: string;
components: ComponentsManifest;
options: {
delete_on_client_disconnection?: boolean;
auto_broadcast?: boolean;
} & {
delete_on_unmount?: boolean;
};
}
| {
name: string;
}
| Exclude<
FindEntityQuery,
{
names: string[];
}
>
| Entity;

Defined in: livelink.react/sources/hooks/useEntity.ts:70

A provider of an entity.

Type Declaration

{
name: string;
components: ComponentsManifest;
options: {
delete_on_client_disconnection?: boolean;
auto_broadcast?: boolean;
} & {
delete_on_unmount?: boolean;
};
}
NameTypeDescription
namestringThe name of the entity.
componentsComponentsManifestThe components to attach to the entity with their initial values.
options{ delete_on_client_disconnection?: boolean; auto_broadcast?: boolean; } & { delete_on_unmount?: boolean; }The creation options of the entity.
{
name: string;
}
NameTypeDescription
namestringThe name of the entity to find.

Exclude<FindEntityQuery, { names: string[]; }>

Entity