@vttforge/types / CombatantLike

Interface: CombatantLike<System>

One combatant in an encounter.

Extends

• DocumentMembers<System>

Type Parameters

System

System = Record<string, unknown>

Properties

actor

readonly actor: ActorLike<Record<string, unknown>, ItemLike<Record<string, unknown>>> | null

---

actorId

readonly actorId: string | null

---

combat

readonly combat: CombatLike<Record<string, unknown>> | null

---

defeated

readonly defeated: boolean

---

documentName

readonly documentName: string

'Actor', 'Item', 'ActiveEffect', and so on.

Inherited from

DocumentMembers.documentName

---

flags

readonly flags: DocumentFlags

Inherited from

DocumentMembers.flags

---

group

readonly group: string | null

---

hidden

readonly hidden: boolean

---

id

readonly id: string | null

Inherited from

DocumentMembers.id

---

img

readonly img: string | null

Inherited from

DocumentMembers.img

---

initiative

readonly initiative: number | null

---

isOwner

readonly isOwner: boolean

Whether the current user owns this document.

Overrides

DocumentMembers.isOwner

---

name

readonly name: string

Inherited from

DocumentMembers.name

---

parent

readonly parent: DocumentMembers<Record<string, unknown>> | null

The document this one is embedded in, or null at the top level.

Inherited from

DocumentMembers.parent

---

roundJoined

readonly roundJoined: number

The round this combatant joined. 1 for one that started the encounter.

---

sceneId

readonly sceneId: string | null

---

system

readonly system: System

The type data model instance. Its fields are the schema's fields.

Inherited from

DocumentMembers.system

---

token

readonly token: TokenDocumentLike<Record<string, unknown>> | null

---

tokenId

readonly tokenId: string | null

---

type

readonly type: string

The subtype, as declared under documentTypes in the manifest.

Inherited from

DocumentMembers.type

---

uuid

readonly uuid: string

Inherited from

DocumentMembers.uuid

---

visible

readonly visible: boolean

Methods

delete()

delete(operation?): Promise<CombatantLike<System> | undefined>

Parameters

operation?

Record<string, unknown>

Returns

Promise<CombatantLike<System> | undefined>

Inherited from

DocumentMembers.delete

---

getFlag()

getFlag<T>(scope, key): T | undefined

Type Parameters

T

T = unknown

Parameters

scope

string

key

string

Returns

T | undefined

Inherited from

DocumentMembers.getFlag

---

getInitiativeRoll()

getInitiativeRoll(formula?): RollLike

Parameters

formula?

string

Returns

RollLike

---

rollInitiative()

rollInitiative(formula?): Promise<CombatantLike<System>>

Parameters

formula?

string

Returns

Promise<CombatantLike<System>>

---

setFlag()

setFlag(scope, key, value): Promise<CombatantLike<System>>

Parameters

scope

string

key

string

value

unknown

Returns

Promise<CombatantLike<System>>

Inherited from

DocumentMembers.setFlag

---

toObject()

toObject(source?): Record<string, unknown>

A plain-object copy. source reads the stored data instead of the prepared data.

Parameters

source?

boolean

Returns

Record<string, unknown>

Inherited from

DocumentMembers.toObject

---

unsetFlag()

unsetFlag(scope, key): Promise<CombatantLike<System>>

Parameters

scope

string

key

string

Returns

Promise<CombatantLike<System>>

Inherited from

DocumentMembers.unsetFlag

---

update()

update(data, operation?): Promise<CombatantLike<System> | undefined>

Parameters

data

Record<string, unknown>

operation?

Record<string, unknown>

Returns

Promise<CombatantLike<System> | undefined>

Inherited from

DocumentMembers.update