Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extend bulk ItemAlteration to allow for further modes #18163

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
+13 −4
Open

Extend bulk ItemAlteration to allow for further modes #18163

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
463dd15
Change `bulk` ItemAlteration to accept more modes
Cerapter Jan 31, 2025
9fdcdb5
Add `level` as a potential ItemAlteration
Cerapter Jan 31, 2025
ed82fec
Add `flags` as an ItemAlteration to change an objects flags
Cerapter Jan 31, 2025
54d7569
Separated error checking and actually modifying flags
Cerapter Jan 31, 2025
4e7eb53
Revert "Separated error checking and actually modifying flags"
Cerapter Feb 2, 2025
d434cba
Revert "Add `flags` as an ItemAlteration to change an objects flags"
Cerapter Feb 2, 2025
5cf11e4
Revert "Add `level` as a potential ItemAlteration"
Cerapter Feb 2, 2025
9e43cde
Check that resulting bulk alteration isn't negative
Cerapter Feb 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 40 additions & 1 deletion src/module/rules/rule-element/item-alteration/alteration.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,13 @@ class ItemAlteration extends foundry.abstract.DataModel<RuleElementPF2e, ItemAlt
"defense-passive",
"description",
"dex-cap",
"flags",
"focus-point-cost",
"frequency-max",
"frequency-per",
"hardness",
"hp-max",
"level",
"material-type",
"other-tags",
"pd-recovery-dc",
Expand Down Expand Up @@ -152,7 +154,12 @@ class ItemAlteration extends foundry.abstract.DataModel<RuleElementPF2e, ItemAlt
const validator = ITEM_ALTERATION_VALIDATORS[this.property];
data.alteration.value = Number(data.alteration.value) || 0;
if (!validator.isValid(data)) return;
data.item.system.bulk.value = data.alteration.value;
const newValue = AELikeRuleElement.getNewValue(
this.mode,
data.item.system.bulk.value,
data.alteration.value,
);
data.item.system.bulk.value = Math.round(newValue * 10) / 10;
if (data.item instanceof foundry.abstract.DataModel) {
data.item.system.bulk = prepareBulkData(data.item);
}
Expand Down Expand Up @@ -248,6 +255,24 @@ class ItemAlteration extends foundry.abstract.DataModel<RuleElementPF2e, ItemAlt
data.item.system.dexCap = Math.max(newValue, 0);
return;
}
case "flags": {
const validator = ITEM_ALTERATION_VALIDATORS[this.property];
if (!validator.isValid(data)) return;
if (!("getFlag" in data.item) || typeof data.item.getFlag !== "function") return;

const flatValue = foundry.utils.flattenObject(data.alteration.value);
const resolvedValue = {};
for (const [key, value] of Object.entries(flatValue)) {
const flag = data.item.getFlag("pf2e", key);
const newValue = AELikeRuleElement.getNewValue(this.mode, flag, value);
if (newValue instanceof DataModelValidationFailure) {
throw newValue.asError();
}
foundry.utils.mergeObject(resolvedValue, { [`${key}`]: newValue });
}
foundry.utils.mergeObject(data.item.flags.pf2e, resolvedValue);
return;
}
case "focus-point-cost": {
const validator = ITEM_ALTERATION_VALIDATORS[this.property];
if (!validator.isValid(data)) return;
Expand Down Expand Up @@ -285,6 +310,20 @@ class ItemAlteration extends foundry.abstract.DataModel<RuleElementPF2e, ItemAlt
}
return;
}
case "level": {
const validator = ITEM_ALTERATION_VALIDATORS[this.property];
if (
validator.isValid(data) &&
"level" in data.item.system &&
typeof data.item.system.level !== "undefined"
) {
const level = data.item.system.level;
const value = data.alteration.value;
const newValue = AELikeRuleElement.getNewValue(this.mode, level.value, value);
level.value = Math.clamp(Math.trunc(newValue), -1, 100);
}
return;
}
case "persistent-damage": {
const pdObject = isObject<PersistentSourceData>(data.alteration.value)
? data.alteration.value
Expand Down
58 changes: 55 additions & 3 deletions src/module/rules/rule-element/item-alteration/schemas.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,11 +150,14 @@ const ITEM_ALTERATION_VALIDATORS = {
),
bulk: new ItemAlterationValidator({
itemType: new fields.StringField({ required: true, choices: Array.from(PHYSICAL_ITEM_TYPES) }),
mode: new fields.StringField({ required: true, choices: ["override"] }),
value: new StrictNumberField<number, number, true, false, false>({
mode: new fields.StringField({
required: true,
choices: () => ["add", "downgrade", "multiply", "override", "remove", "subtract", "upgrade"],
}),
value: new StrictNumberField({
required: true,
nullable: false,
choices: [0, 0.1, ...Array.fromRange(100, 1)],
Copy link
Collaborator

@stwlam stwlam Feb 2, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We'll an additional check here to ensure the resulting value is valid.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I already round the resulting value to 1/10ths, but I can add a check for it to be nonnegative, at least.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

0.1 (L) is also the only valid non-integer value since Light bulk isn't a countable unit of measurement.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Technically correct, in practice, the system can actually handle values like "9L" or "3; 4L".

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:)

integer: false,
initial: undefined,
} as const),
}),
Expand Down Expand Up @@ -304,6 +307,28 @@ const ITEM_ALTERATION_VALIDATORS = {
initial: undefined,
} as const),
}),
flags: new ItemAlterationValidator(
{
itemType: new fields.StringField({
required: true,
choices: () => R.keys(CONFIG.PF2E.Item.documentClasses),
}),
mode: new fields.StringField({
required: true,
choices: ["add", "downgrade", "multiply", "override", "remove", "subtract", "upgrade"],
}),
value: new fields.ObjectField({ required: true, nullable: false, initial: undefined } as const),
},
{
validateForItem(item): DataModelValidationFailure | void {
if (!("getFlag" in item) || typeof item.getFlag !== "function") {
return new validation.DataModelValidationFailure({
message: "item must be able to accept flags",
});
}
},
},
),
"focus-point-cost": new ItemAlterationValidator({
itemType: new fields.StringField({ required: true, choices: ["spell"] } as const),
mode: new fields.StringField({
Expand Down Expand Up @@ -333,6 +358,33 @@ const ITEM_ALTERATION_VALIDATORS = {
initial: undefined,
} as const),
}),
level: new ItemAlterationValidator(
{
itemType: new fields.StringField({
required: true,
choices: () => R.keys(CONFIG.PF2E.Item.documentClasses),
}),
mode: new fields.StringField({
required: true,
choices: ["add", "downgrade", "multiply", "override", "remove", "subtract", "upgrade"],
}),
value: new fields.NumberField({
required: true,
nullable: false,
positive: false,
initial: undefined,
} as const),
},
{
validateForItem(item): DataModelValidationFailure | void {
if (item.system.level === undefined || item.system.level.value === undefined) {
return new validation.DataModelValidationFailure({
message: "item must have a level",
});
}
},
},
),
"material-type": new ItemAlterationValidator({
itemType: new fields.StringField({ required: true, choices: Array.from(PHYSICAL_ITEM_TYPES) }),
mode: new fields.StringField({ required: true, choices: ["override"] }),
Expand Down