forked from foundryvtt/pf2e
-
Notifications
You must be signed in to change notification settings - Fork 0
/
document.ts
614 lines (514 loc) · 23 KB
/
document.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
import { type ActorPF2e } from "@actor";
import { ItemPF2e, ItemProxyPF2e, type ContainerPF2e } from "@item";
import { ItemSourcePF2e, ItemSummaryData, PhysicalItemSource, TraitChatData } from "@item/base/data/index.ts";
import { MystifiedTraits } from "@item/base/data/values.ts";
import { isCycle } from "@item/container/helpers.ts";
import { Rarity, Size, ZeroToTwo } from "@module/data.ts";
import type { UserPF2e } from "@module/user/document.ts";
import { ErrorPF2e, isObject } from "@util";
import * as R from "remeda";
import { getUnidentifiedPlaceholderImage } from "../identification.ts";
import { Bulk } from "./bulk.ts";
import {
IdentificationStatus,
ItemActivation,
ItemCarryType,
ItemMaterialData,
MystifiedData,
PhysicalItemHitPoints,
PhysicalItemTrait,
PhysicalSystemData,
Price,
} from "./data.ts";
import { CoinsPF2e, computeLevelRarityPrice, handleHPChange, prepareBulkData } from "./helpers.ts";
import { getUsageDetails, isEquipped } from "./usage.ts";
import { DENOMINATIONS } from "./values.ts";
abstract class PhysicalItemPF2e<TParent extends ActorPF2e | null = ActorPF2e | null> extends ItemPF2e<TParent> {
/** The item in which this item is embedded */
parentItem: PhysicalItemPF2e | null;
/**
* The cached container of this item, if in a container, or null
* @ignore
*/
private declare _container: ContainerPF2e<ActorPF2e> | null;
/** Doubly-embedded adjustments, attachments, talismans etc. */
declare subitems: PhysicalItemPF2e<TParent>[];
constructor(data: PreCreate<ItemSourcePF2e>, context: PhysicalItemConstructionContext<TParent> = {}) {
super(data, context);
this.parentItem = context.parentItem ?? null;
}
get level(): number {
return this.system.level.value;
}
get rarity(): Rarity {
return this.system.traits.rarity;
}
get traits(): Set<PhysicalItemTrait> {
return new Set(this.system.traits.value);
}
get quantity(): number {
return Number(this.system.quantity ?? 1);
}
get size(): Size {
return this.system.size;
}
get hitPoints(): PhysicalItemHitPoints {
return fu.deepClone(this.system.hp);
}
get hardness(): number {
return this.system.hardness;
}
get isEquipped(): boolean {
return isEquipped(this.system.usage, this.system.equipped);
}
get carryType(): ItemCarryType {
return this.system.equipped.carryType;
}
/** Whether the item is currently being held */
get isHeld(): boolean {
return this.handsHeld > 0;
}
/** The number of hands being used to hold this item */
get handsHeld(): ZeroToTwo {
return this.system.equipped.carryType === "held" ? this.system.equipped.handsHeld ?? 1 : 0;
}
/** Whether the item is currently being worn */
get isWorn(): boolean {
return this.system.equipped.carryType === "worn";
}
get price(): Price {
return this.system.price;
}
/** The monetary value of the entire item stack */
get assetValue(): CoinsPF2e {
return CoinsPF2e.fromPrice(this.price, this.quantity);
}
get identificationStatus(): IdentificationStatus {
return this.system.identification.status;
}
get isIdentified(): boolean {
return this.system.identification.status === "identified";
}
get isAlchemical(): boolean {
return this.traits.has("alchemical");
}
get isMagical(): boolean {
const traits: Set<string> = this.traits;
const magicTraits = ["magical", "arcane", "primal", "divine", "occult"] as const;
return magicTraits.some((t) => traits.has(t));
}
get isInvested(): boolean | null {
const traits: Set<string> = this.traits;
if (!traits.has("invested")) return null;
return this.isEquipped && this.isIdentified && this.system.equipped.invested === true;
}
get isCursed(): boolean {
return this.traits.has("cursed");
}
get isTemporary(): boolean {
return this.system.temporary;
}
get isShoddy(): boolean {
return this.system.traits.otherTags.includes("shoddy");
}
get isDamaged(): boolean {
return this.system.hp.value > 0 && this.system.hp.value < this.system.hp.max;
}
get isBroken(): boolean {
const { hitPoints } = this;
return hitPoints.max > 0 && !this.isDestroyed && hitPoints.value <= hitPoints.brokenThreshold;
}
get isDestroyed(): boolean {
const { hitPoints } = this;
return hitPoints.max > 0 && hitPoints.value === 0;
}
get material(): ItemMaterialData {
return fu.deepClone(this.system.material);
}
/** Whether this is a specific magic item: applicable to armor, shields, and weapons */
get isSpecific(): boolean {
return false;
}
get isInContainer(): boolean {
return !!this.container;
}
get isStowed(): boolean {
return !!this.container?.system.stowing;
}
/** Get this item's container, returning null if it is not in a container */
get container(): ContainerPF2e<ActorPF2e> | null {
if (this.system.containerId === null) return (this._container = null);
return (this._container ??=
this.actor?.itemTypes.backpack.find((c) => c.id === this.system.containerId) ?? null);
}
/** Returns the bulk of this item and all sub-containers */
get bulk(): Bulk {
const { per } = this.system.bulk;
const bulkRelevantQuantity = Math.floor(this.quantity / per);
// Only convert to actor-relative size if the actor is a creature
// https://2e.aonprd.com/Rules.aspx?ID=258
const actorSize = this.actor?.isOfType("creature") ? this.actor.size : null;
return new Bulk(this.system.bulk.value)
.convertToSize(this.size, actorSize ?? this.size)
.times(bulkRelevantQuantity);
}
get activations(): (ItemActivation & { componentsLabel: string })[] {
return Object.values(this.system.activations ?? {}).map((action) => {
const components: string[] = [];
if (action.components.cast) components.push(game.i18n.localize("PF2E.Item.Activation.Cast"));
if (action.components.command) components.push(game.i18n.localize("PF2E.Item.Activation.Command"));
if (action.components.envision) components.push(game.i18n.localize("PF2E.Item.Activation.Envision"));
if (action.components.interact) components.push(game.i18n.localize("PF2E.Item.Activation.Interact"));
return {
componentsLabel: components.join(", "),
...action,
};
});
}
/** Generate a list of strings for use in predication */
override getRollOptions(prefix = this.type): string[] {
const rollOptions = super.getRollOptions(prefix);
const { material } = this.system;
rollOptions.push(
...Object.entries({
equipped: this.isEquipped,
[`hands-held:${this.handsHeld}`]: this.handsHeld > 0,
[`rarity:${this.rarity}`]: true,
uninvested: this.isInvested === false,
[`material:${material.type}`]: !!material.type,
})
.filter((e) => !!e[1])
.map((e) => `${prefix}:${e[0]}`),
);
return rollOptions;
}
protected override _initialize(options?: Record<string, unknown>): void {
this._container = null;
super._initialize(options);
}
override prepareBaseData(): void {
super.prepareBaseData();
// null out empty-string values
this.system.containerId ||= null;
this.system.material.type ||= null;
this.system.material.grade ||= null;
this.system.material.effects ??= [];
this.system.stackGroup ??= null;
this.system.hp.brokenThreshold = Math.floor(this.system.hp.max / 2);
// Temporary: prevent noise from items pre migration 746
if (typeof this.system.price.value === "string") {
this.system.price.value = CoinsPF2e.fromString(this.system.price.value);
}
// Ensure infused items are always temporary
const traits: PhysicalItemTrait[] = this.system.traits.value;
if (traits.includes("infused")) this.system.temporary = true;
// Normalize and fill price data
this.system.price.value = new CoinsPF2e(this.system.temporary ? {} : this.system.price.value);
this.system.price.per = Math.max(1, this.system.price.per ?? 1);
// Fill out usage and equipped status
this.system.usage = getUsageDetails(this.system.usage?.value ?? "carried");
const { equipped, usage } = this.system;
equipped.handsHeld ??= 0;
equipped.carryType ??= "worn";
if (usage.type === "worn" && usage.where) equipped.inSlot ??= false;
// Unequip items on loot actors
if (this.actor?.isOfType("loot")) {
equipped.carryType = "worn";
equipped.inSlot = false;
}
this.system.bulk = prepareBulkData(this);
// Set the _container cache property to null if it no longer matches this item's container ID
if (this._container?.id !== this.system.containerId) {
this._container = null;
}
// Prepare doubly-embedded items if this is of an appropriate physical-item type
this.subitems =
"subitems" in this.system && Array.isArray(this.system.subitems)
? this.system.subitems.map(
(i) =>
new ItemProxyPF2e(i, { parent: this.parent, parentItem: this }) as PhysicalItemPF2e<TParent>,
)
: [];
}
/** Refresh certain derived properties in case of special data preparation from subclasses */
override prepareDerivedData(): void {
super.prepareDerivedData();
this.name = game.pf2e.system.generateItemName(this);
this.system.identification.identified ??= {
name: this.name,
img: this.img,
data: {
description: { value: this.description },
},
};
// Compute level, rarity, and price from factors like runes, precious material, shoddiness, and size
const { level, rarity, price } = computeLevelRarityPrice(this);
this.system.level.value = level;
this.system.traits.rarity = rarity;
this.system.price.value = price;
// Update properties according to identification status
const mystifiedData = this.getMystifiedData(this.identificationStatus);
this.name = mystifiedData.name;
this.img = mystifiedData.img;
this.system.description.value = mystifiedData.data.description.value;
// Fill gaps in unidentified data with defaults
this.system.identification.unidentified = this.getMystifiedData("unidentified");
if (!this.isEmbedded) {
// Otherwise called in`onPrepareSynthetics`
this.system.hp.value = Math.clamped(this.system.hp.value, 0, this.system.hp.max);
}
}
override prepareSiblingData(): void {
if (!this.actor) return;
if (this.isStowed) {
this.system.equipped.carryType = "stowed";
delete this.system.equipped.inSlot;
}
// Clear the container reference if it turns out to be stale
if (this._container && !this.actor.items.has(this._container.id)) {
this._container = this.system.containerId = null;
}
}
/** After item alterations have occurred, ensure that this item's hit points are no higher than its maximum */
override onPrepareSynthetics(): void {
this.system.hp.value = Math.clamped(this.system.hp.value, 0, this.system.hp.max);
}
/** Can the provided item stack with this item? */
isStackableWith(item: PhysicalItemPF2e): boolean {
const preCheck =
this !== item &&
this.type === item.type &&
this.name === item.name &&
this.isIdentified === item.isIdentified &&
![this, item].some((i) => i.isHeld || i.isOfType("backpack"));
if (!preCheck) return false;
const thisData = this.toObject().system;
const otherData = item.toObject().system;
thisData.quantity = otherData.quantity;
thisData.equipped = otherData.equipped;
thisData.containerId = otherData.containerId;
thisData._migration = otherData._migration;
thisData.identification = otherData.identification;
return R.equals(thisData, otherData);
}
/** Combine this item with a target item if possible */
async stackWith(targetItem: PhysicalItemPF2e): Promise<void> {
if (this.isStackableWith(targetItem)) {
const stackQuantity = this.quantity + targetItem.quantity;
if (await this.delete({ render: false })) {
await targetItem.update({ "system.quantity": stackQuantity });
}
}
}
/**
* Move this item somewhere else in the inventory, possibly before or after another item or in or out of a container.
* If this item and the target item are stackable they will be stacked automatically
* @param options Options to control where this item is moved to
* @param options.relativeTo An optional target item to sort this item relative to
* @param options.sortBefore Should this item be sorted before or after the target item?
* @param options.toContainer An optional container to move this item into. If the target item is in a container this can be omitted
* @param options.render Render the update? Overridden by moving the item in or out of a container. Defaults to true
* @returns
*/
async move({
relativeTo,
sortBefore,
toContainer,
toStack,
render = true,
}: {
relativeTo?: PhysicalItemPF2e;
sortBefore?: boolean;
toContainer?: ContainerPF2e<ActorPF2e> | null;
toStack?: PhysicalItemPF2e;
render?: boolean;
}): Promise<void> {
if (!this.actor) {
throw ErrorPF2e(`Tried to move an unonwned item!`);
}
if (toStack) {
return this.stackWith(toStack);
}
const containerResolved = toContainer ?? relativeTo?.container;
const mainContainerUpdate = (() => {
// Move into a container
if (containerResolved && !isCycle(this, containerResolved)) {
const carryType = containerResolved.stowsItems ? "stowed" : "worn";
const equipped = { carryType, handsHeld: 0, inSlot: false };
return { system: { containerId: containerResolved?.id, equipped } };
}
// Move out of a container
if (!containerResolved && this.isInContainer) {
const equipped = { carryType: "worn", handsHeld: 0, inSlot: false };
return { system: { containerId: null, equipped } };
}
// Move without changing container state
return null;
})();
const inventory = this.actor.inventory;
const siblings = (containerResolved?.contents.contents ?? inventory.contents).sort((a, b) => a.sort - b.sort);
// If there is nothing to sort, perform the normal update and end here
if (!sortBefore && !siblings.length && !!mainContainerUpdate) {
await this.update(mainContainerUpdate);
return;
}
const sorting = SortingHelpers.performIntegerSort(this, {
target: relativeTo,
siblings,
sortBefore,
});
const updates = sorting.map((s) => {
const baseUpdate = { _id: s.target.id, ...s.update };
if (mainContainerUpdate && s.target.id === this.id) {
return fu.mergeObject(baseUpdate, mainContainerUpdate);
}
return baseUpdate;
});
// Always render if moved in or out of a container
const stowedOrUnstowed = (!this.container && !!containerResolved) || (this.container && !containerResolved);
await this.actor.updateEmbeddedDocuments("Item", updates, { render: stowedOrUnstowed || render });
}
/* Retrieve subtitution data for an unidentified or misidentified item, generating defaults as necessary */
getMystifiedData(status: IdentificationStatus, _options?: Record<string, boolean>): MystifiedData {
const mystifiedData: MystifiedData = this.system.identification[status];
const name = mystifiedData.name || this.generateUnidentifiedName();
const img = mystifiedData.img || getUnidentifiedPlaceholderImage(this);
const description =
mystifiedData.data.description.value ||
(() => {
if (status === "identified") return this.description;
const itemType = this.generateUnidentifiedName({ typeOnly: true });
const caseCorrect = (noun: string) =>
game.i18n.lang.toLowerCase() === "de" ? noun : noun.toLowerCase();
return game.i18n.format("PF2E.identification.UnidentifiedDescription", { item: caseCorrect(itemType) });
})();
return {
name,
img,
data: {
description: {
value: description,
},
},
};
}
override async getChatData(): Promise<ItemSummaryData> {
const { type, grade } = this.system.material;
const material =
type && grade
? game.i18n.format("PF2E.Item.Weapon.MaterialAndRunes.MaterialOption", {
type: game.i18n.localize(CONFIG.PF2E.preciousMaterials[type]),
grade: game.i18n.localize(CONFIG.PF2E.preciousMaterialGrades[grade]),
})
: null;
return {
rarity: {
name: this.rarity,
label: CONFIG.PF2E.rarityTraits[this.rarity],
description: CONFIG.PF2E.traitsDescriptions[this.rarity],
},
description: { value: this.description },
material,
};
}
async setIdentificationStatus(status: IdentificationStatus): Promise<void> {
if (this.identificationStatus === status) return;
await this.update({
"system.identification.status": status,
"system.identification.unidentified": this.getMystifiedData("unidentified"),
});
}
generateUnidentifiedName({ typeOnly = false }: { typeOnly?: boolean } = {}): string {
const itemType = game.i18n.localize(`TYPES.Item.${this.type}`);
if (typeOnly) return itemType;
return game.i18n.format("PF2E.identification.UnidentifiedItem", { item: itemType });
}
/** Include mystification-related rendering instructions for views that will display this data. */
protected override traitChatData(dictionary: Record<string, string>): TraitChatData[] {
const traitData = super.traitChatData(dictionary);
for (const trait of traitData) {
trait.mystified = !this.isIdentified && MystifiedTraits.has(trait.value);
trait.excluded = trait.mystified && !game.user.isGM;
if (trait.excluded) {
delete trait.description;
} else if (trait.mystified) {
const gmNote = game.i18n.localize("PF2E.identification.TraitGMNote");
trait.description = trait.description
? `${gmNote}\n\n${game.i18n.localize(trait.description)}`
: gmNote;
}
}
return traitData;
}
/* -------------------------------------------- */
/* Event Listeners and Handlers */
/* -------------------------------------------- */
/** Set to unequipped upon acquiring */
protected override async _preCreate(
data: this["_source"],
options: DocumentModificationContext<TParent>,
user: UserPF2e,
): Promise<boolean | void> {
this._source.system.equipped = { carryType: "worn" };
const isSlottedItem = this.system.usage.type === "worn" && !!this.system.usage.where;
if (isSlottedItem && this.actor?.isOfType("character")) {
this._source.system.equipped.inSlot = false;
}
return super._preCreate(data, options, user);
}
protected override async _preUpdate(
changed: DeepPartial<this["_source"]>,
options: DocumentUpdateContext<TParent>,
user: UserPF2e,
): Promise<boolean | void> {
if (!changed.system) return super._preUpdate(changed, options, user);
for (const property of ["quantity", "hardness"] as const) {
if (changed.system[property] !== undefined) {
const max = property === "quantity" ? 999_999 : 999;
changed.system[property] = Math.clamped(Math.trunc(Number(changed.system[property])), 0, max) || 0;
}
}
handleHPChange(this, changed);
// Clear 0 price denominations and per fields with values 0 or 1
if (isObject<Record<string, unknown>>(changed.system.price)) {
const price: Record<string, unknown> = changed.system.price;
if (isObject<Record<string, number | null>>(price.value)) {
const coins = price.value;
for (const denomination of DENOMINATIONS) {
if (coins[denomination] === 0) {
coins[`-=${denomination}`] = null;
}
}
}
if ("per" in price && (!price.per || Number(price.per) <= 1)) {
price["-=per"] = null;
}
}
const equipped: Record<string, unknown> = changed.system.equipped ?? {};
// Uninvest if dropping
if (equipped.carryType === "dropped" && this.system.equipped.invested) {
equipped.invested = false;
}
// Remove equipped.handsHeld and equipped.inSlot if the item is held or worn anywhere
const newCarryType = String(equipped.carryType ?? this.system.equipped.carryType);
if (!newCarryType.startsWith("held")) equipped.handsHeld = 0;
const newUsage = getUsageDetails(String(changed.system.usage?.value ?? this.system.usage.value));
const hasSlot = newUsage.type === "worn" && newUsage.where;
const isSlotted = Boolean(equipped.inSlot ?? this.system.equipped.inSlot);
if (hasSlot) {
equipped.inSlot = isSlotted;
} else if ("inSlot" in this._source.system.equipped) {
equipped["-=inSlot"] = null;
}
return super._preUpdate(changed, options, user);
}
}
interface PhysicalItemPF2e<TParent extends ActorPF2e | null = ActorPF2e | null> extends ItemPF2e<TParent> {
readonly _source: PhysicalItemSource;
system: PhysicalSystemData;
}
interface PhysicalItemConstructionContext<TParent extends ActorPF2e | null>
extends DocumentConstructionContext<TParent> {
parentItem?: PhysicalItemPF2e<TParent>;
}
export { PhysicalItemPF2e, type PhysicalItemConstructionContext };