Unified models for progress tracks and clocks

src/config.ts

@@ -20,6 +20,7 @@ import {
 	registerOracleTree
 } from './module/features/customoracles'
 import { OracleTable } from './module/roll-table/oracle-table'
+import { IronswornItem } from './module/item/item'
 
 export interface EmitterEvents extends Record<EventType, unknown> {
 	highlightMove: string // Foundry UUID
@@ -33,6 +34,7 @@ export type IronswornEmitter = Emitter<EmitterEvents>
 export interface IronswornConfig {
 	actorClass: typeof IronswornActor
 	OracleTable: typeof OracleTable
+	IronswornItem: typeof IronswornItem
 
 	showdown: showdown.Converter
 
@@ -67,6 +69,7 @@ export interface IronswornConfig {
 export const IRONSWORN: IronswornConfig = {
 	actorClass: IronswornActor,
 	OracleTable,
+	IronswornItem,
 
 	// TODO: if we wanted to implement enrichMarkdown as a showdown plugin, we could use our own instance instead.
 	get showdown() {

src/index.ts

@@ -45,6 +45,8 @@ import type {
 } from '@league-of-foundry-developers/foundry-vtt-types/src/types/helperTypes'
 import ActorConfig from './module/actor/config'
 import ItemConfig from './module/item/config'
+import { ProgressTrackModel } from './module/journal/subtypes/progress'
+import { TruthModel } from './module/journal/subtypes/truth'
 
 declare global {
 	interface LenientGlobalVariableTypes {
@@ -83,6 +85,10 @@ Hooks.once('init', async () => {
 
 	CONFIG.JournalEntry.documentClass = IronswornJournalEntry
 	CONFIG.JournalEntryPage.documentClass = IronswornJournalPage
+	;(CONFIG.JournalEntryPage as any).dataModels = {
+		progress: ProgressTrackModel,
+		truth: TruthModel
+	}
 
 	CONFIG.RollTable.documentClass = OracleTable
 	CONFIG.RollTable.resultIcon = 'icons/dice/d10black.svg'

src/module/actor/sheets/sitesheet.ts

@@ -18,7 +18,7 @@
 		// Fetch the item. We only want to override denizens (progress-type items)
 		const item = await Item.fromDropData(data)
 		if (item == null) return false
-		if (!item.assert('progress')) {
+		if (!item.assert('progressTrack')) {
 			return await super._onDropItem(event, data)
 		}
 

src/module/actor/subtypes/character.ts

@@ -1,17 +1,17 @@
-import { StatField } from '../../fields/StatField'
 import { ImpactField } from '../../fields/ImpactField'
-import type { IronswornActor } from '../actor'
-import { ProgressTicksField } from '../../fields/ProgressTicksField'
-import type { DataSchema } from '../../fields/utils'
 import type {
 	ConditionMeterSource,
 	MomentumSource
 } from '../../fields/MeterField'
 import { ConditionMeterField, MomentumField } from '../../fields/MeterField'
+import { StatField } from '../../fields/StatField'
+import type { LegacyTrackSource } from '../../model/LegacyTrack'
+import { LegacyTrack } from '../../model/LegacyTrack'
+import type { IronswornActor } from '../actor'
 
 export class CharacterModel extends foundry.abstract.TypeDataModel<
 	CharacterDataSourceData,
-	CharacterDataSourceData,
+	CharacterDataPropertiesData,
 	IronswornActor<'character'>
 > {
 	constructor(
@@ -112,30 +112,49 @@ export class CharacterModel extends foundry.abstract.TypeDataModel<
 				custom2name: new fields.StringField({})
 			}),
 
-			legacies: new fields.SchemaField<CharacterDataSourceData['legacies']>({
-				quests: new ProgressTicksField({
-					max: undefined
+			legacies: new fields.SchemaField({
+				quests: new fields.EmbeddedDataField(LegacyTrack, {
+					label: 'IRONSWORN.LEGACY.Quests'
 				}),
-				questsXpSpent: new fields.NumberField({
-					initial: 0
+				bonds: new fields.EmbeddedDataField(LegacyTrack, {
+					label: 'IRONSWORN.LEGACY.Bonds'
 				}),
-				bonds: new ProgressTicksField({
-					max: undefined
-				}),
-				bondsXpSpent: new fields.NumberField({
-					initial: 0
-				}),
-				discoveries: new ProgressTicksField({
-					max: undefined
-				}),
-				discoveriesXpSpent: new fields.NumberField({
-					initial: 0
+				discoveries: new fields.EmbeddedDataField(LegacyTrack, {
+					label: 'IRONSWORN.LEGACY.Discoveries'
 				})
 			})
 		}
 	}
+
+	static migrateData(source: Record<string, unknown>) {
+		// @ts-expect-error
+		super.migrateData(source)
+		const migrate = foundry.abstract.Document._addDataFieldMigration
+
+		const legacies = ['quests', 'bonds', 'discoveries']
+
+		for (const legacy of legacies) {
+			if (typeof source[legacy] === 'number')
+				source[legacy] = { ticks: source[legacy] }
+			migrate(source, `legacies.${legacy}XpSpent`, `legacies.${legacy}.xpSpent`)
+		}
+
+		return source
+	}
+}
+export interface CharacterModel extends CharacterDataPropertiesData {}
+export interface CharacterDataPropertiesData extends CharacterDataSourceData {
+	health: ConditionMeterField
+	spirit: ConditionMeterField
+	supply: ConditionMeterField
+	momentum: MomentumField
+
+	legacies: {
+		quests: LegacyTrack
+		bonds: LegacyTrack
+		discoveries: LegacyTrack
+	}
 }
-export interface CharacterModel extends CharacterDataSourceData {}
 export interface CharacterDataSourceData {
 	biography: string
 	notes: string
@@ -154,13 +173,11 @@ export interface CharacterDataSourceData {
 	momentum: MomentumSource
 
 	xp: number
+
 	legacies: {
-		quests: number
-		questsXpSpent: number
-		bonds: number
-		bondsXpSpent: number
-		discoveries: number
-		discoveriesXpSpent: number
+		quests: LegacyTrackSource
+		bonds: LegacyTrackSource
+		discoveries: LegacyTrackSource
 	}
 
 	debility: {

src/module/actor/subtypes/site.ts

@@ -1,19 +1,20 @@
 import type { TableResultDataConstructorData } from '@league-of-foundry-developers/foundry-vtt-types/src/foundry/common/data/data.mjs/tableResultData'
-import { ChallengeRank } from '../../fields/ChallengeRank'
-import { ProgressTicksField } from '../../fields/ProgressTicksField'
 import type { TableResultStub } from '../../fields/TableResultField'
 import { TableResultField } from '../../fields/TableResultField'
 import type { DataSchema } from '../../fields/utils'
+import type {
+	ProgressTrackProperties,
+	ProgressTrackSource
+} from '../../model/ProgressTrack'
+import { ProgressTrack } from '../../model/ProgressTrack'
 import { OracleTable } from '../../roll-table/oracle-table'
 import type { IronswornActor } from '../actor'
 
 export class SiteModel extends foundry.abstract.TypeDataModel<
 	SiteDataSourceData,
-	SiteDataSourceData,
+	SiteDataPropertiesData,
 	IronswornActor<'site'>
 > {
-	static _enableV10Validation = true
-
 	get denizenTable() {
 		return new OracleTable({
 			name: game.i18n.localize('IRONSWORN.DELVESITE.Denizens'),
@@ -110,11 +111,34 @@ export class SiteModel extends foundry.abstract.TypeDataModel<
 		return this.theme != null && this.domain != null
 	}
 
-	static override defineSchema(): DataSchema<SiteDataSourceData> {
+	async markProgress(times = 1) {
+		return await this.parent.update({
+			system: { progressTrack: this.progressTrack.getMarkData(times) }
+		})
+	}
+
+	/** Make the Reveal a Danger move and roll a random danger from this delve site. */
+	async revealADanger() {
+		return await (await this.getDangers())?.draw()
+	}
+
+	/** Make a progress roll with the Locate Your Objective move. */
+	async locateYourObjective() {
+		return await this.progressTrack.roll({
+			actor: this.parent,
+			objective: this.objective
+		})
+	}
+
+	static override defineSchema(): DataSchema<
+		SiteDataSourceData,
+		SiteDataPropertiesData
+	> {
 		const fields = foundry.data.fields
 		return {
-			rank: new ChallengeRank(),
-			current: new ProgressTicksField(),
+			progressTrack: new fields.EmbeddedDataField(ProgressTrack, {
+				initial: { enabled: true, subtype: 'delve' } as any
+			}) as any,
 			objective: new fields.HTMLField(),
 			description: new fields.HTMLField(),
 			notes: new fields.HTMLField(),
@@ -172,17 +196,30 @@ export class SiteModel extends foundry.abstract.TypeDataModel<
 			})
 		}
 	}
+
+	static migrateData(source) {
+		const migrate = foundry.abstract.Document._addDataFieldMigration
+		migrate(source, 'rank', 'progressTrack.rank')
+		migrate(source, 'current', 'progressTrack.ticks')
+
+		return source
+	}
 }
 
-export interface SiteModel extends SiteDataSourceData {}
+export interface SiteModel extends SiteDataPropertiesData {
+	progressTrack: ProgressTrack
+}
 
 interface SiteDataSourceData {
 	objective: string
 	description: string
 	notes: string
-	rank: ChallengeRank.Value
-	current: number
 	denizens: TableResultStub[]
+	progressTrack: ProgressTrackSource
+}
+interface SiteDataPropertiesData
+	extends Omit<SiteDataSourceData, 'progressTrack'> {
+	progressTrack: ProgressTrackProperties
 }
 
 export interface SiteDataSource {