Создание интерактивного компонента подбора предметов

В этом уроке вы узнаете, как создать интерактивный компонент подбора предметов, который позволяет игрокам подбирать пользовательские предметы и добавляет подобранный предмет в инвентарь игрока.

Подготовка

Для успешного прохождения этого обучения вы должны быть знакомы с UEFN, Scene Graph и Verse.

Настройка проекта

Выполните следующие действия, чтобы настроить проект и включить систему пользовательских предметов и инвентаря.

1. Откройте UEFN и создайте проект из любого шаблона острова. В шаблонах островов можно использовать пустой проект, если вам нужна плоская область для работы. Придумайте название для нового проекта и нажмите «Создать», чтобы открыть его в редакторе.

   

2. На панели инструментов нажмите на Проект и выберите Настройки проекта.

   

3. Прокрутите вниз до раздела Экспериментальный доступ и установите флажок для параметра Пользовательские предметы и инвентарь. 

Написание кода Verse

interactable_component — это компонент Scene Graph, который используется для обработки общего взаимодействия. По умолчанию игроки могут нажимать клавишу ввода, чтобы взаимодействовать с модулем, содержащим этот компонент. Выполните следующие действия, чтобы настроить этот компонент.

1. Выберите модуль, к которому вы хотите добавить пользовательский интерактивный компонент. На панели «Сведения» нажмите «+Компонент» и выберите «Новый компонент Verse». Откроется окно «Создать компонент Verse».  

   Вы также можете создать компонент Verse, добавив новый файл Verse через проводник Verse.

2. В разделе Выбрать шаблон выберите Компонент Scene Graph.

3. Внизу, в поле Название компонента введите item_interactable_component. Затем нажмите «Создать».

4. В строке меню выберите Verse > Проводник Verse. Найдите новый компонент Verse, нажмите по нему правой кнопкой мыши и выберите Открыть в Visual Studio Code.

5. В новом файле Verse удалите существующий код, так как в этом уроке вы напишете его полностью. Сначала добавьте необходимые модули. Вы можете скопировать и вставить их из приведённого ниже фрагмента.

   Verse

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

   Copy full snippet(3 lines long)

6. Затем добавьте вспомогательную функцию для получения корневого инвентаря у указанного игрока.

   Verse

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

   Copy full snippet(2 lines long)

7. Прежде чем создавать новый пользовательский компонент, вам нужно объявить константу нового типа сообщения за пределами области видимости нашего класса. Это сообщение является значением по умолчанию, если функция не может получить название из элемента item_details_component. Обычно этот тип сообщения записывается в самом низу файла Verse.

   Verse

   DefaultInteractionMessage<localizes>:message = "Interact"

   Copy full snippet(1 line long)

8. Определите новый Scene Graph, который наследует от компонента interactable_component. Это item_interactable_component.

   Verse

   item_interactable_component := class(interactable_component) :

   Copy full snippet(1 line long)

9. Добавьте необязательную переменную cancelable. Этому пользовательскому компоненту необходимо будет подписаться на событие, чтобы узнать, когда игрок взаимодействует с предметом. Эта переменная сохраняет ссылку на эту подписку и отменяет её при необходимости.

   Verse

   var SucceededEventHandler : ?cancelable = false

   Copy full snippet(1 line long)

10. Далее переопределите функцию OnAddedToScene, чтобы она задавала необязательную переменную при изменении родительского элемента модуля, которому принадлежить этот компонент (например, при его размещении в мире). Задайте SucceededEventHandler для вызова функции SucceededEvent, на которую можно подписаться. Здесь также будет определена функция OnSucceededEvent, чтобы она срабатывала при взаимодействии.

    Verse

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

    Copy full snippet(3 lines long)

11. Подписку на событие SucceededEvent необходимо сбрасывать после подбора предмета, иначе она может помешать работе другого кода, когда предмет находится в инвентаре. Ты Это можно сделать, переопределив функцию OnRemovingFromScene. Активируется при изменении родительскоого модуля предмета. Используйте её здесь, чтобы отменить (cancel()) подписку на событие. В случае успешного выполнения это также сделает недействительным SucceededEventHandler.

    Verse

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

    Copy full snippet(3 lines long)

12. На шаге 10 функция OnSucceededEvent подписана на SucceededEvent, но она ещё не существует в коде. Поэтому вам нужно написать новую функцию с той же сигнатурой. На шаге 6 вы использовали вспомогательную функцию GetInventoryRoot[], чтобы получить корневой инвентарь у взаимодействующего игрока. Теперь вызовите функцию AddItemDistribute(), чтобы указать модуль, которому принадлежит компонент.

    Verse

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

    Copy full snippet(3 lines long)

13. Последний бит кода, необходимый для этого компонента, — это переопределение функции InteractMessage[]. Возвращает сообщение, которое отображается на экране, когда игрок смотрит на предмет, перед тем, как его взять. При этом мы проверим модуль, которому принадлежит компонент, на наличие item_details_component. Если есть, то извлекается название предмета. В противном случае, если у модуля не было item_details_component или он был удалён по какой-либо причине, используется 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)

Настройка заготовок

Теперь, когда вы написали компонент item_interactable_component, вы можете создать пример предмета, чтобы посмотреть его в действии. Выполните следующие шаги, чтобы создать заготовку Scene Graph и присоединить новый компонент.

1. Нажмите правой кнопкой мыши в «Каталоге ресурсов» и в контекстном меню выберите Определение заготовки модуля. Назовите новую заготовку Item_Cube.

   

2. Откройте новую заготовку и добавьте следующие компоненты, нажав +Компонент на панели Сведения.

   • item_component

   • item_details_component — заполните поля в этом компоненте:

     • Название

     • Описание

     • Краткое описание

   • mesh_component — выберите примитив-куб или другой куб.

   • item_interactable_component

   

На видео ниже показана работа компонента item_interactable_component. Когда игрок взаимодействует с созданной вами заготовкой Item_Cube, предмет добавляется в инвентарь игрока.

Ниже представлен полный код для этого урока.

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]