Eseguire il debug del gioco tramite lo strumento Disegno di debug

Per semplificare il processo di debug del tuo gioco, puoi visualizzare alcuni dati di gioco a scopo di test, nascondendo però queste informazioni al giocatore. Un modo per farlo è la registrazione, ma puoi anche visualizzare alcuni dati di gioco in maniera più visuale utilizzando l'API Disegno di debug.

L'API Disegno di debug ti permette di disegnare forme di base definendone la posizione, le dimensioni, il colore e la durata della visualizzazione sullo schermo. Ad esempio, potresti visualizzare il raggio di visibilità di un PNG o la distanza a cui l'audio può essere ascoltato dal suo punto di origine. Grazie alla forma di debug dei riquadri, puoi disegnare un riquadro le cui dimensioni e la cui posizione corrispondono a qualsiasi volume, anche se questo volume è invisibile nel gioco. Questo può aiutarti a determinare il posizionamento dei volumi con determinati effetti.

Puoi utilizzare la freccia di debug, che va dal volto di un PNG fino al limite del suo raggio di visibilità, per definire la posizione ideale delle guardie.

Abilita il tracciamento debug di Verse

Il primo passo è assicurarsi di visualizzare correttamente le forme da disegnare.

1. Seleziona Impostazioni isola nell'Outliner di UEFN.

2. Nella barra di ricerca del pannello Dettagli, digita debug. In questo modo filtrerai i risultati della categoria Opzioni utente - Debug.

3. Fai clic su Debug, quindi su Disegno di debug Verse per attivare le funzionalità di disegno e l'opzione Disegno di debug Verse.

L'opzione Disegno di debug Verse è attiva solo durante una sessione di gioco di UEFN. È abilitata su base individuale, il che significa che solo gli utenti che hanno abilitato le opzioni Debug e Disegno di debug Verse possono vedere le forme di debug. Le forme di debug non vengono visualizzate nella viewport di UEFN o in un'isola pubblicata, anche se questa opzione è abilitata in Impostazioni isola.

Disegnare una prima forma di debug

Per disegnare la tua prima forma con l'API Disegno di debug, segui questi passaggi:

1. Aggiungi questa espressione di importazione al tuo file Verse.

   Verse

   using { /UnrealEngine.com/Temporary/Diagnostics }

   Copy full snippet(1 line long)

2. Crea un canale dichiarando una sottoclasse che eredita dal tipo debug_draw_channel. I canali servono per raggruppare forme correlate. Pur essendo facoltativi, ti consigliamo sempre di utilizzarli. L'API Disegno di debug include alcune funzioni che si possono utilizzare per mostrare, nascondere o eliminare diverse forme contemporaneamente, ma le opzioni di visualizzazione e non visualizzazione funzionano solo a livello di canale.

   Verse

   my_debug_draw := class(debug_draw_channel) {}

   Copy full snippet(1 line long)

3. Dichiara una nuova costante di tipo debug_draw. Si tratta dell'oggetto che utilizzi per richiamare i metodi di disegno delle forme. In questo esempio, spieghiamo come utilizzare il parametro Canale (creato nel passaggio precedente), anche se facoltativo.

   Verse

   DebugDraw:debug_draw = debug_draw{Channel := my_debug_draw}

   Copy full snippet(1 line long)

4. Chiama il metodo DrawSphere. In questo esempio, vengono utilizzati due parametri.

• Center:= vector3{Z:= 150.0}: si tratta di un parametro obbligatorio di tipo vector3 che determina la posizione del centro della sfera. In questo esempio utilizzi il costruttore del tipo vector3 per creare un valore letterale. Tale costruttore porta il centro della sfera alla posizione 0.0, 0.0, 150.0.

• ?DrawDurationPolicy:= debug_draw_duration_policy.Persistent: questo parametro è facoltativo, ma il suo valore predefinito fa sì che la sfera scompaia dopo pochi secondi, quindi è opportuno assegnargli il criterio Persistente. Ciò significa che la sfera rimane visibile sull'isola fino a quando non viene nascosta o cancellata da un altro codice.

  Verse

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

  Copy full snippet(1 line long)

Dopo aver compilato il codice Verse e lanciato una sessione, dovresti visualizzare una sfera nella posizione definita dal parametro Center.

Forme

Utilizzando l'API Disegno di debug, puoi disegnare diverse forme che appaiono come semplici reticoli in una sessione UEFN in corso. Ogni forma è utile in scenari diversi. Nelle sezioni seguenti descriviamo i metodi utilizzati per disegnare ciascuna forma e i parametri specifici di ciascun metodo. In una sezione più avanti spiegheremo invece i parametri comuni a tutti i metodi. Per ogni esempio di codice di questa sezione, si presuppone che tu abbia aggiunto il codice di Disegna la tua prima forma di debug al tuo file Verse.

Riquadro

Utilizza il metodo DrawBox() per disegnare un riquadro.

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

Capsula

Utilizza il metodo DrawCapsule() per disegnare una capsula. Una capsula è costituita da un cilindro che presenta una mezza sfera a ogni estremità.

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

Sfera

Utilizza il metodo DrawSphere() per disegnare una sfera.

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

Cono

Utilizza il metodo DrawCone() per disegnare un cono.

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

Cilindro

Utilizza il metodo DrawCylinder() per disegnare un cilindro.

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

Line

Utilizza il metodo DrawLine() per disegnare una linea.

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

Freccia

Utilizza il metodo DrawArrow() per disegnare una freccia.

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

Punto

Utilizza il metodo DrawPoint() per disegnare un punto.

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

Parametri comuni

Questi parametri sono comuni a tutti i metodi di disegno delle forme. Inoltre, sono tutti opzionali e non devono essere inclusi come argomenti quando si chiama un metodo. Se decidi di includerli, assicurati di utilizzare il nome dei parametri preceduto da un ?. Vedi la sezione Calling Functions in Functions per maggiori informazioni sugli argomenti nominati e opzionali.

Colore

Imposta il colore delle forme utilizzando il parametro Color. I valori devono essere del tipo color. L'elenco dei colori validi si trova nel modulo NamedColors. Assicurati di inserire l'espressione di importazione dal modulo Colors all'inizio del tuo file Verse. Di seguito è riportato un esempio di impostazione di un punto a un colore diverso.

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

DrawDurationPolicy

DrawDurationPolicy determina la durata della visualizzazione di un modulo di debug sullo schermo. Sono disponibili tre diversi valori.

• SingleFrame : la forma rimane sullo schermo per la durata di un singolo frame. Questo criterio può essere utile quando si desidera ridisegnare una forma frequentemente.

• FiniteDuration: questo criterio è utilizzato con il parametro Duration per visualizzare una forma per un certo numero di secondi.

• Persistent: con il criterio Persistent, la forma rimane visibile sullo schermo fino a quando non viene nascosta o cancellata da altro codice.

Durata

Il parametro Duration è utilizzato con il criterio FiniteDuration per visualizzare una forma per un certo numero di secondi. Di seguito è riportato un esempio di codice che disegna una sfera che viene visualizzata per 30 secondi.

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

Spessore

Il parametro Thickness imposta lo spessore delle linee che compongono ogni forma di debug. Nel caso di DrawPoint(), imposta lo spessore del singolo punto.

Canali

Puoi utilizzare i canali per raggruppare più forme correlate e quindi nasconderle, mostrale e cancellarle in una sola volta.

Per creare un canale, utilizza il parametro Channel quando dichiari un'istanza di debug_draw.

DebugDraw:debug_draw = debug_draw{Channel := debug_draw_defaults}

Ora qualsiasi forma disegnata utilizzando l'istanza DebugDraw può essere nascosta, mostrata o cancellata con un unico metodo. Ad esempio, se disegni un punto, una sfera e una freccia con l'istanza DebugDraw, puoi nasconderli per un po', visualizzarli di nuovo e poi cancellarli quando non sono più necessari.

# 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)

Valori di parametro predefiniti

Esempi

Visualizza l'intervallo di un dispositivo Riproduttore audio

Il dispositivo Riproduttore audio ha un'impostazione per visualizzare il suo livello di attenuazione. Tuttavia, puoi ottenere questo tipo di visualizzazione soltanto durante la modalità di modifica. Segui questi passaggi per scoprire come ricreare gli effetti visivi di attenuazione in una sessione di gioco.

1. Trascina il dispositivo Riproduttore audio nel tuo livello. Nel pannello Dettagli, assicurati che l'opzione Abilita effetti visivi di attenuazione sia selezionata. Questa opzione ti permette di verificare che gli effetti visivi siano riprodotti correttamente con le forme di debug.

2. Nel tuo file Verse, crea una nuova istanza debug_draw chiamata DebugDrawAudio. Attribuiscile un canale chiamato debug_draw_audio.

   Verse

   DebugDrawAudio:debug_draw = debug_draw{Channel := debug_draw_audio}

   Copy full snippet(1 line long)

3. Aggiungi due costanti @editable di tipo float. Nominale DebugAttenuationMinDistance e DebugAttenuationFalloffDistance. Rappresentano i due raggi delle sfere disegnate per visualizzare l'attenuazione del Riproduttore audio.

   Verse

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

   Copy full snippet(5 lines long)

4. Aggiungi un'altra costante @editable per rappresentare il dispositivo Riproduttore audio. Denominala AudioPlayerDevice.

   Verse

   @editable
        AudioPlayerDevice:audio_player_device = audio_player_device{}

   Copy full snippet(2 lines long)

5. Dichiara una funzione chiamata DrawAudioDeviceRange() e assegnale due parametri di tipo float: AttenuationMinDistance e AttenuationFalloffDistance.

   Verse

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

   Copy full snippet(1 line long)

6. Nella nuova funzione, ottieni l'oggetto Trasformazione del dispositivo Riproduttore audio.

   Verse

   AudioPlayerDeviceTransform:= AudioPlayerDevice.GetTransform()

   Copy full snippet(1 line long)

7. Utilizzando la funzione DrawSphere dell'API Disegno di debug, disegna due sfere per rappresentare la distanza minima di attenuazione e la distanza di smorzamento di attenuazione. Il Radius nella seconda chiamata a DrawSphere deve essere impostato sulla somma di AttenuationMinDistance e AttenuationFalloffDistance perché l'attenuazione inizia solo al di fuori del raggio della distanza minima di attenuazione.

   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. Nella funzione OnBegin() del tuo file Verse, chiama la funzione DrawAudioDeviceRange().

   Verse

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

   Copy full snippet(2 lines long)

9. Compila il tuo codice Verse. Nel pannello Dettagli del tuo dispositivo Verse, assicurati di impostare i valori di DebugAttenuationMinDistance e DebugAttenuationFalloffDistance. Questi valori devono essere equivalenti ai valori Attenuation Min Distance e Attenuation FalloffDistance del tuo dispositivo di riproduzione audio moltiplicati per 100.

   Il lettore audio utilizza i metri per la distanza minima di attenuazione e la distanza di smorzamento di attenuazione. Poiché l'API Debug disegno utilizza i centimetri, è necessario convertire i valori.

10. Script completo

    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)