Add an affinity field to the damage rule trigger (#844)

Author: Azurelol

lang/en.json

@@ -542,6 +542,7 @@
 		"DamageIce": "Ice",
 		"DamageLight": "Light",
 		"DamagePoison": "Poison",
+		"Affinity": "Affinity",
 		"AffinityNormal": "Normal",
 		"AffinityVulnerable": "Vulnerable",
 		"AffinityVulnerableHint": "Vulnerable Multiplier",

module/checks/common-events.mjs

@@ -75,6 +75,7 @@ function attack(inspector, actor, item) {
  * @typedef DamageEvent
  * @property {CharacterInfo|null} source
  * @property {DamageType} type
+ * @property {FUAffinity} affinity
  * @property {InlineSourceInfo} sourceInfo
  * @property {FUItemGroup} damageSource
  * @property {Number} amount
@@ -87,7 +88,7 @@ function attack(inspector, actor, item) {
  * @property {String} origin An id used to prevent cascading.
  */
 
-async function damage(type, amount, traits, sourceActor, targetActor, sourceInfo, origin, renderData) {
+async function damage(type, affinity, amount, traits, sourceActor, targetActor, sourceInfo, origin, renderData) {
 	const source = CharacterInfo.fromActor(sourceActor);
 	const target = CharacterInfo.fromActor(targetActor);
 	const item = sourceInfo.resolveItem();
@@ -98,6 +99,7 @@ async function damage(type, amount, traits, sourceActor, targetActor, sourceInfo
 		amount: amount,
 		item: item,
 		type: type,
+		affinity: affinity,
 		source: source,
 		sourceActor: sourceInfo,
 		damageSource: damageSource,

module/documents/effects/triggers/damage-rule-trigger.mjs

@@ -11,6 +11,7 @@ const fields = foundry.data.fields;
  * @property {DamageType} damageTypes
  * @property {Set<FUItemGroup>} damageSource
  * @property {FUThreshold} damageThreshold
+ * @property {FUAffinity} affinity
  * @inheritDoc
  */
 export class DamageRuleTrigger extends RuleTriggerDataModel {
@@ -33,6 +34,11 @@ export class DamageRuleTrigger extends RuleTriggerDataModel {
 				choices: Object.keys(FU.damageTypes),
 				blank: true,
 			}),
+			affinity: new fields.StringField({
+				initial: '',
+				choices: Object.keys(FU.affValue),
+				blank: true,
+			}),
 			damageSources: new fields.SetField(new fields.StringField()),
 			damageThreshold: new fields.SchemaField({
 				operator: new fields.StringField({ initial: '', blank: true, choices: Object.keys(FU.comparisonOperator) }),
@@ -87,6 +93,12 @@ export class DamageRuleTrigger extends RuleTriggerDataModel {
 			return false;
 		}
 
+		if (this.affinity) {
+			if (context.event.affinity !== this.affinity) {
+				return false;
+			}
+		}
+
 		return true;
 	}
 }

module/helpers/config.mjs

@@ -158,6 +158,10 @@ FU.affTypeAbbr = {
 	3: 'FU.AffinityAbsorptionAbbr',
 };
 
+/**
+ * @typedef {'none'|'vulnerability'|'resistance'|'immunity'|'absorption'} FUAffinity
+ */
+
 FU.affValue = {
 	vulnerability: -1,
 	none: 0,
@@ -166,6 +170,19 @@ FU.affValue = {
 	absorption: 3,
 };
 
+FU.affinities = {
+	vulnerability: 'FU.AffinityVulnerable',
+	none: 'FU.AffinityNormal',
+	resistance: 'FU.AffinityResistance',
+	immunity: 'FU.AffinityImmune',
+	absorption: 'FU.AffinityAbsorption',
+};
+
+/**
+ * @desc For reverse lookups.
+ */
+FU.affinityKeyByValue = Object.fromEntries(Object.entries(FU.affValue).map(([k, v]) => [v, k]));
+
 /**
  * @typedef {"beast" | "construct" | "demon" | "elemental" | "humanoid" | "monster" | "plant" | "undead" | "custom"} FUSpeciesKey
  */

module/pipelines/damage-pipeline.mjs

@@ -516,7 +516,7 @@ async function process(request) {
 					postRenderActions: [],
 				};
 
-				await CommonEvents.damage(request.damageType, damageTaken, context.traits, context.sourceActor, actor, context.sourceInfo, request.origin, renderData);
+				await CommonEvents.damage(request.damageType, FU.affinityKeyByValue[context.affinity], damageTaken, context.traits, context.sourceActor, actor, context.sourceInfo, request.origin, renderData);
 				await CommonEvents.resource(request.sourceActor, request.targets, resource, -damageTaken, request.origin, renderData);
 				TokenUtils.showFloatyText(actor, `${-damageTaken} ${resource.toUpperCase()}`, color);
 

templates/effects/triggers/damage-rule-trigger.hbs

@@ -11,6 +11,14 @@
 	{{formGroup trigger.schema.fields.damageSources value=trigger.damageSources options=options.damageSourceOptions name=(pfuConcat path ".damageSources") classes="fu-rule-element__set stacked"}}
 </div>
 
+<label class="fu-rule-element__property">
+	<span>{{localize 'FU.Affinity'}}</span>
+	<select name="{{pfuConcat path ".affinity"}}">
+		<option value="">-</option>
+		{{selectOptions options.affinities selected=trigger.affinity sort=true localize=true}}
+	</select>
+</label>
+
 <div class="fu-rule-element__property-row">
 	<label class="fu-rule-element__property">
 		<span>{{localize 'FU.ComparisonOperator'}}</span>