Tworzenie komponentu interaktywnego podnoszenia przedmiotów

Ten samouczek pokazuje, jak utworzyć niestandardowy interaktywny komponent „podnoszenia przedmiotu”, który umożliwia graczom podnoszenie niestandardowych przedmiotów, a następnie dodaje podniesiony przedmiot do ekwipunku gracza.

Zanim zaczniesz

Aby ukończyć ten samouczek, musisz znać UEFN, narzędzie Scene Graph i kod Verse.

Konfigurowanie projektu

Wykonaj poniższe kroki, aby skonfigurować projekt oraz włączyć system niestandardowych ekwipunków i przedmiotów.

1. Otwórz UEFN i utwórz projekt na podstawie dowolnego szablonu wyspy. W oknie szablonów wysp możesz wybrać projekt Pusty, jeśli chcesz pracować z wykorzystaniem płaskiego obszaru. Nadaj nazwę nowemu projektowi i kliknij Utwórz, aby otworzyć go w edytorze.

   

2. Na pasku narzędzi kliknij Projekt i wybierz Ustawienia projektu.

   

3. Przewiń w dół do sekcji Dostęp do funkcji eksperymentalnych i zaznacz pole System niestandardowych ekwipunków i przedmiotów. 

Pisanie kodu Verse

Komponent interactable_component jest komponentem Scene Graph używanym do obsługi ogólnej interakcji. Domyślnie gracze mogą nacisnąć przycisk, aby wejść w interakcję z jednostką, która posiada komponent. Wykonaj te kroki, aby dostosować ten komponent.

1. Wybierz jednostkę, do której chcesz dodać niestandardowy interaktywny komponent. W panelu szczegółów kliknij +Komponent i wybierz Nowy komponent Verse. Otworzy się okno Utwórz komponent Verse.  

   Możesz również utworzyć komponent Verse poprzez dodanie nowego pliku Verse za pomocą Eksploratora Verse.

2. W sekcji Wybierz szablon wybierz Komponent Scene Graph.

3. U dołu w polu Nazwa komponentu wpisz item_interactable_component. Następnie kliknij Utwórz.

4. Na pasku menu kliknij kolejno Verse > Eksplorator Verse. Znajdź nowy komponent Verse, kliknij go prawym przyciskiem myszy i wybierz Otwórz w Visual Studio Code.

5. W nowym pliku Verse usuń istniejący kod, ponieważ w tym samouczku zamierzasz napisać wszystko od nowa. Najpierw dodaj wymagane moduły. Możesz je skopiować i wkleić z fragmentu poniżej.

   Verse

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

   Copy full snippet(3 lines long)

6. Następnie dodaj funkcję pomocniczą, aby pobrać ekwipunek główny określonego gracza.

   Verse

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

   Copy full snippet(2 lines long)

7. Przed utworzeniem nowego komponentu niestandardowego musisz zadeklarować nową stałą typu komunikatu poza zakresem naszej klasy. Ten komunikat jest wartością domyślną, jeśli funkcja nie może pobrać nazwy z komponentu item_details_component. Zazwyczaj komunikaty tego typu są zapisywane na samym końcu pliku Verse.

   Verse

   DefaultInteractionMessage<localizes>:message = "Interact"

   Copy full snippet(1 line long)

8. Zdefiniuj nowy Scene Graph, który dziedziczy z interactable_component. To jest item_interactable_component.

   Verse

   item_interactable_component := class(interactable_component) :

   Copy full snippet(1 line long)

9. Dodaj opcjonalną zmienną możliwą do anulowania. Ten komponent niestandardowy musi zasubskrybować zdarzenie, aby wiedzieć, kiedy gracz wchodzi w interakcję z przedmiotem. Ta zmienna zapisuje odwołanie do tej subskrypcji i w razie potrzeby ją anuluje.

   Verse

   var SucceededEventHandler : ?cancelable = false

   Copy full snippet(1 line long)

10. Następnie zastąp funkcję OnAddedToScene tak, aby ustawiała zmienną opcjonalną, gdy zmieni się element nadrzędny jednostki będącej właścicielem tego komponentu (na przykład po umieszczeniu go w świecie). Ustaw SucceededEventHandler tak, aby wywołał funkcję subskrypcji dla zdarzenia SucceededEvent. Spowoduje to również zdefiniowanie funkcji OnSucceededEvent, tak aby była wyzwalana po wystąpieniu interakcji.

    Verse

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

    Copy full snippet(3 lines long)

11. Subskrypcja SucceededEvent musi zostać wyczyszczona po podniesieniu przedmiotu, w przeciwnym razie, gdy przedmiot znajdzie się w ekwipunku, może zakłócać działanie innego kodu. Ty Można to zrobić, zastępując funkcję OnRemovingFromScene. Aktywuje się, gdy zmienia się jednostka nadrzędna elementu. Użyj go tutaj, aby anulować() subskrypcję zdarzenia. W przypadku powodzenia spowoduje również unieważnienie SucceededEventHandler.

    Verse

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

    Copy full snippet(3 lines long)

12. W kroku 10 funkcja OnSucceededEvent została zasubskrybowana do SucceededEvent, ale jeszcze nie istnieje w kodzie. Musisz więc napisać nową funkcję o tej samej sygnaturze. W kroku 6 użyto funkcji pomocniczej GetInventoryRoot[] do pobrania głównego ekwipunku od gracza wchodzącego w interakcję. Teraz wywołaj funkcję AddItemDistribute(), aby podać jednostkę będącą właścicielem tego komponentu.

    Verse

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

    Copy full snippet(3 lines long)

13. Ostatni element kodu potrzebny dla tego komponentu to zastąpienie funkcji InteractMessage[]. Zwraca komunikat wyświetlany na ekranie, gdy gracz patrzy na przedmiot, zanim go podniesie. Spowoduje to sprawdzenie, czy jednostka będąca właścicielem tego komponentu ma również komponent item_details_component. Jeśli tak, pobiera nazwę przedmiotu. W przeciwnym razie, jeśli jednostka nie miała elementu item_details_component lub został on z jakiegoś powodu usunięty, użyje zadeklarowanego wcześniej DefaultInteractionMessage.

    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)

Konfigurowanie gotowca

Po zapisaniu item_interactable_component, możesz stworzyć przykładowy przedmiot, aby go zaprezentować. Wykonaj poniższe kroki, aby utworzyć gotowiec Scene Graph i dołączyć nowy komponent.

1. Kliknij prawym przyciskiem myszy w Przeglądarce zawartości i z menu kontekstowego wybierz opcję Definicja gotowca jednostki. Nadaj nowemu gotowcowi nazwę Item_Cube.

   

2. Otwórz nowy gotowiec i dodaj poniższe komponenty, klikając +Komponent w panelu szczegółów.

   • item_component

   • item_details_component – wypełnij pola w tym komponencie.

     • Nazwa

     • Opis

     • Krótki opis

   • mesh_component – pozwala wybrać prymityw sześcianu lub inny sześcian.

   • item_interactable_component

   

Poniższy film przedstawia komponent item_interactable_component w działaniu. Gdy gracz wejdzie w interakcję z utworzonym przez ciebie gotowcem Item_Cube, przedmiot zostanie dodany do ekwipunku gracza.

Oto kompletny skrypt do tego samouczka.

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]