API functionality related to the Exhaustion feature.

Constructors

Methods

  • Configures exhaustion to use an open number field, rather than a constrained set of levels.

    Returns Promise<void>

    Hooks.once('tidy5e-sheet.ready', async (api) => {
    await api.config.exhaustion.useOpenNumberExhaustion();
    });
  • Configures vehicle exhaustion to use an open number field, rather than a constrained set of levels.

    Returns Promise<void>

    Hooks.once('tidy5e-sheet.ready', async (api) => {
    await api.config.exhaustion.useOpenNumberVehicleExhaustion();
    });
  • Configures exhaustion to use a constrained set of levels with optional hints (usually rendered as tooltips).

    Parameters

    Returns Promise<void>

    Hooks.once('tidy5e-sheet.ready', async (api) => {
    await api.config.exhaustion.useSpecificLevelExhaustion({
    totalLevels: 3,
    hints: [
    'No exhaustion',
    'You are kind of tired',
    'You look unwell',
    'Dead 💀',
    ],
    });
    });
  • Configures vehicle exhaustion to use a constrained set of levels with optional hints (usually rendered as tooltips).

    Parameters

    Returns Promise<void>

    Hooks.once('tidy5e-sheet.ready', async (api) => {
    await api.config.exhaustion.useSpecificLevelVehicleExhaustion({
    totalLevels: 3,
    hints: ['Ship shape', 'A shape', "Uh oh, it's falling apart", 'Borked'],
    });
    });