TopologyEntityBinding

import { TopologyEntityBinding } from "destack:topology/binding";

Topology entity binding family.

language/library/src/topology/binding/entity.ds:7:47

1export interface TopologyEntityBinding {2    defineKind(world: WorldHandle, kind: EntityKindRecord): Result<void, HostError>;3    undefineKind(world: WorldHandle, kind: EntityKind): Result<void, HostError>;4    upsert(world: WorldHandle, entity: EntityRecord): Result<EntityId, HostError>;5    remove(world: WorldHandle, entity: EntityId): Result<boolean, HostError>;6    list(world: WorldHandle, selector?: EntitySelector | undefined): Result<[EntityRecord], HostError>;7}

Members

defineKind(world: WorldHandle, kind: EntityKindRecord): Result<void, HostError>: Define one runtime topology entity kind.
undefineKind(world: WorldHandle, kind: EntityKind): Result<void, HostError>: Undefine one runtime topology entity kind.
upsert(world: WorldHandle, entity: EntityRecord): Result<EntityId, HostError>: Upsert one runtime topology entity.
remove(world: WorldHandle, entity: EntityId): Result<boolean, HostError>: Remove one runtime topology entity.
list(world: WorldHandle, selector?: EntitySelector | undefined): Result<[EntityRecord], HostError>: Return runtime topology entities.