Class CombatPF

Hierarchy

Combat
- CombatPF

Index

Constructors

Accessors

Methods

_detectSkippedTurns _handleSkippedTurns _isForwardTime _onDelete _onNewTurn _onUpdate _preUpdate _processCurrentCombatant rollInitiative showInitiativeDialog

Constructors

constructor

new CombatPF(data?, context?): CombatPF
Parameters
- Optional data: any
  Initial data provided to construct the Combat document
- Optional context: any
Returns CombatPF
Inherited from Combat.constructor
- Defined in node_modules/@league-of-foundry-developers/foundry-vtt-types/src/foundry/client/data/documents/combat.d.ts:20

Accessors

initiative

get initiative(): undefined | number
Get current initiative.

Returns undefined | number
- Defined in module/documents/combat.mjs:368

Methods

`Private` _detectSkippedTurns

_detectSkippedTurns(from?, context): void
Private
Determine skipped turns
Parameters
- from: {
  round: number;
  turn: number;
  } = {}
  - round: number
    From round
  - turn: number
    From turn
- context: object
  Update context
Returns void
- Defined in module/documents/combat.mjs:284

_handleSkippedTurns

_handleSkippedTurns(skipped, context): void
Internal
Handle effects of skipped turns.
Parameters
- skipped: Set<string>
  Combatant IDs of those whose turn was skipped.
- context: object
  Combat update context
Returns void
- Defined in module/documents/combat.mjs:313

_isForwardTime

_isForwardTime(changed, context): boolean
Parameters
- changed: any
- context: any
Returns boolean
- Defined in module/documents/combat.mjs:261

_onDelete

_onDelete(options, userId): void
Parameters
- options: any
- userId: any
Returns void
Overrides Combat._onDelete
- Defined in module/documents/combat.mjs:346

`Private` _onNewTurn

_onNewTurn(changed, context, userId): Promise<void>
Private
New turn handling.
Parameters
- changed: any
- context: any
- userId: any
Returns Promise<void>
- Defined in module/documents/combat.mjs:251

_onUpdate

_onUpdate(changed, context, userId): void
Parameters
- changed: any
- context: any
- userId: string
  Triggering user ID
Returns void
Overrides Combat._onUpdate
- Defined in module/documents/combat.mjs:220

_preUpdate

_preUpdate(changed, context, user): Promise<void>
Internal
Parameters
- changed: object
- context: object
- user: User
Returns Promise<void>
Overrides Combat._preUpdate
- Defined in module/documents/combat.mjs:233

_processCurrentCombatant

_processCurrentCombatant(changed, context, userId): Promise<void>
Process current combatant: expire active effects & buffs.
Parameters
- changed: object
  Update data
- context: options
  Context options
- userId: string
  Triggering user ID
Returns Promise<void>
- Defined in module/documents/combat.mjs:324

rollInitiative

rollInitiative(ids, options?): Promise<CombatPF | {
combat: CombatPF;
messages: any;
}>
Parameters
- ids: string[]
  Combatant IDs to roll initiative for.
- Optional options: {
      bonus: undefined | string;
      rollMode: undefined | string;
      skipDialog: undefined | boolean;
  } = {}
  Additional options
  - bonus: undefined | string
    Formula for bonus to initiative
  - rollMode: undefined | string
    Roll mode override
  - skipDialog: undefined | boolean
    Skip roll dialog
Returns Promise<CombatPF | {
combat: CombatPF;
messages: any;
}>
Overrides Combat.rollInitiative
- Defined in module/documents/combat.mjs:57

`Static` showInitiativeDialog

showInitiativeDialog(options?): object
Parameters
- options: {
      bonus: string;
      d20: string;
      formula: string;
      name: string;
  } = {}
  - bonus: string
    Bonus formula override
  - d20: string
    Formula override
  - formula: string
  - name: string
    Name of the roller
Returns object
- Defined in module/documents/combat.mjs:171

Class CombatPF

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Optional data: any

Optional context: any

Returns CombatPF

Accessors

initiative

Returns undefined | number

Methods

Private _detectSkippedTurns

Parameters

from: { round: number; turn: number; } = {}

round: number

turn: number

context: object

Returns void

_handleSkippedTurns

Parameters

skipped: Set<string>

context: object

Returns void

_isForwardTime

Parameters

changed: any

context: any

Returns boolean

_onDelete

Parameters

options: any

userId: any

Returns void

Private _onNewTurn

Parameters

changed: any

context: any

userId: any

Returns Promise<void>

_onUpdate

Parameters

changed: any

context: any

userId: string

Returns void

_preUpdate

Parameters

changed: object

context: object

user: User

Returns Promise<void>

_processCurrentCombatant

Parameters

changed: object

context: options

userId: string

Returns Promise<void>

rollInitiative

Parameters

ids: string[]

Optional options: { bonus: undefined | string; rollMode: undefined | string; skipDialog: undefined | boolean; } = {}

bonus: undefined | string

rollMode: undefined | string

skipDialog: undefined | boolean

Returns Promise<CombatPF | { combat: CombatPF; messages: any; }>

Static showInitiativeDialog

Parameters

options: { bonus: string; d20: string; formula: string; name: string; } = {}

bonus: string

d20: string

formula: string

name: string

Returns object

Settings

Member Visibility

`Optional` data: any

`Optional` context: any

`Private` _detectSkippedTurns

from: {
round: number;
turn: number;
} = {}

`Private` _onNewTurn

`Optional` options: {
bonus: undefined | string;
rollMode: undefined | string;
skipDialog: undefined | boolean;
} = {}

Returns Promise<CombatPF | {
combat: CombatPF;
messages: any;
}>

`Static` showInitiativeDialog

options: {
bonus: string;
d20: string;
formula: string;
name: string;
} = {}