Auf dem HUD rendern 1.21.4

Lerne, wie man die Fabric Hud API zum Rendern auf dem HUD verwendet.

WARNING

Diese Seite ist für die Version 1.21.4 geschrieben. Dokumentationen für ältere Versionen sind möglicherweise unvollständig.

Wir haben bereits auf der Seite Grundlegende Rendering-Konzepte und Den Zeichenkontext verwenden kurz über das Rendern von Dingen auf dem Hud gesprochen, daher beschränken wir uns auf dieser Seite auf die Hud API und den Parameter DeltaTracker.

HudRenderCallback

WARNING

Zuvor stellte Fabric den HudRenderCallback zur Verfügung, um das HUD zu rendern. Aufgrund von Änderungen am HUD-Rendering wurde dieses Event extrem eingeschränkt und ist seit Fabric API 0.116 veraltet. Von der Verwendung wird dringend abgeraten.

HudLayerRegistrationCallback

Fabric bietet die Hud-API zum Rendern und Überlagern von Elementen auf dem HUD.

Zu Beginn müssen wir einen Listener für den HudLayerRegistrationCallback registrieren, der deine Ebenen registriert. Jede Ebene ist ein IdentifiedLayer, der ein Vanilla LayeredDrawer.Layer mit einem angehängten ResourceLocation ist. Eine LayeredDrawer.Layer-Instanz ist normalerweise ein Lambda, das einen GuiGraphics und eine DeltaTracker-Instanz als Parameter nimmt. Siehe HudLayerRegistrationCallback und die zugehörigen Javadocs für weitere Einzelheiten zur Verwendung der API.

Der Zeichenkontext kann verwendet werden, um auf die verschiedenen Rendering-Utilities zuzugreifen, die vom Spiel zur Verfügung gestellt werden, und um auf den Rohmatrix-Stapel zuzugreifen. Du solltest dir die Seite Den Zeichenkontext verwenden ansehen, um mehr über den Zeichenkontext zu erfahren.

Renderer Tickzähler

Die DeltaTracker Klasse erlaubt es dir, den aktuellen tickDelta Wert abzurufen. tickDelta ist der "Fortschritt" zwischen dem letzten Spieltick und dem nächsten Spieltick.

Wenn wir zum Beispiel von einem Szenario mit 200 FPS ausgehen, führt das Spiel ungefähr alle 10 Bilder einen neuen Tick aus. In jedem Frame gibt tickDelta an, wie weit der letzte Tick vom nächsten entfernt ist. Bei mehr als 11 Bildern könntest du folgendes sehen:

Frame	tickDelta
1	1: Neuer Tick
2	1/10 = 0.1
3	2/10 = 0.2
4	3/10 = 0.3
5	4/10 = 0.4
6	5/10 = 0.5
7	6/10 = 0.6
8	7/10 = 0.7
9	8/10 = 0.8
10	9/10 = 0.9
11	1: Neuer Tick

Praktischerweise, solltest du tickDelta nur verwenden, wenn deine Animationen von Minecrafts Ticks abhängen. Für zeitbasierte Animationen verwende Util.getMillis(), das die Zeit in der realen Welt misst.

Du kannst tickDelta mit der Funktion renderTickCounter.gameTimeDeltaPartialTick(false); abrufen, wobei der boolesche Parameter ignoreFreeze ist, was dir im Wesentlichen erlaubt, zu ignorieren, wenn Spieler den Befehl /tick freeze verwenden.

In diesem Beispiel werden wir Util.getMillis() verwenden, um die Farbe eines Quadrats, das auf dem HUD gerendert wird, linear zu interpolieren.

public class HudRenderingEntrypoint implements ClientModInitializer {
	private static final ResourceLocation EXAMPLE_LAYER = ResourceLocation.fromNamespaceAndPath(FabricDocsReference.MOD_ID, "hud-example-layer");

	@Override
	public void onInitializeClient() {
		// Attach our rendering code to before the chat hud layer. Our layer will render right before the chat. The API will take care of z spacing and automatically add 200 after every layer.
		HudLayerRegistrationCallback.EVENT.register(layeredDrawer -> layeredDrawer.attachLayerBefore(IdentifiedLayer.CHAT, EXAMPLE_LAYER, HudRenderingEntrypoint::render));
	}

	private static void render(GuiGraphics context, DeltaTracker tickCounter) {
		int color = 0xFFFF0000; // Red
		int targetColor = 0xFF00FF00; // Green

		// You can use the Util.getMillis() function to get the current time in milliseconds.
		// Divide by 1000 to get seconds.
		double currentTime = Util.getMillis() / 1000.0;

		// "lerp" simply means "linear interpolation", which is a fancy way of saying "blend".
		float lerpedAmount = Mth.abs(Mth.sin((float) currentTime));
		int lerpedColor = ARGB.lerp(lerpedAmount, color, targetColor);

		// Draw a square with the lerped color.
		// x1, x2, y1, y2, z, color
		context.fill(0, 0, 10, 10, 0, lerpedColor);
	}
}

Wieso versuchst du nicht, tickDelta zu verwenden und zu sehen, was mit der Animation passiert, wenn du den Befehl /tick freeze ausführst? Du solltest sehen, wie die Animation an Ort und Stelle einfriert, wenn tickDelta konstant wird (vorausgesetzt, du hast false als Parameter an DeltaTracker#gameTimeDeltaPartialTick übergeben)