Add Combat Only setting

Fix #109

Author: mclemente

src/lang/en.json

@@ -19,6 +19,10 @@
 				"name": "Indicator Distance",
 				"hint": "Set the multiplier for the indicator's distance. Math: Largest Size × (Multiplier / 2)."
 			},
+			"combatOnly": {
+				"name": "Hide Indicator While Out Of Combat",
+				"hint": "Hides the indicator when no combat is active."
+			},
 			"hideIndicatorOnDead": {
 				"name": "Hide Indicator On Dead Tokens",
 				"hint": "Hides the indicator from tokens marked as defeated on the combat tracker (e.g. the big skull marker on most systems)."

src/module/about-face.js

@@ -68,6 +68,14 @@ function addTokenConfigTab(cls, document = "document") {
 	});
 }
 
+function updateCombat(combat, updateData) {
+	if (!game.aboutFace.combatOnly) return;
+	game.aboutFace.combatRunning = game.aboutFace.isCombatRunning();
+	canvas.tokens?.placeables.forEach((token) => {
+		game.aboutFace.drawAboutFaceIndicator(token);
+	});
+}
+
 Hooks.once("init", () => {
 	registerSettings();
 	game.aboutFace = new AboutFace();
@@ -80,9 +88,19 @@ Hooks.once("init", () => {
 		Hooks.on("highlightObjects", highlightObjects);
 	}
 });
+Hooks.on("canvasInit", () => game.aboutFace.combatRunning = game.aboutFace.isCombatRunning());
 Hooks.on("canvasReady", async () => {
 	canvas.scene.tokens.forEach((tokenDocument) => game.aboutFace.drawAboutFaceIndicator(tokenDocument.object));
 });
+Hooks.on("combatStart", (combat, updateData) => {
+	if (!game.aboutFace.combatOnly) return;
+	game.aboutFace.combatRunning = true;
+	canvas.tokens?.placeables.forEach((token) => {
+		game.aboutFace.drawAboutFaceIndicator(token);
+	});
+});
+Hooks.on("updateCombat", updateCombat);
+Hooks.on("deleteCombat", updateCombat);
 Hooks.on("preCreateToken", onPreCreateToken);
 Hooks.on("preUpdateToken", onPreUpdateToken);
 Hooks.on("createToken", (tokenDocument, options, userId) => {

src/module/logic.js

@@ -2,6 +2,7 @@ import { IndicatorMode, MODULE_ID } from "./settings.js";
 
 export class AboutFace {
 	constructor() {
+		this.combatOnly = game.settings.get("about-face", "combatOnly");
 		this.indicatorColor = game.settings.get(MODULE_ID, "arrowColor").css;
 		this.indicatorDistance = game.settings.get(MODULE_ID, "arrowDistance");
 		this.hideIndicatorOnDead = game.settings.get("about-face", "hideIndicatorOnDead");
@@ -18,9 +19,19 @@ export class AboutFace {
 		this._tokenRotation = value;
 	}
 
+	isCombatRunning() {
+		return game.combats.some((combat) => combat.started);
+	}
+
 	drawAboutFaceIndicator(token) {
 		const deadIcon = CONFIG.statusEffects.find((x) => x.id === "dead")?.icon;
 		const isDead = token.actor?.effects.some((el) => el.statuses.has("dead") || el.img === deadIcon);
+		if (this.combatOnly && !this.combatRunning) {
+			if (token.aboutFaceIndicator && !token.aboutFaceIndicator?._destroyed) {
+				token.aboutFaceIndicator.graphics.visible = false;
+			}
+			return;
+		}
 		if (this.hideIndicatorOnDead && isDead) {
 			if (token.aboutFaceIndicator && !token.aboutFaceIndicator?._destroyed) {
 				token.aboutFaceIndicator.graphics.visible = false;

src/module/settings.js

@@ -174,6 +174,23 @@ export function registerSettings() {
 		requiresReload: true,
 	});
 
+	game.settings.register(MODULE_ID, "combatOnly", {
+		name: "about-face.options.combatOnly.name",
+		hint: "about-face.options.combatOnly.hint",
+		scope: "world",
+		config: true,
+		default: false,
+		type: Boolean,
+		onChange: (value) => {
+			game.aboutFace.combatOnly = value;
+			if (canvas === null) return;
+			const tokens = getAllTokens();
+			for (const token of tokens) {
+				game.aboutFace.drawAboutFaceIndicator(token);
+			}
+		},
+	});
+
 	game.settings.register(MODULE_ID, "hideIndicatorOnDead", {
 		name: "about-face.options.hideIndicatorOnDead.name",
 		hint: "about-face.options.hideIndicatorOnDead.hint",