Erstellen einer interaktionsfähigen Komponente für die Gegenstandsaufnahme

In diesem Tutorial erfährst du, wie du eine benutzerdefinierte interaktionsfähige Komponente für die Gegenstandsaufnahme erstellst, mit der Spieler benutzerdefinierte Gegenstände aufheben können, und die den aufgenommenen Gegenstand dem Inventar des Spielers hinzufügt.

Bevor du anfängst

Du solltest mit UEFN, Scene Graph und Verse-Code vertraut sein, um dieses Tutorial erfolgreich abzuschließen.

Dein Projekt einrichten

Befolge diese Schritte, um dein Projekt einzurichten und benutzerdefiniertes Inventar und Gegenstände zu aktivieren.

1. Öffne UEFN und erstelle ein Projekt aus einer beliebigen Inselvorlage. In Inselvorlagen kannst du das Leer-Projekt verwenden, wenn du mit einem flachen Gebiet arbeiten möchtest. Benenne dein neues Projekt und klicke auf „Erstellen“, um es im Editor zu öffnen.

   

2. Klicke in der Symbolleiste auf Projekt und wähle Projekt-Einstellungen.

   

3. Scrolle nach unten zum Abschnitt Experimenteller Zugriff und aktiviere das Kontrollkästchen für Benutzerdefinierte Gegenstände und Inventar. 

Schreiben von Verse-Code

Die interactable_component ist eine Scene-Graph-Komponente, die zur allgemeinen Interaktion verwendet wird. Standardmäßig können Spieler eine Eingabe drücken, um mit einer Entität zu interagieren, die die Komponente besitzt. Befolge diese Schritte, um diese Komponente anzupassen.

1. Wähle die Entität aus, zu der du die benutzerdefinierte interaktive Komponente hinzufügen möchtest. Klicke im Details-Panel auf „+Komponente“ und wähle „Neue Verse-Komponente“ aus. Das Fenster „Verse-Komponente erstellen“ wird geöffnet.  

   Du kannst auch eine Verse-Komponente erstellen, indem du eine neue Verse-Datei mit dem Verse-Explorer hinzufügst.

2. Wähle unter Vorlage auswählen die Option Scene-Graph-Komponente aus.

3. Gib unten im Feld Komponentenname „item_interactable_component“ ein. Klicke anschließend auf „Erstellen“.

4. Klicke in der Menüleiste auf Verse > Verse-Explorer. Suche deine neue Verse-Komponente, klicke mit der rechten Maustaste darauf und wähle In Visual Studio Code öffnen.

5. Lösche in der neuen Verse-Datei den vorhandenen Code, da du in diesem Tutorial alles neu schreiben wirst. Füge zuerst die erforderlichen Module hinzu. Du kannst sie aus dem folgenden Ausschnitt kopieren und einfügen.

   Verse

   using { /Verse.org/Simulation }
   using { /Verse.org/SceneGraph }
   using { /UnrealEngine.com/Itemization }

   Copy full snippet(3 lines long)

6. Füge als Nächstes eine Hilfsfunktion hinzu, um das Stamminventar eines bestimmten Spielers abzurufen.

   Verse

   GetInventoryRoot(Agent:agent)<decides><transacts>:inventory_component =
           Inventory := (for (I : Agent.FindDescendantComponents(inventory_component)) { I })[0]

   Copy full snippet(2 lines long)

7. Bevor du die neue benutzerdefinierte Komponente erstellst, musst du eine neue Nachrichtentyp-Konstante deklarieren, die außerhalb des Geltungsbereichs unserer Klasse liegt. Diese Meldung ist der Standardwert, wenn die Funktion keinen Namen aus der item_details_component eines Gegenstands abrufen kann. Normalerweise wird dieser Meldungstyp ganz unten in die Verse-Datei geschrieben.

   Verse

   DefaultInteractionMessage<localizes>:message = "Interact"

   Copy full snippet(1 line long)

8. Definiere einen neuen Scene Graph, der von interactable_component erbt. Dies ist die item_interactable_component.

   Verse

   item_interactable_component := class(interactable_component) :

   Copy full snippet(1 line long)

9. Füge eine optionale abbrechbare Variable hinzu. Diese benutzerdefinierte Komponente muss ein Event abonnieren, um zu wissen, wann ein Spieler mit dem Gegenstand interagiert. Diese Variable speichert einen Verweis auf dieses Abonnement und hebt es bei Bedarf auf.

   Verse

   var SucceededEventHandler : ?cancelable = false

   Copy full snippet(1 line long)

10. Setze als Nächstes die Funktion OnAddedToScene außer Kraft, sodass sie die optionale Variable setzt, wenn sich das Parent-Element der Entität, die diese Komponente besitzt, ändert (z. B. wenn sie in der Welt platziert wird). Lege SucceededEventHandler fest, um die Abonnieren-Funktion auf SucceededEvent aufzurufen. Dadurch wird auch die Funktion OnSucceededEvent definiert, sodass sie ausgelöst wird, wenn eine Interaktion stattfindet.

    Verse

    OnAddedToScene<override>():void =
          if(not SucceededEventHandler?):
             set SucceededEventHandler = option{SucceededEvent.Subscribe(OnSucceededEvent)}

    Copy full snippet(3 lines long)

11. Das SucceededEvent-Abonnement muss bereinigt werden, sobald ein Gegenstand aufgehoben wurde, da es sonst anderen Code behindern könnte, sobald sich der Gegenstand im Inventar befindet. You – Du wirst mich lieben Hierfür kann die Funktion OnRemovingFromScene überschrieben werden. Diese wird aktiviert, wenn sich der Parent der Element-Entität ändert. Verwende es hier, um cancel() für das Event-Abonnement auszuführen. Wenn dies erfolgreich ist, wird SucceededEventHandler ebenfalls ungültig.

    Verse

    OnRemovingFromScene<override>():void =
        if(SucceededEventHandler?.Cancel()):
    		   set SucceededEventHandler = false

    Copy full snippet(3 lines long)

12. In Schritt 10 wird die Funktion OnSucceededEvent für SucceededEvent abonniert, aber sie existiert noch nicht im Code. Du musst also eine neue Funktion mit der gleichen Signatur schreiben. In Schritt 6 hast du die Hilfsfunktion GetInventoryRoot[] verwendet, um das Stamminventar des interagierenden Spielers abzurufen. Rufe jetzt die Funktion AddItemDistribute() auf, um die Entität bereitzustellen, die diese Komponente besitzt.

    Verse

    OnSucceededEvent(Agent:agent):void =
            if(PickupInventory := GetInventoryRoot[Agent]):
                if(PickupInventory.AddItemDistribute(Entity).GetSuccess[]):

    Copy full snippet(3 lines long)

13. Das letzte bisschen Code, das für diese Komponente benötigt wird, ist das Außerkraftsetzen der Funktion InteractMessage[]. Diese gibt die Meldung zurück, die auf dem Bildschirm angezeigt wird, wenn ein Spieler sich den Gegenstand ansieht, bevor er ihn aufhebt. Dadurch wird die Entität, die diese Komponente besitzt, überprüft, um zu sehen, ob sie auch eine item_details_component hat. Ist dies der Fall, wird der Name des Gegenstands abgerufen. Wenn die Entität andernfalls keine item_details_component hatte oder sie aus irgendwelchen Gründen entfernt wurde, wird die DefaultInteractionMessage verwendet, die wir zuvor deklariert haben.

    Verse

    InteractMessage<override>(Agent:agent)<reads><decides>:message =
            if(Details := Entity.GetComponent[item_details_component]):
                Details.Name
            else:
                DefaultInteractionMessage

    Copy full snippet(5 lines long)

Einrichten des Prefab

Nachdem du nun deine item_interactable_component geschrieben hast, kannst du einen Beispielgegenstand erstellen, um sie zu präsentieren. Befolge diese Schritte, um ein Scene Graph-Prefab zu erstellen und die neue Komponente anzuhängen.

1. Klicke mit der rechten Maustaste im Inhaltsbrowser und wähle im Kontextmenü Entität-Prefab-Definition aus. Nenne das neue Prefab Item_Cube.

   

2. Öffne das neue Prefab und füge die folgenden Komponenten hinzu, indem du im Details-Panel auf +Komponente klickst.

   • item_component

   • item_details_component: Fülle die Felder dieser Komponente aus:

     • Name

     • Beschreibung

     • Kurze Beschreibung

   • mesh_component: Wähle den Würfel-Grundkörper oder einen anderen Würfel aus.

   • item_interactable_component

   

Das folgende Video zeigt die item_interactable_component in Aktion. Wenn der Spieler mit dem von dir erstellten Item_Cube-Prefab interagiert, wird der Gegenstand dem Inventar des Spielers hinzugefügt.

Hier findest du das komplette Script für dieses Tutorial.

using { /Verse.org/Simulation }
using { /Verse.org/SceneGraph }
using { /UnrealEngine.com/Itemization }


# This function returns the first subentity with an inventory_component. Use this to get the root inventory of an agent.
GetInventoryRoot(Agent:agent)<decides><transacts>:inventory_component =
        Inventory := (for (I : Agent.FindDescendantComponents(inventory_component)) { I })[0]