From b31052879e7601dbfea4c7fb53b94119c7bbf5c6 Mon Sep 17 00:00:00 2001
From: querns <33518699+querns@users.noreply.github.com>
Date: Wed, 13 Sep 2023 10:03:17 -0500
Subject: Adds Metrics Transmitter Cover and Advanced GT Sensor Card for
 Information Panels (#2289)

* Adds several UI elements to multiblock drills

* Adds metrics transmitter cover and associated sensor card

* Fixes item icons and item name

* Adds tooltips for adv. sensor card and metrics panel, fixes card/overlay icons, adds recipe for metrics cover

* Refactor cover tab sync to send much smaller ISerializable payloads

* Remove unused variable

* Additional master merge cleanup

* Adds interface for custom metrics export, adds oil drill support

* Adds support for metrics covers retaining attached machine name for tooltip, metrics

* * Adds discrete coordinates to Metrics Cover data
* Adds machine to advanced sensor card tooltip
* Adds cycle time and minimum energy hatch tier to multiblock ore drill tooltips
* Moves many tooltip strings to i10n

* Remove old GT_DisabledWhileActiveButton.java file that crept in during a messy merge

* Spotless

* Improve oil and ore drill metrics, more i18n

* Addresses PR review concerns, adds more situations for self-destructing sensor cards

* Remediates further PR concerns
---
 .../metatileentity/IMetricsExporter.java           | 28 ++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 src/main/java/gregtech/api/interfaces/metatileentity/IMetricsExporter.java

(limited to 'src/main/java/gregtech/api/interfaces/metatileentity')

diff --git a/src/main/java/gregtech/api/interfaces/metatileentity/IMetricsExporter.java b/src/main/java/gregtech/api/interfaces/metatileentity/IMetricsExporter.java
new file mode 100644
index 0000000000..f97cd79ed6
--- /dev/null
+++ b/src/main/java/gregtech/api/interfaces/metatileentity/IMetricsExporter.java
@@ -0,0 +1,28 @@
+package gregtech.api.interfaces.metatileentity;
+
+import java.util.List;
+
+import org.jetbrains.annotations.NotNull;
+
+import gregtech.api.metatileentity.BaseMetaTileEntity;
+
+/**
+ * Metrics Transmitter covers look for this interface for retrieving custom metrics for a machine. If this interface is
+ * not present on the machine housing the cover, it will use {@link BaseMetaTileEntity#getInfoData()} to retrieve info
+ * instead.
+ */
+public interface IMetricsExporter {
+
+    /**
+     * Attached metrics covers will call this method to receive reported metrics.
+     * <p>
+     * When reporting metrics, try to keep the number of entries small, and ordering of entries consistent. Advanced
+     * Sensor Cards allow the user to selectively turn off individual lines using the panel's UI, and doing so is
+     * aggravated by a metrics set that is inconsistent and/or large.
+     *
+     * @return A list of strings to print on the information panel the advanced sensor card is utilizing. Each item in
+     *         the list will be printed on its own line.
+     */
+    @NotNull
+    List<String> reportMetrics();
+}
-- 
cgit