useGameboardActor
useGameboardActor(
entity): {actorId:string;blocksMovement:boolean;faction:string|undefined;hostile:boolean;interactive:boolean;kind:GameboardActorKind;metadata:Record<string,GameboardActorMetadataValue>;tags:string[];team:string|undefined; } |undefined
Defined in: src/react/react.ts:924
Read actor metadata for one actor entity.
Parameters
Section titled “Parameters”entity
Section titled “entity”Entity | null | undefined
Returns
Section titled “Returns”Type Literal
Section titled “Type Literal”{ actorId: string; blocksMovement: boolean; faction: string | undefined; hostile: boolean; interactive: boolean; kind: GameboardActorKind; metadata: Record<string, GameboardActorMetadataValue>; tags: string[]; team: string | undefined; }
actorId
Section titled “actorId”actorId:
string=''
Stable gameplay actor id.
blocksMovement
Section titled “blocksMovement”blocksMovement:
boolean=false
Whether this actor blocks movement.
faction
Section titled “faction”faction:
string|undefined
Optional faction identifier.
hostile
Section titled “hostile”hostile:
boolean=false
Whether this actor is generally hostile.
interactive
Section titled “interactive”interactive:
boolean=false
Whether this actor should be treated as an interaction target.
kind:
GameboardActorKind
Actor role used by collision, targeting, commands, and fixtures.
metadata
Section titled “metadata”metadata:
Record<string,GameboardActorMetadataValue>
Serializable actor metadata.
tags:
string[]
Free-form actor tags.
team:
string|undefined
Optional team identifier.
undefined