From 3c82dc68190f006b07a197cd89106bb3b6ce6448 Mon Sep 17 00:00:00 2001
From: mac-tf2 <astokes96@hotmail.co.uk>
Date: Mon, 8 Apr 2024 17:44:44 +0100
Subject: [PATCH 1/3] feat: added timers for defrag powerups

---
 images/hud/damageboost.svg         |  4 ++++
 images/hud/haste.svg               |  4 ++++
 layout/hud/hud.xml                 |  1 +
 layout/hud/powerup-timer.xml       | 25 ++++++++++++++++++++
 scripts/hud/powerup-timer.ts       | 38 ++++++++++++++++++++++++++++++
 scripts/util/panel-registration.js |  1 +
 styles/hud/_index.scss             |  1 +
 styles/hud/powerup-timer.scss      | 35 +++++++++++++++++++++++++++
 8 files changed, 109 insertions(+)
 create mode 100644 images/hud/damageboost.svg
 create mode 100644 images/hud/haste.svg
 create mode 100644 layout/hud/powerup-timer.xml
 create mode 100644 scripts/hud/powerup-timer.ts
 create mode 100644 styles/hud/powerup-timer.scss

diff --git a/images/hud/damageboost.svg b/images/hud/damageboost.svg
new file mode 100644
index 00000000..56bf8ddb
--- /dev/null
+++ b/images/hud/damageboost.svg
@@ -0,0 +1,4 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 0 48 48">
+    <path fill="#fff" d="m23.685 28.887 24.315-27.331-26.199 19.334 6.1737-20.89-13.229 19.944-2.0919-12.999-3.0339 14.221s-3.1119-4.0836-3.0859-4.1076c0 6.9433-1.3059 15.998 2.2759 20.416 4.7558 5.8654 18.875 0.72193 25.307-0.88991l-10.04-2.0538 14.771-5.6394zm-0.50598 8.0012c-2.3619 0.50795-4.7518 0.87391-6.8697 0.87391-2.8079 0-4.7198-0.62994-5.6798-1.8758-0.89996-1.1679-1.4659-3.0737-1.7259-5.8294-0.17999-1.8898-0.19199-3.9656-0.15599-6.0634l2.0959 2.7517 1.4859-6.9713 1.056 6.5593 7.8297-11.807-3.7158 12.581 13.193-9.735-12.469 14.017h7.1197l-7.5397 3.3597z" />
+    <path fill="#fff" d="m16.367 41.364c-1.5614 6.442-9.0108 8.8078-13.643 4.333-4.6326-4.4748-3.1236-12.579 2.7639-14.842-1.6684 6.8763 4.5949 12.927 10.88 10.511z" />
+</svg>
\ No newline at end of file
diff --git a/images/hud/haste.svg b/images/hud/haste.svg
new file mode 100644
index 00000000..4b0a66f3
--- /dev/null
+++ b/images/hud/haste.svg
@@ -0,0 +1,4 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 0 48 48">
+  <path fill="#fff" d="m0 0 .91 2.344L9.324 24 0 48h16.676L26 24 16.676 0zm5.03 3.441h9.29l7.989 20.56-7.989 20.558H5.03L13.015 24z"/>
+  <path fill="#fff" d="m22 0 .91 2.344L31.324 24 22 48h16.676L48 24 38.676 0zm5.03 3.441h9.29l7.989 20.56-7.989 20.558h-9.29L35.015 24z"/>
+</svg>
\ No newline at end of file
diff --git a/layout/hud/hud.xml b/layout/hud/hud.xml
index 694ce0b2..37601d8a 100644
--- a/layout/hud/hud.xml
+++ b/layout/hud/hud.xml
@@ -44,6 +44,7 @@
 
 		<!-- Anchored to the bottom-left corner of the screen, laid out from top to bottom -->
 		<Panel id="HudLowerLeft" hittest="false" hittestchildren="true">
+			<MomHudPowerupTimer />
 			<HudStaticMenu />
 			<MomHudChat />
 		</Panel>
diff --git a/layout/hud/powerup-timer.xml b/layout/hud/powerup-timer.xml
new file mode 100644
index 00000000..88a85f78
--- /dev/null
+++ b/layout/hud/powerup-timer.xml
@@ -0,0 +1,25 @@
+<root>
+	<styles>
+		<include src="file://{resources}/styles/main.scss" />
+	</styles>
+	<scripts>
+		<include src="file://{scripts}/common/gamemodes.js" />
+		<include src="file://{scripts}/util/register-event-for-gamemodes.js" />
+		<include src="file://{scripts}/hud/powerup-timer.js" />
+	</scripts>
+
+	<MomHudPowerupTimer class="powerup-timer">
+		<Panel id="HasteTimer" class="powerup-timer__item">
+			<Image id="HasteIcon" class="powerup-timer__icon powerup-timer__icon--haste" src="file://{images}/hud/haste.svg" textureheight="72"/>
+			<Label id="HasteLabel" class="powerup-timer__label" text="" />
+		</Panel>
+		<Panel id="DamageBoostTimer" class="powerup-timer__item">
+			<Image id="DamageBoostIcon" class="powerup-timer__icon powerup-timer__icon--damageboost" src="file://{images}/hud/damageboost.svg" textureheight="72"/>
+			<Label id="DamageBoostLabel" class="powerup-timer__label" text="" />
+		</Panel>
+		<Panel id="SlickTimer" class="powerup-timer__item">
+			<Image id="SlickIcon" class="powerup-timer__icon" src="file://{images}/logo.svg" textureheight="72"/>
+			<Label id="SlickLabel" class="powerup-timer__label" text="" />
+		</Panel>
+	</MomHudPowerupTimer>
+</root>
diff --git a/scripts/hud/powerup-timer.ts b/scripts/hud/powerup-timer.ts
new file mode 100644
index 00000000..8b53c7c3
--- /dev/null
+++ b/scripts/hud/powerup-timer.ts
@@ -0,0 +1,38 @@
+class PowerupTimer {
+	static panels = {
+		damageBoost: {
+			panel: $('#DamageBoostTimer')!,
+			label: $<Label>('#DamageBoostLabel')!
+		},
+		haste: {
+			panel: $('#HasteTimer')!,
+			label: $<Label>('#HasteLabel')!
+		},
+		slick: {
+			panel: $('#SlickTimer')!,
+			label: $<Label>('#SlickLabel')!
+		}
+	};
+
+	static onUpdate() {
+		// @ts-expect-error - TODO: Types for this API!
+		const { damageBoostTime, hasteTime, slickTime } = MomentumMovementAPI.GetLastMoveData();
+
+		this.updatePanel(this.panels.damageBoost, damageBoostTime);
+		this.updatePanel(this.panels.haste, hasteTime);
+		this.updatePanel(this.panels.slick, slickTime);
+	}
+
+	static updatePanel({ panel, label }: { panel: Panel; label: Label }, time: number) {
+		if (!time) {
+			panel.visible = false;
+		} else {
+			panel.visible = true;
+			label.text = time < 0 ? '∞' : Math.ceil(time / 1000).toString();
+		}
+	}
+
+	static {
+		RegisterEventForGamemodes([GameMode.DEFRAG], 'HudProcessInput', $.GetContextPanel(), this.onUpdate.bind(this));
+	}
+}
diff --git a/scripts/util/panel-registration.js b/scripts/util/panel-registration.js
index 79ce3332..d9d24b11 100644
--- a/scripts/util/panel-registration.js
+++ b/scripts/util/panel-registration.js
@@ -17,6 +17,7 @@ UiToolkitAPI.RegisterHUDPanel2d('MomHudDFJump', 'file://{resources}/layout/hud/d
 UiToolkitAPI.RegisterHUDPanel2d('MomHudJumpStats', 'file://{resources}/layout/hud/jump-stats.xml');
 UiToolkitAPI.RegisterHUDPanel2d('MomHudSpecInfo', 'file://{resources}/layout/hud/spec-info.xml');
 UiToolkitAPI.RegisterHUDPanel2d('MomHudSynchronizer', 'file://{resources}/layout/hud/synchronizer.xml');
+UiToolkitAPI.RegisterHUDPanel2d('MomHudPowerupTimer', 'file://{resources}/layout/hud/powerup-timer.xml');
 
 UiToolkitAPI.RegisterPanel2d('ToastManager', 'file://{resources}/layout/util/toast-manager.xml');
 UiToolkitAPI.RegisterPanel2d('ToastGeneric', 'file://{resources}/layout/modals/toasts/generic.xml');
diff --git a/styles/hud/_index.scss b/styles/hud/_index.scss
index 9dac36db..a6b0a5c7 100644
--- a/styles/hud/_index.scss
+++ b/styles/hud/_index.scss
@@ -18,6 +18,7 @@
 @use 'jump-stats';
 @use 'key-press';
 @use 'map-info';
+@use 'powerup-timer';
 @use 'replay-controls';
 @use 'show-pos';
 @use 'spec-info';
diff --git a/styles/hud/powerup-timer.scss b/styles/hud/powerup-timer.scss
new file mode 100644
index 00000000..d0be9dd4
--- /dev/null
+++ b/styles/hud/powerup-timer.scss
@@ -0,0 +1,35 @@
+@use '../config' as *;
+@use '../abstract/mixin';
+
+.powerup-timer {
+	margin: 10px;
+	flow-children: down;
+	padding-left: 16px;
+
+	&__item {
+		flow-children: right;
+	}
+
+	&__label {
+		@include mixin.font-styles($use-header: true);
+		font-size: 64px;
+		padding-left: 16px;
+		horizontal-align: left;
+		vertical-align: center;
+		color: $white;
+	}
+
+	&__icon {
+		vertical-align: center;
+		height: 48px;
+		width: 48px;
+
+		&--haste {
+			wash-color: $orange;
+		}
+
+		&--damageboost {
+			wash-color: $light-blue;
+		}
+	}
+}

From d5a040497b6080b5388e9189c4126bcacb7b0a3b Mon Sep 17 00:00:00 2001
From: tsa96 <tom@trumpetdust.org>
Date: Mon, 15 Apr 2024 12:01:03 +0100
Subject: [PATCH 2/3] feat: RegisterHUDPanelForGamemode

:D
---
 scripts/util/register-event-for-gamemodes.ts |  52 ------
 scripts/util/register-for-gamemodes.ts       | 167 +++++++++++++++++++
 2 files changed, 167 insertions(+), 52 deletions(-)
 delete mode 100644 scripts/util/register-event-for-gamemodes.ts
 create mode 100644 scripts/util/register-for-gamemodes.ts

diff --git a/scripts/util/register-event-for-gamemodes.ts b/scripts/util/register-event-for-gamemodes.ts
deleted file mode 100644
index 6fd16651..00000000
--- a/scripts/util/register-event-for-gamemodes.ts
+++ /dev/null
@@ -1,52 +0,0 @@
-/**
- * Pass an event that should be only registered when playing certain gamemodes.
- *
- * This function will register/unregister the provided events handler when gamemodes change.
- *
- * It returns a function that will clean up both event handlers. It's unlikely we'll ever need to use it,
- * so usually you can just discard it.
- *
- * @example
- * ```ts
- * // In the static initializer block for some panel's class, call the onUpdate function on this class
- * // whenever the 'HudProcessInput' event is fired, ONLY if the current gamemode is Gamemode.DEFRAG.
- * 	static {
- * 		RegisterEventForGamemodes(
- * 			[GameMode.DEFRAG],
- * 			'HudProcessInput',
- * 			$.GetContextPanel(),
- * 			this.onUpdate.bind(this)
- * 		);
- * 	}
- * ```
- * @param gamemodes - Gamemodes to register the callback for. Handler is unregistered for any other modes.
- * @param event - Event name
- * @param context - Panel context
- * @param callbackFn - Event callback
- * @returns Cleanup function that unregisters both event handlers
- */
-function RegisterEventForGamemodes(
-	gamemodes: number[],
-	event: string,
-	context: string | Panel,
-	callbackFn: (...args: unknown[]) => void
-): () => void {
-	let innerHandle: number | undefined;
-	const outerHandle = $.RegisterForUnhandledEvent('LevelInitPostEntity', () => {
-		// @ts-expect-error - TODO: Typings for this API
-		if (!innerHandle && gamemodes.includes(GameModeAPI.GetCurrentGameMode())) {
-			innerHandle = $.RegisterEventHandler(event, context, callbackFn);
-		} else if (innerHandle) {
-			$.UnregisterEventHandler(event, context, innerHandle);
-			innerHandle = undefined;
-		}
-	});
-
-	return () => {
-		if (innerHandle) {
-			$.UnregisterEventHandler(event, context, innerHandle);
-		}
-
-		$.UnregisterForUnhandledEvent('LevelInitPostEntity', outerHandle);
-	};
-}
diff --git a/scripts/util/register-for-gamemodes.ts b/scripts/util/register-for-gamemodes.ts
new file mode 100644
index 00000000..7e5161ba
--- /dev/null
+++ b/scripts/util/register-for-gamemodes.ts
@@ -0,0 +1,167 @@
+/**
+ * Pass an event that should be only registered when playing certain gamemodes.
+ *
+ * This function will register/unregister the provided events handler when gamemodes change.
+ *
+ * It returns a function that will clean up both event handlers. It's unlikely we'll ever need to use it,
+ * so usually you can just discard it.
+ *
+ * @example
+ * ```ts
+ * // In the static initializer block for some panel's class, call the onUpdate function on this class
+ * // whenever the 'HudProcessInput' event is fired, ONLY if the current gamemode is Gamemode.DEFRAG.
+ * 	static {
+ * 		RegisterEventForGamemodes(
+ * 			[GameMode.DEFRAG],
+ * 			'HudProcessInput',
+ * 			$.GetContextPanel(),
+ * 			this.onUpdate.bind(this)
+ * 		);
+ * 	}
+ * ```
+ * @param gamemodes - Gamemodes to register the callback for. Handler is unregistered for any other modes.
+ * @param event - Event name
+ * @param context - Panel context
+ * @param callbackFn - Event callback
+ * @returns Cleanup function that unregisters both event handlers
+ */
+function RegisterEventForGamemodes(
+	gamemodes: number[],
+	event: string,
+	context: string | Panel,
+	callbackFn: (...args: unknown[]) => void
+): () => void {
+	let innerHandle: number | undefined;
+	const outerHandle = $.RegisterForUnhandledEvent('LevelInitPostEntity', () => {
+		// @ts-expect-error - TODO: Typings for this API
+		if (!innerHandle && gamemodes.includes(GameModeAPI.GetCurrentGameMode())) {
+			innerHandle = $.RegisterEventHandler(event, context, callbackFn);
+		} else if (innerHandle) {
+			$.UnregisterEventHandler(event, context, innerHandle);
+			innerHandle = undefined;
+		}
+	});
+
+	return () => {
+		if (innerHandle) {
+			$.UnregisterEventHandler(event, context, innerHandle);
+		}
+
+		$.UnregisterForUnhandledEvent('LevelInitPostEntity', outerHandle);
+	};
+}
+
+interface RegisterHUDPanelForGamemodeOptions {
+	context: object;
+	contextPanel: Panel;
+	gamemodes: number[];
+	onLoad?: Func;
+	handledEvents?: Array<{ event: string; callback: Func; contextPanel: Panel }>;
+	unhandledEvents?: Array<{ event: string; callback: Func }>;
+}
+
+/**
+ * Mark a panel as being only active in the given gamemodes.
+ *
+ * The panel will be set to `visible=true` in the given modes, and `false` in all others.
+ *
+ * Any events provided will be registered at `LevelInitPostEntity` when the given a map is launched in the provided
+ * modes, and unregistered in any other modes.
+ *
+ * An optional `onLoad` function will be called whenever a launched in the provided modes.
+ *
+ * You must provide the current JS context with `context`, and don't need to use `.bind(this)` on any functions you pass.
+ *
+ * @example
+ * // Simplest usage, only visible in SURF.
+ * class MyEpicSurfPanel {
+ *   static {
+ *     RegisterHUDPanelForGamemode({
+ *       gamemodes: [Gamemode.SURF],
+ *       context: this,
+ *       contextPanel: $.GetContextPanel()
+ *     })
+ *   }
+ * }
+ *
+ * // More advanced example.
+ * class MyFuckedUpBhopPanel {
+ *   static {
+ *     RegisterHUDPanelForGamemode({
+ *        gamemodes: [Gamemode.BHOP],
+ *        context: this,
+ *        contextPanel: $.GetContextPanel(),
+ *        onLoad: this.setup,
+ *        handledEvents: [{
+ *          event: 'HudProcessInput',
+ *          callback: this.onUpdate,
+ *          contextPanel: $.GetContextPanel()
+ *        }]
+ *     })
+ *   }
+ *
+ *   static setup() {
+ *     // ...
+ *   }
+ *
+ *   static onUpdate() {
+ *     // ...
+ *   }
+ * }
+ *
+ * @returns Cleanup function that unregisters all event handlers
+ */
+function RegisterHUDPanelForGamemode({
+	context,
+	contextPanel,
+	onLoad,
+	gamemodes,
+	handledEvents,
+	unhandledEvents
+}: RegisterHUDPanelForGamemodeOptions): () => void {
+	if (!(gamemodes?.length > 0)) {
+		throw new Error('RegisterHUDPanelForGamemode: no gamemode provided');
+	}
+
+	let handles: Array<{ event: string; handle: number; contextPanel?: Panel }>;
+
+	const unregister = () =>
+		(handles ?? []).forEach(({ event, handle, contextPanel }) =>
+			contextPanel === undefined
+				? $.UnregisterForUnhandledEvent(event, handle)
+				: $.UnregisterEventHandler(event, contextPanel, handle)
+		);
+
+	const handle = $.RegisterForUnhandledEvent('LevelInitPostEntity', () => {
+		unregister();
+		handles = [];
+
+		// @ts-expect-error - TODO: Typings for this API
+		if (gamemodes.includes(GameModeAPI.GetCurrentGameMode())) {
+			contextPanel.enabled = true;
+			onLoad?.call(context);
+
+			for (const { event, callback } of unhandledEvents ?? []) {
+				handles.push({
+					event,
+					handle: $.RegisterForUnhandledEvent(event, callback.bind(context))
+				});
+			}
+
+			for (const { event, contextPanel, callback } of handledEvents ?? []) {
+				handles.push({
+					event,
+					contextPanel,
+					handle: $.RegisterEventHandler(event, contextPanel, callback.bind(context))
+				});
+			}
+		} else {
+			contextPanel.enabled = false;
+		}
+	});
+
+	return () => {
+		unregister();
+		$.UnregisterForUnhandledEvent('LevelInitPostEntity', handle);
+	};
+}

From 3865afa1ac652264ac18db7907eaa563dd2b77d0 Mon Sep 17 00:00:00 2001
From: tsa96 <tom@trumpetdust.org>
Date: Mon, 15 Apr 2024 13:57:32 +0100
Subject: [PATCH 3/3] refactor: use RegisterHUDPanelForGamemode in defrag
 powerup panel

---
 layout/hud/powerup-timer.xml | 2 +-
 scripts/hud/powerup-timer.ts | 7 ++++++-
 2 files changed, 7 insertions(+), 2 deletions(-)

diff --git a/layout/hud/powerup-timer.xml b/layout/hud/powerup-timer.xml
index 88a85f78..2ce7320e 100644
--- a/layout/hud/powerup-timer.xml
+++ b/layout/hud/powerup-timer.xml
@@ -4,7 +4,7 @@
 	</styles>
 	<scripts>
 		<include src="file://{scripts}/common/gamemodes.js" />
-		<include src="file://{scripts}/util/register-event-for-gamemodes.js" />
+		<include src="file://{scripts}/util/register-for-gamemodes.js" />
 		<include src="file://{scripts}/hud/powerup-timer.js" />
 	</scripts>
 
diff --git a/scripts/hud/powerup-timer.ts b/scripts/hud/powerup-timer.ts
index 8b53c7c3..a54458b8 100644
--- a/scripts/hud/powerup-timer.ts
+++ b/scripts/hud/powerup-timer.ts
@@ -33,6 +33,11 @@ class PowerupTimer {
 	}
 
 	static {
-		RegisterEventForGamemodes([GameMode.DEFRAG], 'HudProcessInput', $.GetContextPanel(), this.onUpdate.bind(this));
+		RegisterHUDPanelForGamemode({
+			gamemodes: [GameMode.DEFRAG],
+			context: this,
+			contextPanel: $.GetContextPanel(),
+			handledEvents: [{ event: 'HudProcessInput', contextPanel: $.GetContextPanel(), callback: this.onUpdate }]
+		});
 	}
 }