Improve codex entry sharing (#969)

* Move the clock prompt to the progress pipeline file
* Get the sheet extensions system working!
* Get token instancing working!
* Get the place tile function working!

Author: Azurelol

lang/en.json

@@ -1941,6 +1941,7 @@
 		"BrowseImage": "Browse Image",
 		"UploadClipboardImage": "Upload Clipboard Image",
 		"CodexUploadDirectory": "Codex Upload Directory",
+		"InstantiateToken": "Instantiate Token",
 		"CodexUploadDirectoryMissing": "You must set an user directory for codex clipboard images to be uploaded to. This can be configured in the system settings.",
 		"Scope": "Scope",
 		"Flag": "Flag",

module/documents/items/common/progress-data-model.mjs

@@ -1,4 +1,3 @@
-import { systemPath } from '../../../helpers/config.mjs';
 import { ObjectUtils } from '../../../helpers/object-utils.mjs';
 import { MathHelper } from '../../../helpers/math-helper.mjs';
 import FoundryUtils from '../../../helpers/foundry-utils.mjs';
@@ -292,39 +291,6 @@ export class ProgressDataModel extends foundry.abstract.DataModel {
 		CommonEvents.progress(document, newTrack, 'add');
 	}
 
-	/**
-	 * @param {Document} document
-	 * @param {String} propertyPath
-	 * @pararm {Boolean} selectStyle
-	 * @returns {Promise<void>}
-	 */
-	static async promptAddToDocument(document, propertyPath, selectStyle = false) {
-		const result = await foundry.applications.api.DialogV2.input({
-			window: { title: game.i18n.localize('FU.ClockAdd') },
-			classes: ['projectfu', 'unique-dialog', 'backgroundstyle'],
-			content: await foundry.applications.handlebars.renderTemplate(systemPath('templates/dialog/dialog-add-track.hbs'), {
-				selectStyle: selectStyle,
-			}),
-			rejectClose: false,
-			ok: {
-				label: game.i18n.localize('FU.Confirm'),
-			},
-		});
-
-		if (result) {
-			if (!result.name) {
-				return;
-			}
-			console.log('Creating progress track with name: ', result.name);
-			const newTrack = ProgressDataModel.construct(result.name, {
-				id: result.id,
-				max: result.max,
-				style: result.style,
-			});
-			await this.addToDocument(document, propertyPath, newTrack);
-		}
-	}
-
 	/**
 	 * @description Calculates the change in a clock due to the result of a check
 	 * @param result

module/helpers/foundry-utils.mjs

@@ -15,6 +15,7 @@ const { api, fields, handlebars } = foundry.applications;
  * @property {boolean} [disabled]
  * @property {boolean} [selected]
  * @property {boolean} [rule]
+ * @property {String} img (Custom for PFU dialogs)
  * @property {Record<string, string>} [dataset]
  */
 
@@ -85,19 +86,21 @@ export default class FoundryUtils {
 	/**
 	 * @param {String} title
 	 * @param content
+	 * @param {Object} options
 	 * @returns {Promise<*>}
 	 */
-	static async input(title, content) {
-		const result = await foundry.applications.api.DialogV2.input({
+	static async input(title, content, options = {}) {
+		let defaultOptions = {
 			window: { title: title, icon: 'fas fa-comment' },
 			content: content,
 			classes: ['projectfu', 'sheet', 'backgroundstyle', 'fu-dialog'],
 			rejectClose: false,
 			ok: {
 				label: 'FU.Confirm',
 			},
-		});
-		return result;
+		};
+		ObjectUtils.mergeRecursive(defaultOptions, options);
+		return await foundry.applications.api.DialogV2.input(defaultOptions);
 	}
 
 	/**
@@ -662,10 +665,12 @@ export default class FoundryUtils {
 	 *
 	 * @param html
 	 * @param className
+	 * @param eventName
 	 * @param {ContextMenuEntry[]} entries
 	 */
-	static contextMenu(html, className, entries) {
+	static contextMenu(html, className, entries, eventName = 'click') {
 		new foundry.applications.ux.ContextMenu(html, className, entries, {
+			eventName: eventName,
 			fixed: true,
 			jQuery: false,
 		});
@@ -790,4 +795,149 @@ export default class FoundryUtils {
 	}
 
 	static PLACEHOLDER_IMG = 'icons/svg/mystery-man.svg';
+
+	/**
+	 * @desc Instantiates an actor on the current scene, prompting the user to click where to place it.
+	 * @param {FUActor} actor
+	 * @param {Object} data
+	 * @returns {TokenDocument|null}
+	 */
+	static async instantiateActor(actor, data) {
+		const scene = game.scenes.viewed;
+		if (!scene) {
+			return null;
+		}
+
+		const gridSize = scene.grid.size;
+		const tokenData = await actor.getTokenDocument({
+			x: 0,
+			y: 0,
+			actorLink: false,
+		});
+		const tokenSize = tokenData.width;
+
+		const notification = ui.notifications.info('Left click to place the token on the active scene, right click to cancel the operation.', { permanent: true });
+
+		const position = await new Promise((resolve) => {
+			const clickHandler = (event) => {
+				const { x, y } = event.getLocalPosition(canvas.stage);
+				cleanup();
+				resolve({ x, y });
+			};
+
+			const rightClickHandler = () => {
+				cleanup();
+				ui.notifications.warn('Cancelled token placement.');
+				resolve(null);
+			};
+
+			const cleanup = () => {
+				canvas.stage.off('click', clickHandler);
+				canvas.stage.off('rightclick', rightClickHandler);
+				ui.notifications.remove(notification);
+			};
+
+			canvas.stage.on('click', clickHandler);
+			canvas.stage.on('rightclick', rightClickHandler);
+		});
+
+		if (!position) {
+			return null; // cancelled
+		}
+
+		const snapped = scene.grid.getSnappedPoint({
+			x: position.x - (tokenSize * gridSize) / 2,
+			y: position.y - (tokenSize * gridSize) / 2,
+		});
+
+		const [tokenDocument] = await scene.createEmbeddedDocuments('Token', [
+			{
+				...tokenData.toObject(),
+				x: snapped.x,
+				y: snapped.y,
+				...data,
+			},
+		]);
+		return tokenDocument;
+	}
+
+	/**
+	 * @param imagePath
+	 * @returns {Promise<Tile>}
+	 */
+	static async placeTile(imagePath) {
+		const scene = game.scenes.viewed;
+
+		// Get image dimensions to use as default tile size
+		// eslint-disable-next-line no-undef
+		const tex = await loadTexture(imagePath);
+		let width, height;
+
+		const promptTitle = `${StringUtils.localize('CONTROLS.TilePlace')} - Preset`;
+		const preset = await FoundryUtils.selectOptionDialog(promptTitle, [
+			{
+				label: StringUtils.localizeMultiple(['Token', 'Scale']),
+				value: 'token',
+			},
+			{
+				label: StringUtils.localizeMultiple(['Default', 'Scale']),
+				value: 'default',
+			},
+		]);
+		switch (preset) {
+			case 'token':
+				{
+					const scale = Math.min(100 / tex.width, 100 / tex.height);
+					width = tex.width * scale;
+					height = tex.height * scale;
+				}
+				break;
+			case 'default':
+				width = tex.width;
+				height = tex.height;
+				break;
+		}
+
+		if (!preset) {
+			return;
+		}
+
+		const notification = ui.notifications.info('Left click to place tile on the active scene, right click to cancel the operation.', { permanent: true });
+
+		return new Promise((resolve) => {
+			const clickHandler = async (event) => {
+				const { x, y } = event.getLocalPosition(canvas.stage);
+
+				cleanup();
+
+				const [tileDocument] = await scene.createEmbeddedDocuments('Tile', [
+					{
+						texture: { src: imagePath },
+						width,
+						height,
+						x: x - width / 2,
+						y: y - height / 2,
+					},
+				]);
+
+				canvas.tiles.releaseAll();
+				resolve(tileDocument);
+			};
+
+			const rightClickHandler = () => {
+				cleanup();
+				ui.notifications.warn('Cancelled tile placement.');
+				resolve(null); // cancelled
+			};
+
+			const cleanup = () => {
+				canvas.stage.off('click', clickHandler);
+				canvas.stage.off('rightclick', rightClickHandler);
+				ui.notifications.remove(notification);
+			};
+
+			canvas.stage.on('click', clickHandler);
+			canvas.stage.on('rightclick', rightClickHandler);
+		});
+	}
 }

module/helpers/object-utils.mjs

@@ -2,6 +2,7 @@
  * @param {Object} target
  * @param {Object} source
  * @returns {(Object|boolean)[]}
+ * @remarks If you don't care about whether it was changed, you can ignore the result.
  */
 function mergeRecursive(target, source) {
 	let changed = false;

module/helpers/string-utils.mjs

@@ -66,6 +66,15 @@ function localize(key, data = undefined) {
 	return key.toString();
 }
 
+/**
+ * @param {String[]} keys
+ * @param {String} separator
+ * @returns {String}
+ */
+function localizeMultiple(keys, separator = ' ') {
+	return keys.map((k) => localize(k)).join(separator);
+}
+
 /**
  * @param {String} key
  * @returns {Boolean}
@@ -139,6 +148,7 @@ export const StringUtils = Object.freeze({
 	camelToKebab,
 	titleToKebab,
 	localize,
+	localizeMultiple,
 	hasLocalization,
 	capitalize,
 	truncate,

module/hooks.mjs

@@ -248,6 +248,12 @@ export const FUHooks = {
 	 * @remarks Uses {@link FeatureEvent}
 	 */
 	FEATURE_EVENT: `projectfu.events.feature`,
-
+	/**
+	 * // TODO: ERICA LOOK AT ME!
+	 */
 	GET_SIDEBAR_TOOLS: `projectfu.getSidebarTools`,
+	/**
+	 * @description Dispatched when the party sheet is about to open, in order to provide options.
+	 */
+	SHEET_EXTENSIONS: `projectfu.sheets.extensions`,
 };

module/pipelines/progress-pipeline.mjs

@@ -13,6 +13,7 @@ import { CheckPrompt } from '../checks/check-prompt.mjs';
 import { Checks } from '../checks/checks.mjs';
 import { CheckConfiguration } from '../checks/check-configuration.mjs';
 import FoundryUtils from '../helpers/foundry-utils.mjs';
+import { systemPath } from '../helpers/config.mjs';
 
 /**
  * @param {FUActor} actor
@@ -188,6 +189,34 @@ async function openTrackMenuAtIndex(event, document, propertyPath, index) {
 	});
 }
 
+/**
+ * @param {Document} document
+ * @param {String} propertyPath
+ * @pararm {Boolean} selectStyle
+ * @returns {Promise<void>}
+ */
+async function promptAddToDocument(document, propertyPath, selectStyle = false) {
+	const title = StringUtils.localize('FU.ClockAdd');
+	const content = await foundry.applications.handlebars.renderTemplate(systemPath('templates/dialog/dialog-add-track.hbs'), {
+		selectStyle: selectStyle,
+	});
+	const result = await FoundryUtils.input(title, content, {});
+
+	if (result) {
+		if (!result.name) {
+			ui.notifications.error(`No name was given for the tracker!`);
+			return;
+		}
+		console.log('Creating progress track with name: ', result.name);
+		const newTrack = ProgressDataModel.construct(result.name, {
+			id: result.id,
+			max: result.max,
+			style: result.style,
+		});
+		await this.addToDocument(document, propertyPath, newTrack);
+	}
+}
+
 /**
  * @param {ChatMessage} message
  * @param {HTMLElement} html
@@ -224,4 +253,5 @@ export const ProgressPipeline = Object.freeze({
 	getAdvanceTargetedAction,
 	promptCheckAtIndexForDocument,
 	openTrackMenuAtIndex,
+	promptAddToDocument,
 });

module/projectfu.mjs

@@ -115,6 +115,7 @@ import { FUChatLog } from './ui/chat-log.mjs';
 import { AutomationPipeline } from './pipelines/automation.mjs';
 import { Themes } from './ui/themes/theme-options.mjs';
 import { FUSidebar, FUSidebarApplication } from './ui/sidebar.mjs';
+import { SheetExtensions } from './sheets/sheet-extension.mjs';
 
 globalThis.projectfu = {
 	ClassFeatureDataModel,
@@ -175,6 +176,7 @@ Hooks.once('init', async () => {
 			return FUPartySheet;
 		},
 		index: CompendiumIndex.instance,
+		hooks: FUHooks,
 	};
 
 	// (!) Data Models: Moved here due to lexical declaration issues otherwise
@@ -213,6 +215,11 @@ Hooks.once('init', async () => {
 		ruleTrigger: FU.ruleTriggerRegistry,
 		rulePredicate: FU.rulePredicateRegistry,
 	};
+
+	FU.sheetExtensions = {
+		party: new SheetExtensions(),
+	};
+
 	CONFIG.FU = FU;
 
 	/**
@@ -425,6 +432,9 @@ Hooks.once('init', async () => {
 	CompendiumBrowser.initialize();
 	Themes.initialize();
 
+	// Fetch any extensions from modules
+	Hooks.callAll(FUHooks.SHEET_EXTENSIONS, FU.sheetExtensions);
+
 	// Preload Handlebars templates.
 	return preloadHandlebarsTemplates();
 });