areGameboardActorsHostile
areGameboardActorsHostile(
left,right):boolean
Defined in: src/actors/actors.ts:1047
Return whether two actors should be considered hostile to each other.
Parameters
Section titled “Parameters”GameboardActorSnapshot | { actorId: string; blocksMovement: boolean; faction: string | undefined; hostile: boolean; interactive: boolean; kind: GameboardActorKind; metadata: Record<string, GameboardActorMetadataValue>; tags: string[]; team: string | undefined; } | undefined
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”string = ''
Stable gameplay actor id.
blocksMovement
Section titled “blocksMovement”boolean = false
Whether this actor blocks movement.
faction
Section titled “faction”string | undefined = ...
Optional faction identifier.
hostile
Section titled “hostile”boolean = false
Whether this actor is generally hostile.
interactive
Section titled “interactive”boolean = false
Whether this actor should be treated as an interaction target.
GameboardActorKind = ...
Actor role used by collision, targeting, commands, and fixtures.
metadata
Section titled “metadata”Record<string, GameboardActorMetadataValue> = ...
Serializable actor metadata.
string[] = ...
Free-form actor tags.
string | undefined = ...
Optional team identifier.
undefined
GameboardActorSnapshot | { actorId: string; blocksMovement: boolean; faction: string | undefined; hostile: boolean; interactive: boolean; kind: GameboardActorKind; metadata: Record<string, GameboardActorMetadataValue>; tags: string[]; team: string | undefined; } | undefined
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”string = ''
Stable gameplay actor id.
blocksMovement
Section titled “blocksMovement”boolean = false
Whether this actor blocks movement.
faction
Section titled “faction”string | undefined = ...
Optional faction identifier.
hostile
Section titled “hostile”boolean = false
Whether this actor is generally hostile.
interactive
Section titled “interactive”boolean = false
Whether this actor should be treated as an interaction target.
GameboardActorKind = ...
Actor role used by collision, targeting, commands, and fixtures.
metadata
Section titled “metadata”Record<string, GameboardActorMetadataValue> = ...
Serializable actor metadata.
string[] = ...
Free-form actor tags.
string | undefined = ...
Optional team identifier.
undefined
Returns
Section titled “Returns”boolean