Type Alias: EntityProvider

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

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

A provider of an entity.

Type Declaration

{
  name: string;
  components: ComponentsManifest;
  options: {
     delete_on_client_disconnection?: boolean;
     auto_broadcast?: boolean;
  };
}

Name	Type	Description
name	string	The name of the entity.
components	ComponentsManifest	The components to attach to the entity with their initial values.
options	{ delete_on_client_disconnection?: boolean; auto_broadcast?: boolean; }	The creation options of the entity.
options.delete_on_client_disconnection?	boolean	Whether to delete the entity when the client disconnects.
options.auto_broadcast?	boolean	Deprecated Whether to broadcast the entity automatically.

{
  name: string;
}

Name	Type	Description
name	string	The name of the entity to find.

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

Entity