Implement impacts/debilities as ActiveEffects

CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## Next Release
 
+- Ironsworn debilities and Starforged impacts have been rewritten to take advantage of FVTT's ActiveEffects API.
+  - Unlimited Suffering! Player characters can now have any number of custom impacts.
+    - Note that custom impacts can't be managed from the token HUD yet, but we plan to add this in the future
+  - Ironsworn-style debilities or Starforged-style impacts can be selected independent of toolbox (though certain Starforged-specific sheets will override this)
+  - Plus some features standard to ActiveEffects, including token HUD integration
+- Impacts/debilities that prevent recovery of resources (e.g. wounded, shaken, unprepared) now 'lock' the condition meter in question (with a tooltip that identifies the culprit)
+- Make player condition meters and momentum available as bar displays on actor tokens
+
 ## 1.22.4
 
 - Fix a bug with "highest-of" stat selection, as with _Endure Stress_ ([#880](https://github.com/ben/foundry-ironsworn/pull/880))

src/config.ts

@@ -20,11 +20,12 @@ import {
 	registerOracleTree
 } from './module/features/customoracles'
 import { OracleTable } from './module/roll-table/oracle-table'
+import { IronActiveEffect } from './module/active-effect/active-effect'
 
 export interface EmitterEvents extends Record<EventType, unknown> {
 	highlightMove: string // Foundry UUID
 	highlightOracle: string // DF ID
-	globalConditionChanged: { name: string; enabled: boolean } // info about condition that changed
+	globalImpactChanged: { id: string; enabled: boolean } // info about condition that changed
 	dragStart: string // type of item
 	dragEnd: string // type of item
 }
@@ -33,6 +34,7 @@ export type IronswornEmitter = Emitter<EmitterEvents>
 export interface IronswornConfig {
 	actorClass: typeof IronswornActor
 	OracleTable: typeof OracleTable
+	IronActiveEffect: typeof IronActiveEffect
 
 	showdown: showdown.Converter
 
@@ -67,6 +69,7 @@ export interface IronswornConfig {
 export const IRONSWORN: IronswornConfig = {
 	actorClass: IronswornActor,
 	OracleTable,
+	IronActiveEffect,
 
 	// TODO: if we wanted to implement enrichMarkdown as a showdown plugin, we could use our own instance instead.
 	get showdown() {

src/index.ts

@@ -44,6 +44,7 @@ import type {
 	DocumentType
 } from '@league-of-foundry-developers/foundry-vtt-types/src/types/helperTypes'
 import ActorConfig from './module/actor/config'
+import { ConfigActiveEffect } from './module/active-effect/config'
 import ItemConfig from './module/item/config'
 
 declare global {
@@ -78,8 +79,20 @@ Hooks.once('init', async () => {
 
 	mergeObject(CONFIG.Actor, ActorConfig)
 	mergeObject(CONFIG.Item, ItemConfig)
+	mergeObject(CONFIG.ActiveEffect, ConfigActiveEffect)
+
+	/**
+	 * FVTT provides the same status effects to everyone by default. We circumvent this by making it a getter that accesses the current actor of the token HUD.
+	 *
+	 * Since the HUD is a singleton, that actor *should* always be the same as the actor who we're rendering status effects for.
+	 *
+	 * @see https://github.com/foundryvtt/foundryvtt/issues/9593
+	 */
+	Object.defineProperty(CONFIG, 'statusEffects', {
+		get: () => canvas?.hud?.token.object?.actor?.validImpacts ?? []
+	})
 
-	// Define custom Entity classes
+	// Define custom Document classes
 
 	CONFIG.JournalEntry.documentClass = IronswornJournalEntry
 	CONFIG.JournalEntryPage.documentClass = IronswornJournalPage