Debugge dein Spiel mit Debug-Zeichnen

Um das Debugging deines Spiels zu erleichtern, kannst du bestimmte Spieldaten zu Testzwecken anzeigen, während du diese Informationen vor dem Spieler verbirgst. Eine Möglichkeit, dies zu erreichen, ist die Protokollierung, aber du kannst einige Spieldaten auf eine visuellere Weise mit der Debug-Zeichnen-API anzeigen.

Mit der Debug-Zeichen-API kannst du einfache Formen zeichnen und ihre Position, Größe, Farbe und die Zeit, die sie auf dem Bildschirm erscheinen, festlegen. Du kannst z.B. die Sichtweite eines NPCs visualisieren oder die Entfernung, aus der Audio vom Ausgangspunkt aus zu hören ist. Mit der Box-Debug-Form kannst du eine Box mit Abmessungen und einer Position zeichnen, die zu einem beliebigen Volumen passt, selbst wenn dieses Volumen in deinem Spiel unsichtbar ist. Dies kann helfen, die Platzierung von Volumen mit bestimmten Effekten zu ermitteln.

Die Pfeil-Debug-Form, die von der Fläche eines NPCs bis zur Grenze seines Sichtbarkeitsbereichs gezeichnet wird, kann verwendet werden, um die perfekte Platzierung für Wachen zu entwerfen.

Aktivieren des Verse-Debug-Zeichnens

Als Erstes solltest du sicherstellen, dass du die von dir gezeichneten Formen sehen kannst.

1. Wähle UEFN-Outliner die Insel-Einstellungen aus.

2. Gib in der Suchleiste des Details-Panels debug ein. Dadurch werden die Ergebnisse nach der Kategorie Benutzeroptionen - Debug gefiltert.

3. Klicke auf Debuggen und dann auf Verse-Debug-Draw, um Debug-Funktionen und Verse-Debug-Draw zu aktivieren.

Verse Debug-Zeichnen wird nur während einer Spielsitzung von UEFN aktiv sein. Die Funktion wird pro Nutzer aktiviert, d.h. nur diejenigen, die Debug und Verse Debug-Zeichnen aktiviert haben, sehen Debug-Formen. Debug-Formen werden nicht im UEFN-Viewport oder auf einer veröffentlichten Insel angezeigt, selbst wenn diese Option in den Inseleinstellungen aktiviert ist.

Zeichnen deiner ersten Debug-Form

So zeichnest du die erste Form mit der Debug-Zeichnen-API:

1. Füge diesen Importausdruck zu deiner Verse-Datei hinzu.

   Verse

   using { /UnrealEngine.com/Temporary/Diagnostics }

   Copy full snippet(1 line long)

2. Erstelle einen Kanal, indem du eine Subklasse deklarierst, die vom Typ debug_draw_channel erbt. Kanäle dienen dazu, zusammengehörige Formen zu gruppieren. Sie sind optional, aber es ist eine gute Praxis, sie zu verwenden. Es gibt Funktionen in der Debug-Zeichnen-API, mit denen du viele Formen auf einmal anzeigen, ausblenden oder löschen kannst, aber das Anzeigen und Ausblenden funktioniert nur auf Kanallevel.

   Verse

   my_debug_draw := class(debug_draw_channel) {}

   Copy full snippet(1 line long)

3. Deklariere eine neue Konstante vom Typ debug_draw. Mit diesem Objekt wirst du die Methoden zum Zeichnen von Formen aufrufen. Dieses Beispiel zeigt die Verwendung des Kanal-Parameters (im vorherigen Schritt erstellt), dies ist jedoch optional.

   Verse

   DebugDraw:debug_draw = debug_draw{Channel := my_debug_draw}

   Copy full snippet(1 line long)

4. Rufe die Methode DrawSphere auf. In diesem Beispiel werden zwei Parameter verwendet.

• Center:= vector3{Z:= 150.0}: Dies ist ein erforderlicher Parameter vom Typ vector3, der die Position des Kugelzentrums bestimmt. In diesem Beispiel verwendest du den Constructor des Typs vector3, um einen Literal-Wert zu erstellen. Dadurch wird das Zentrum der Kugel auf die Position 0,0, 0,0, 150,0 festgelegt.

• ?DrawDurationPolicy:= debug_draw_duration_policy.Persistent: Dieser Parameter ist optional, aber sein Standardwert lässt die Kugel nach einigen Sekunden verschwinden, also setze ihn auf die Richtlinie Dauerhaft. Das bedeutet, dass die Kugel auf der Insel sichtbar bleibt, bis sie ausgeblendet oder durch anderen Code gelöscht wird.

  Verse

  DebugDraw.DrawSphere(Center := vector3{Z:=150.0}, ?DrawDurationPolicy := debug_draw_duration_policy.Persistent)

  Copy full snippet(1 line long)

Nachdem du deinen Verse-Code kompiliert und eine Sitzung gestartet hast, solltest du eine Kugel an der vom Parameter Center bestimmten Position sehen.

Formen

Mit der Debug-Zeichnen-API kannst du verschiedene Formen zeichnen, die als einfache Wireframes in einer laufenden UEFN-Sitzung erscheinen. Jede Form ist in verschiedenen Szenarien nützlich. In den folgenden Abschnitten werden die Methoden zum Zeichnen der einzelnen Formen und die Parameter erläutert, die für jede Methode gelten. In einem späteren Abschnitt werden die Parameter erläutert, die für alle Methoden gleich sind. Jedes Codebeispiel in diesem Abschnitt setzt voraus, dass du den Code aus "Deine erstes Debug-Form zeichnen" zu deiner Verse-Datei hinzugefügt hast.

Box

Verwende die Methode DrawBox(), um einen Würfel zu zeichnen.

DebugDraw.DrawBox(vector3{Z:=150.0}, rotation{}, ?DrawDurationPolicy := debug_draw_duration_policy.Persistent)

Kapsel

Verwende die Methode DrawCapsule(), um eine Kapsel zu zeichnen. Eine Kapsel besteht aus einem Zylinder mit einer Kugelhälfte an beiden Enden.

DebugDraw.DrawCapsule(vector3{Z:=200.0}, rotation{}, ?DrawDurationPolicy := debug_draw_duration_policy.Persistent)

Kugel

Verwende die Methode DrawSphere(), um eine Kugel zu zeichnen.

DebugDraw.DrawSphere(vector3{Z:=150.0}, ?DrawDurationPolicy := debug_draw_duration_policy.Persistent)

Kegel

Verwende die Methode DrawCone(), um einen Kegel zu zeichnen.

DebugDraw.DrawCone(vector3{Z:=150.0}, vector3{Z:=-1.0}, ?DrawDurationPolicy := debug_draw_duration_policy.Persistent)

Zylinder

Verwende die Methode DrawCylinder(), um einen Zylinder zu zeichnen.

DebugDraw.DrawCylinder(vector3{Z:=100.0}, vector3{Z:=200.0}, ?DrawDurationPolicy := debug_draw_duration_policy.Persistent)

Linie

Verwende die Methode DrawLine(), um eine Linie zu zeichnen.

DebugDraw.DrawLine(vector3{Z:=100.0}, vector3{Z:=200.0}, ?DrawDurationPolicy := debug_draw_duration_policy.Persistent)

Pfeil

Verwende die Methode DrawArrow(), um einen Pfeil zu zeichnen.

DebugDraw.DrawArrow(vector3{Z:=100.0}, vector3{Z:=200.0}, ?DrawDurationPolicy := debug_draw_duration_policy.Persistent)

Punkt

Verwende die Methode DrawPoint(), um einen Punkt zu zeichnen.

DebugDraw.DrawPoint(vector3{Z:=200.0}, ?Thickness:= 10.0, ?DrawDurationPolicy := debug_draw_duration_policy.Persistent)

Allgemeine Parameter

Diese Parameter gelten für alle Methoden, die Formen zeichnen. Sie sind auch alle optional und müssen beim Aufruf einer Methode nicht als Argumente angegeben werden. Wenn du dich dafür entscheidest, sie einzubeziehen, achte darauf, dass du den Parameternamen mit einem vorangestellten ? verwendest. Weitere Informationen über benannte und optionale Argumente findest du unter Aufrufen von Funktionen in Funktionen.

Color

Lege die Farbe von Formen mit dem Parameter Color fest. Die Werte müssen vom Typ color sein. Die Liste der gültigen Farben ist im Modul NamedColors zu finden. Achte darauf, dass der Importausdruck für das Modul Colors am Anfang deiner Verse-Datei steht. Nachfolgend siehst du ein Beispiel für das Setzen eines Punktes auf eine andere Farbe.

DebugDraw.DrawPoint(Position := vector3{Z:= 200.0}, ?Thickness := 20.0, ?Color := NamedColors.MediumSeaGreen)

DrawDurationPolicy

DrawDurationPolicy bestimmt, wie lange eine Debug-Form auf dem Bildschirm bleibt. Es gibt drei mögliche Werte.

• SingleFrame: Die Form bleibt für die Dauer eines einzelnen Frame auf dem Bildschirm. Diese Richtlinie kann nützlich sein, wenn du eine Form häufig neu zeichnen möchtest.

• FiniteDuration: Diese Richtlinie wird zusammen mit dem Parameter Duration verwendet, um eine Form für eine bestimmte Anzahl von Sekunden anzuzeigen.

• Persistent: Mit der Richtlinie „Persistent“ bleibt die Form auf dem Bildschirm, bis sie ausgeblendet oder durch anderen Code gelöscht wird.

Duration

Der Parameter Duration wird mit der Richtlinie FiniteDuration verwendet, um eine Form für eine bestimmte Anzahl von Sekunden anzuzeigen. Im Folgenden findest du ein Beispiel für Code, der eine Kugel zeichnet, die 30 Sekunden lang angezeigt wird.

DebugDraw.DrawSphere(vector3{}, ?DrawDurationPolicy := debug_draw_duration_policy.FiniteDuration, ?Duration := 30.0)

Thickness

Der Parameter Thickness bestimmt die Dicke der Linien, aus denen die einzelnen Debug-Formen bestehen. Im Fall von DrawPoint() wird die Dicke des einzelnen Punktes festgelegt.

Channels

Mithilfe von Kanälen kannst du zusammengehörige Formen gruppieren und dann alle Formen in einem Kanal gleichzeitig ausblenden, einblenden oder löschen.

Um einen Kanal zu erstellen, verwende den Parameter Channel, wenn du eine Instanz von debug_draw deklarierst.

DebugDraw:debug_draw = debug_draw{Channel := debug_draw_defaults}

Jetzt kann jede Form, die du mit der DebugDraw-Instanz zeichnest, mit einer einzigen Methode versteckt, gezeigt oder gelöscht werden. Wenn du zum Beispiel einen Punkt, eine Kugel und einen Pfeil mit der DebugDraw-Instanz zeichnest, kannst du sie für einige Zeit ausblenden, dann wieder einblenden und schließlich löschen, wenn sie nicht mehr benötigt werden.

# Point
DebugDraw.DrawPoint(vector3{Z := 200.0}, ?Thickness:= 50.0, ?DrawDurationPolicy:= debug_draw_duration_policy.Persistent)

# Sphere
DebugDraw.DrawSphere(vector3{Z := 200.0}, ?DrawDurationPolicy:= debug_draw_duration_policy.Persistent)

# Arrow
DebugDraw.DrawArrow(vector3{Z := 200.0}, vector3{Z := 400.0}, ?DrawDurationPolicy:= debug_draw_duration_policy.Persistent)

Sleep(5.0)

Standard-Parameterwerte

Beispiele

Visualisieren der Reichweite eines Audioplayer-Geräts

Das Audioplayer-Gerät verfügt über eine Einstellung zur Visualisierung der Dämpfung. Diese Visualisierung kannst du aber nur im Bearbeitungsmodus sehen. Befolge diese Schritte, um zu lernen, wie du die Dämpfungsvisualisierung in einer Spielsitzung nachstellen kannst.

1. Ziehe ein Audioplayer-Gerät in dein Level. Stelle sicher, dass im Details-Panel Dämpfungsvisualisierungen aktivieren markiert ist. Auf diese Weise kannst du überprüfen, ob du das Bildmaterial mit den Debug-Formen korrekt nachbildest.

2. Erstelle in deiner Verse-Datei eine neue debug_draw-Instanz mit dem Namen DebugDrawAudio. Gib ihr einen Kanal mit dem Namen debug_draw_audio.

   Verse

   DebugDrawAudio:debug_draw = debug_draw{Channel := debug_draw_audio}

   Copy full snippet(1 line long)

3. Füge zwei @editable-Konstanten vom Typ float hinzu. Benenne sie DebugAttenuationMinDistance und DebugAttenuationFalloffDistance. Dies sind die beiden Radien der Kugeln, die gezeichnet werden, um die Dämpfung des Audioplayers zu visualisieren.

   Verse

   @editable
        DebugAttenuationMinDistance:float = 100.0
   		
        @editable
        DebugAttenuationFalloffDistance:float = 100.0

   Copy full snippet(5 lines long)

4. Füge ein weiteres @editable hinzu, um das Audioplayer-Gerät darzustellen. Benenne es AudioPlayerDevice.

   Verse

   @editable
        AudioPlayerDevice:audio_player_device = audio_player_device{}

   Copy full snippet(2 lines long)

5. Deklariere eine Funktion mit dem Namen DrawAudioDeviceRange() und gib ihr zwei Parameter vom Typ float: AttenuationMinDistance und AttenuationFalloffDistance.

   Verse

   DrawAudioDeviceRange(AttenuationMinDistance:float, AttenuationFalloffDistance:float):void =

   Copy full snippet(1 line long)

6. Hole in der neuen Funktion das Transform-Objekt des Audioplayer-Geräts.

   Verse

   AudioPlayerDeviceTransform:= AudioPlayerDevice.GetTransform()

   Copy full snippet(1 line long)

7. Zeichne mit der Funktion DrawSphere aus der Debug-Zeichnen-API zwei Kugeln, die den Dämpfungsminimalabstand und den Dämpfungs-Falloff-Abstand darstellen. Der Radius im zweiten DrawSphere-Aufruf muss auf die Summe von AttenuationMinDistance und AttenuationFalloffDistance festgelegt werden, da die Dämpfung nur außerhalb des Radius des Dämpfungsminimalabstands beginnt.

   Verse

   DebugDrawAudio.DrawSphere(
            AudioPlayerDeviceTransform.Translation,
            ?Radius:= AttenuationMinDistance,
            ?DrawDurationPolicy:= debug_draw_duration_policy.Persistent)
        DebugDrawAudio.DrawSphere(
            AudioPlayerDeviceTransform.Translation,
            ?Radius:= AttenuationMinDistance + AttenuationFalloffDistance,
            ?DrawDurationPolicy:= debug_draw_duration_policy.Persistent)

   Copy full snippet(8 lines long)

8. Rufe in der Funktion OnBegin() deiner Verse-Datei die Funktion DrawAudioDeviceRange() auf.

   Verse

   OnBegin<override>()<suspends>:void=
        DrawAudioDeviceRange(DebugAttenuationMinDistance, DebugAttenuationFalloffDistance)

   Copy full snippet(2 lines long)

9. Erstelle deinen Verse-Code. Stelle sicher, dass du die Werte für DebugAttenuationMinDistance und DebugAttenuationFalloffDistance im Details-Panel deines Verse-Geräts festlegst. Diese Werte sollten den Werten Abschwächung minimale Entfernung und AttenuationFalloffDistance für dein Audiowiedergabegerät multipliziert mit 100 entsprechen.

   Das Audioplayer-Gerät verwendet Meter für Dämpfungsminimalabstand und Dämpfungs-Falloff-Abstand. Da die Debug-Zeichnen-API mit Zentimetern arbeitet, musst du die Werte konvertieren.

10. Vollständiges Script

    Verse

    using { /Fortnite.com/Devices }
         using { /Fortnite.com/Characters }
         using { /Fortnite.com/Playspaces }
         using { /UnrealEngine.com/Temporary/Diagnostics }
         using { /UnrealEngine.com/Temporary/SpatialMath }
    		
         debug_audio_device := class(creative_device):
    		
             @editable
             AudioPlayerDevice:audio_player_device = audio_player_device{}
    
    Expand code Copy full snippet(33 lines long)