Fix rule element initialization (#846)

* Fix up rule element trigger initialization
* Initialize the RE with a selected trigger

Author: Azurelol

lang/en.json

@@ -150,6 +150,7 @@
 		"Roll": "Roll",
 		"Add": "Add",
 		"Remove": "Remove",
+		"AddElement": "Add {element}",
 		"Multiply": "Multiply",
 		"Create": "Create",
 		"Edit": "Edit",
@@ -565,7 +566,7 @@
 		"Customization": "Customization",
 		"Opportunity": "Opportunity",
 		"Opportunities": "Opportunities",
-		"OpportunitiesHint": "When assigned, will be prompted as choices for the users.",
+		"OpportunitiesHint": "When assigned, will be prompted as choices for the users. If the table comes from a compendium you will have to import it.",
 		"InitiativeBonus": "Initiative Bonus",
 		"Price": "Price",
 		"MagicDefenseFormula": "Magic Defense Formula",

module/documents/effects/active-effect-config.mjs

@@ -1,7 +1,6 @@
 import { FU } from '../../helpers/config.mjs';
 import { systemTemplatePath } from '../../helpers/system-utils.mjs';
 import { PseudoDocument } from '../pseudo/pseudo-document.mjs';
-import { SubDocumentCollectionField } from '../sub/sub-document-collection-field.mjs';
 import { RuleElements } from '../../pipelines/rule-elements.mjs';
 import { RuleElementDataModel } from './rule-element-data-model.mjs';
 import { RuleActionRegistry } from './actions/rule-action-data-model.mjs';
@@ -10,6 +9,7 @@ import { RulePredicateRegistry } from './predicates/rule-predicate-data-model.mj
 import { ConsumableTraits, Traits, TraitUtils } from '../../pipelines/traits.mjs';
 import FoundryUtils from '../../helpers/foundry-utils.mjs';
 import { StringUtils } from '../../helpers/string-utils.mjs';
+import { SubDocumentCollectionField } from '../sub/sub-document-collection-field.mjs';
 
 RuleElements.register();
 
@@ -259,9 +259,22 @@ export class FUActiveEffectConfig extends foundry.applications.sheets.ActiveEffe
 	 * @returns {Promise<void>}
 	 */
 	static async #addRuleElement(event, target) {
-		const type = RuleElementDataModel.TYPE;
-		await SubDocumentCollectionField.addModel(this.document.system.rules.elements, type, this.document);
-		console.debug(`Added rule element`);
+		const triggerTypes = RuleTriggerRegistry.instance.localizedEntries;
+		const options = FoundryUtils.generateConfigOptions(triggerTypes);
+		const type = await FoundryUtils.selectOptionDialog(
+			StringUtils.localize('FU.AddElement', {
+				element: StringUtils.localize('FU.RuleElement'),
+			}),
+			options,
+		);
+
+		const triggerModel = RuleTriggerRegistry.instance.types[type];
+		const trigger = new triggerModel();
+		const data = {
+			trigger: trigger,
+		};
+		await SubDocumentCollectionField.addModel(this.document.system.rules.elements, RuleElementDataModel.TYPE, this.document, data);
+		console.debug(`Added rule element with trigger ${type}`);
 	}
 
 	/**

module/documents/effects/rule-element-data-model.mjs

@@ -1,5 +1,4 @@
 import { SubDocumentDataModel } from '../sub/sub-document-data-model.mjs';
-import { CombatEventRuleTrigger } from './triggers/combat-event-rule-trigger.mjs';
 import FoundryUtils from '../../helpers/foundry-utils.mjs';
 import { SubDocumentCollectionField } from '../sub/sub-document-collection-field.mjs';
 import { DataModelRegistry } from '../../fields/data-model-registry.mjs';
@@ -9,6 +8,7 @@ import { RuleTriggerRegistry } from './triggers/rule-trigger-data-model.mjs';
 import { RulePredicateDataModel, RulePredicateRegistry } from './predicates/rule-predicate-data-model.mjs';
 import { FU } from '../../helpers/config.mjs';
 import { StringUtils } from '../../helpers/string-utils.mjs';
+import { EmptyRuleTrigger } from './triggers/empty-rule-trigger.mjs';
 
 const fields = foundry.data.fields;
 
@@ -46,8 +46,7 @@ export class RuleElementDataModel extends SubDocumentDataModel {
 	static defineSchema() {
 		return Object.assign(super.defineSchema(), {
 			trigger: new fields.TypedSchemaField(RuleTriggerRegistry.instance.types, {
-				initial: new CombatEventRuleTrigger(),
-				nullable: true,
+				initial: new EmptyRuleTrigger(),
 			}),
 			actions: new SubDocumentCollectionField(RuleActionDataModel),
 			predicates: new SubDocumentCollectionField(RulePredicateDataModel),
@@ -74,7 +73,12 @@ export class RuleElementDataModel extends SubDocumentDataModel {
 	async addRuleAction() {
 		let subTypes = this.getMatchingSubTypes(RuleActionRegistry.instance);
 		const options = FoundryUtils.generateConfigOptions(subTypes);
-		const type = await FoundryUtils.selectOptionDialog('FU.RuleElementNew', options);
+		const type = await FoundryUtils.selectOptionDialog(
+			StringUtils.localize('FU.AddElement', {
+				element: StringUtils.localize('FU.RuleActions'),
+			}),
+			options,
+		);
 		if (type) {
 			await SubDocumentCollectionField.addModel(this.actions, type, this);
 		}
@@ -113,7 +117,12 @@ export class RuleElementDataModel extends SubDocumentDataModel {
 	async addRulePredicate() {
 		let subTypes = this.getMatchingSubTypes(RulePredicateRegistry.instance);
 		const options = FoundryUtils.generateConfigOptions(subTypes);
-		const type = await FoundryUtils.selectOptionDialog('FU.Add', options);
+		const type = await FoundryUtils.selectOptionDialog(
+			StringUtils.localize('FU.AddElement', {
+				element: StringUtils.localize('FU.RulePredicates'),
+			}),
+			options,
+		);
 		if (type) {
 			await SubDocumentCollectionField.addModel(this.predicates, type, this);
 		}

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

@@ -0,0 +1,25 @@
+import { RuleTriggerDataModel } from './rule-trigger-data-model.mjs';
+import { systemTemplatePath } from '../../../helpers/system-utils.mjs';
+
+/**
+ * @desc Initial rule trigger.
+ */
+export class EmptyRuleTrigger extends RuleTriggerDataModel {
+	static {
+		Object.defineProperty(this, 'TYPE', { value: 'emptyRuleTrigger' });
+	}
+
+	/**
+	 * @return {String}
+	 */
+	static get localization() {
+		return '-';
+	}
+
+	/**
+	 * @return {String}
+	 */
+	static get template() {
+		return systemTemplatePath('common/empty');
+	}
+}

module/documents/sub/sub-document-collection-field.mjs

@@ -52,9 +52,10 @@ export class SubDocumentCollectionField extends TypedObjectField {
 	/**
 	 * @param {SubDocumentCollectionField} field
 	 * @param {String} type
+	 * @param {Object} data
 	 * @param document
 	 */
-	static async addModel(field, type, document) {
-		return field.documentClass.create({ type }, { parent: document });
+	static async addModel(field, type, document, data = {}) {
+		return field.documentClass.create({ type, ...data }, { parent: document });
 	}
 }

module/pipelines/effects.mjs

@@ -120,6 +120,11 @@ async function getEffectData(id) {
 	if (!effect) {
 		console.error(`No effect with id '${id}' could be resolved.`);
 	}
+
+	if (effect) {
+		effect = FoundryUtils.safeClone(effect);
+	}
+
 	return effect;
 }
 

module/pipelines/rule-elements.mjs

@@ -57,8 +57,10 @@ import { CalculateExpenseRuleTrigger } from '../documents/effects/triggers/calcu
 import { FeatureRuleTrigger } from '../documents/effects/triggers/feature-rule-trigger.mjs';
 import { FUItem } from '../documents/items/item.mjs';
 import { RenderMessageRuleTrigger } from '../documents/effects/triggers/render-message-rule-trigger.mjs';
+import { EmptyRuleTrigger } from '../documents/effects/triggers/empty-rule-trigger.mjs';
 
 function register() {
+	RuleTriggerRegistry.instance.register(systemId, EmptyRuleTrigger.TYPE, EmptyRuleTrigger);
 	RuleTriggerRegistry.instance.register(systemId, CombatEventRuleTrigger.TYPE, CombatEventRuleTrigger);
 	RuleTriggerRegistry.instance.register(systemId, AttackRuleTrigger.TYPE, AttackRuleTrigger);
 	RuleTriggerRegistry.instance.register(systemId, StatusRuleTrigger.TYPE, StatusRuleTrigger);