Разбираю один из многообразных способов создания инвентаря в игре на примере движка Godot. Рассматривается вариант написания его вручную, относительно простым образом, без использования классов и каких-то плагинов.

Пара слов про общую архитектуру

В Godot предусмотрена возможность загружать разные ресурсы/скрипты в качестве «глобальных» синглтонов. Для использования «глобальности» вполне хватит одного такого автозагруженного скрипта и в своих проектах я чаще использую такую связку:

Основной скрипт (Main) главной игровой сцены отвечает за хранение ссылок к большинству объектов сцены, за прокрутку игрового цикла, отслеживание части нажатий кнопок, выставление стартовых параметров, манипулирование игровыми окнами и прочие вспомогательные вещи. Скрипт более верхнего уровня, глобальный (G), отвечает за хранение переменных, которые потребуются прочим отдельным мелким скриптам, через него же скрипты могут обращаться к основному. Также в нём хранятся разные вспомогательные методы, которые вынесены отдельно из некоторых прочих скриптов в одно место, где их проще найти.

Main крутит основной цикл и имеет связи с большинством фиксированных объектов. G обеспечивает доступ к себе из любого узла, а также позволяет любым узлам обращаться к самому Main. — **Main** крутит основной цикл и имеет связи с большинством фиксированных объектов. G обеспечивает доступ к себе из любого узла, а также позволяет любым узлам обращаться к самому Main.

При этом в G также хранится ссылка на сам Main, чтобы он мог к нему обращаться. Это запись var M = null. Когда Main стартует, то заносит себя в этот адрес: G.M = self.
В принципе, в G может больше не быть вообще никакого кода, кроме этой ссылки - просто все прочие узлы смогут через него стучаться в Main через G.M. Но тут всё-таки не java script, где таким же образом можно при желании пробросить ссылку на "основной скрипт" через глобальный контекст (то есть через window и прочее), чтобы не плодить тучу переменных в самом глобальном контексте. В Godot пачки переменных в кастомном юзерсокм глобальном скрипте - это нормально, и тут просто стоит подумать о том, как удобнее распределить данные между G и Main.

Кнопки инвентаря собраны на отдельном 2д-слое и каждая кнопка представляет собой префаб ячейки инвентаря - отдельную упакованную сцену. Так как привязывать каждую кнопку сигналом к основному скрипту сцены довольно неудобно (равно как и заносить их все в поле экспорта), плюс потребуется не только принимать от них сигналы, но и иметь с ними обратную связь, то я просто завожу массив ссылок на кнопки инвентаря в глобальном скрипте и при первом появлении на сцене они сами себя туда заносят.

Таким образом я могу удобно менять количество ячеек в процессе прототипирования. Будет изменяться только количество ссылок на них, которые нужно хранить, плюс поменяется диапазон перебора по их массиву.

Каждой кнопке назначается свой ID, а сигналы нажатия они отправляют сами себе. Во время перетаскивания предметов в глобальный скрипт заносятся параметры претаскиваемого объекта, ID ячейки откуда началось перетаскивание и так далее. Затем, если предмет был помещён в новую ячейку, то по этому ID новой ячейки вызывается метод в ячейке назначения, а по старому ID - метод в ячейке отправки. Эти методы меняют параметры ячейки и перерисовывают её визуал, в соответствии с этими новыми параметрами.

Более подробно про организацию узлов

Препарировать я тут в основном буду свой прототип arpg, игру da~Mage:

Итак, основной узел инвентаря - Inventory, прикреплён к древу иерархии главной сцены. Якорем для него выбрана точка справа внизу экрана (то есть при изменении размеров окна, узел Inventory вместе со своим содержимым будет всё время сохранять своё положение относительно правой нижней точки), а в разделе Mouse фильтр установлен в положение Ignore - таким образом вхождение мыши в область узла не будет обрабатываться и не перекроет какие-то прочие элементы.

Слева, в иерархии узел Inventory. На основном экране отмечена салатовым крестиком якорная точка и квадратик области узла. Справа, в поле Mouse-Filter выставлен режим Ignore для того, чтобы область не реагировала на мышь.

Сама по себе область узла есть у всех Control, но часто она не потребуется, поэтому просто оставляем её предустановленным квадратиком (нет нужды его растягивать, чтобы все прочие внутренние элементы в него входили - они будут работать и без этого) и, желательно, не забыть перевести её фильтр в Ignore. А вот у самого первого, корневого узла Control, к которому привязаны прочие 2д-объекты и слои - область узла, как правило, включает в себя весь экран полностью. И, кстати, если ей не включить режим Mouse фильтра в Ignore, то нажатия мышью на объекты 3д-сцены не будут фиксироваться, так как 2д-слой интерфейса будет их перехватывать. Не во всех играх есть реакция 3д объектов на мышь, но стоит помнить о том, что области двухмерных узлов могут перекрывать регистрацию нажатий мыши друг для друга или для 3д-пространства.

Корневой узел Interface и его область - весь экран. Выставляется в выпадающем списке Layout, вариант - Full Rect.

Иногда требуется наоборот, временно заблокировать нажатия мыши на каких-то слоях. Например, для невозможности прожимать какие-то игровые кнопки во время паузы или открытия экрана настроек. Тогда как раз можно заслонить те слои другим узлом Control, с областью в весь экран или его часть, оставив в фильтре для Mouse значение Stop (или Pass).

Мышь регистрируют не только области пустых узлов Control, но и прочие объекты - например цветные прямоугольники Color Rect, кнопки и так далее. Поэтому для них тоже может потребоваться настроить фильтр, чтобы они что-то не заслоняли (здесь ещё всё зависит от специфики узла, например, кнопка с включенным фильтром Ignore просто сама перестанет нажиматься). Кстати, в Godot на всех коллайдерах регистрация мыши почему-то включена по умолчанию, но это уже другая история.

Как устроены ячейки внутри

По сути, в Godot можно обойтись стандартной кнопкой или вариантом кнопка + спрайт, для создания отдельной ячейки. В данном случае я сделал сцену не из самой кнопки, а из пустышки Control, в которую уже вложена кнопка и прочее. Это может пригодиться, если, например, потребуется добавить какой то фон за кнопкой, а не только перед ней. Или позже использовать самописную «кнопку» вместо предлагаемой стандартной. Сигнал нажатия кнопки и управляющий скрипт тоже повешены на пустышку.

Вообще, если уже определено, что кнопки будут именно самописные — лучше вместо пустышки сразу использовать Area2D, где внутри будет коллайдер и картинка. В принципе для всего, что использует коллайдеры (не важно 2d или 3d) логичнее вешать скрипт и делать префаб именно из Area или Body, во всех прочих случаях 2д или 3д пустышка универсальнее — проще поменять внутреннюю структуру, скрипт не придётся переписывать, не поломается анимация если этот узел был анимирован. Правда пустышка-обёртка - лишнее звено иерархии, но обычно это незначительная цена.

Область корневого узла ItemSlot не взаимодействует с мышью (на всякий случай, хотя кнопка почти целиком перекрывает область) и показывает дефолтный квадрат 40 на 40. В поле ID значение по умолчанию -1, а конкретные ID проставлены уже на основной сцене.

Как видно, здесь присутствует пара спрайтов - один, собственно, для фона ячейки, а другой для предметов (в данном случае предметы - это книги).

Отдельные книжки хранятся в общем изображении-атласе. В спрайте мы указываем на сколько колонок и столбцов делить полученное общее изображение и затем, меняя фрейм спрайта, выводим в нём изображение той или иной книги.

Код ячейки

Рассмотрим код узла ItemSlot написанный на GDScript в Godot 3x. Первая строка - extends Control - означает, что скрипт оперирует узлом Control, и, соответственно, имеет доступ к различным встроенным свойствам этого класса узлов. Допустим, если бы это был код для узла Button, то там мы могли бы оперировать какими-то специфическими свойствами класса узлов Button, которых нет у узлов Control.

Примеры кода, опять же - не руководство к действию, не clean code и не образец того как нужно писать. К тому же, так как в этом проекте лут планировался фиксированный, а не генерируемый - можно было вобще не таскать данные из ячейки в ячейку, а держать варианты данных в таблицах, чтобы ячейки просто меняли адрес, на который ссылаются. Но это в идеале, а про оптимизацию в целом была другая статья

Также мы выводим наружу параметр ID (export var), чтобы менять его в редакторе. Получаем ссылки (onready var) на спрайт фона и предмета. В 4-й версии движка перед export и onready нужно дописывать @ — Также мы выводим наружу параметр ID (**export var**), чтобы менять его в редакторе. Получаем ссылки (**onready var**) на спрайт фона и предмета. В 4-й версии движка перед export и onready нужно дописывать @

Ячейка хранит в себе параметры книги, которая лежит внутри. book = [0,0,0,0,0]. Можно было хранить одну цифру (номер картинки в атласе), но конкретно в этом прототипе каждая книжка — это набор параметров, а также 0 в первой цифре означает отсутствие предмета. В атласе картинок предметов, соответственно, нулевой фрейм полностью прозрачный, то есть когда мы устанавливаем предмет [0,....] в ячейку, то выводится прозрачное ничто в качестве предмета. Фрейм под номером 1, следующий после нулевого, тоже зарезервирован - там содержится условная картинка-маркер, появляющаяся на той ячейке откуда предмет взят.

На слое основной сцены выставляем уникальный ID каждому ItemSlot (желательно и названия им изменить под ID) - то есть первому, ItemSlot_0, пишем 0 в поле ID вместо дефолтной -1. ItemSlot_1 - ID 1 и так далее.

При появлении на сцене, собственно, ячейка заносит ссылку на себя (self) в специальный массив (books_arr) глобального скрипта (G)

Кстати, попутно заглянем в главный скрипт, чтобы увидеть массив books_arr, который изначально забит null значениями. Следует помнить, сколько значений мы завели, чтобы назначать ID верно - в данном случае в books_arr содержится 20 элементов, с 0 по 19. Можно было написать books_arr = [], но у нас тут не миллион значений и мне было удобнее для наглядности забить их сразу явно. К тому же так проще поймать ошибки - вдруг код где-то случайно обращается к элементу books_arr вне этого диапазона. — Кстати, попутно заглянем в **главный скрипт**, чтобы увидеть массив books_arr, который изначально забит null значениями. Следует помнить, сколько значений мы завели, чтобы назначать ID верно - в данном случае в books_arr содержится 20 элементов, с 0 по 19. Можно было написать **books_arr = []**, но у нас тут не миллион значений и мне было удобнее для наглядности забить их сразу явно. К тому же так проще поймать ошибки - вдруг код где-то случайно обращается к элементу books_arr вне этого диапазона.

Далее у нас идёт основная функция от кнопки - сигнал, посылаемый в момент начала нажатия на кнопку (_on_Button_button_down). Если в этой ячейке первая цифра в book больше 1 (то есть 2 и выше), значит, там был предмет и мы начинаем перемещать его (как раз временно заменив картинку в текущей ячейке на фрейм 1: PicBook.frame = 1). Это происходит, если никакой предмет в данное время ещё не зацеплен (showdrag == false), в противном случае возвращаем книгу на место (returnBook()).

Если же книга оказалась нулевой (book[0] = 0) и при этом какая-то книга сейчас зацеплена, то тоже вызываем метод возвращения книги. — Если же книга оказалась нулевой (**book[0] = 0**) и при этом какая-то книга сейчас зацеплена, то тоже вызываем метод возвращения книги.

А вот и сама функция возвращения, описанная ниже в скрипте: сначала мы копируем параметры книги из текущей ячейки (добавляя к ней duplicate(true), чтобы передать именно отдельную, несвязанную копию массива данных). Далее, если books_arr от запомненного ID стартовой ячейки существует, то вызываем метод setBook() в ней, с параметрами своей книги, а у себя вызываем тот же setBook(), но с параметрами книги, которую взяли ранее из стартовой ячейки.

В конце происходит ещё и вызов функции updateBooksAura() в глобальном скрипте, чтобы перерассчитать какие-то прочие характеристики, связанные с книгами в определённых ячейках.

Если заглянуть в главный скрипт, то видно, что рассчитывается в этом конкретном прототипе - сначала картинки скиллов скрываются, а далее, если в нужных слотах были книги (результат умножения пары слотов отличен от нуля), то скиллы А и/или Б показываются. — Если заглянуть в **главный скрипт**, то видно, что рассчитывается в этом конкретном прототипе - сначала картинки скиллов скрываются, а далее, если в нужных слотах были книги (результат умножения пары слотов отличен от нуля), то скиллы А и/или Б показываются.

Осталось разобрать последний простенький метод, который находится в скрипте ячейки: setBook(). Здесь всё просто, кнопка обращается к себе же по своему ID (такая длинная форма записи осталась от прошлого варианта реализации, можно было писать и просто book = book_param.duplicate(true)), выставляя новые параметры для своего book. А фрейм картинки книги меняется на первую цифру принимаемого массива параметров (book_param[0]).

Так как в принимаемом массиве book_param подразумевается 5 элементов, то обращаться (проверять, менять) к каждому из них конкретно можно через book_param[0], book_param[1],...,[book_param[4]]

В целом, стоит стараться, где это получается, делать изменение параметров в прочих объектах именно через вызов специального метода в другом объекте (с параметрами или без), вместо того, чтобы напрямую изменять несколько определённых отдельных параметров его скрипта.

Отдельно можно упомянуть механизм отображения перетаскиваемого предмета. На основном экране для этого заведён отдельный узел DragBook, располагающийся в нуле координат, содержащий спрайт с книгами и изначально скрытый.

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

В цикле основного скрипта сцены, когда предмет зацеплен, вызывается метод draggedMove(), который будет двигать узел DragBook за мышью:

В цикле проверяется, активен ли флаг showdrag, который выставляется в true при перетаскивании (тогда же устанавливается и изображение перетаскиваемой картинки, и сама она становится видимой).

Сама функция таскания за мышью проверяет соответствие нового положения мыши старому (переменная old_mousepos заранее объявлена в шапке скрипта как var old_mousepos = Vector2.ZERO, а new_mousepos вычисляется в моменте), и двигает узел, когда те не совпали. — Сама функция таскания за мышью проверяет соответствие нового положения мыши старому (переменная old_mousepos заранее объявлена в шапке скрипта как **var old_mousepos = Vector2.ZERO**, а new_mousepos вычисляется в моменте), и двигает узел, когда те не совпали.

Отдельно замечу, что в 4-й версии движка в коде мало что меняется конкретно при работе с логикой интерфейса. Тем не менее некоторые отличия есть: кроме вышеупомянутых @export и @onready, вместо просто export и onready в 4-ке понадобится, например, в последнем фрагменте кода писать не drag_book.rect_position, а drag_book.position (так как ключевое слово для этого свойства изменили, для большего единообразия и удобства).

Прочие проекты с похожим подходом

В разбираемом da~Mage инвентарь более простой и однородный - то есть, ячейки одинаковые, в каждой может лежать любой объект. В прочих проектах инвентарь посложнее, и там присутствовали ещё и слоты экипировки, как отдельные уникальные префабы ячеек, в которые можно помещать лишь объекты какого-то одного типа (оружие в слот оружия, кольцо в слот кольца и так далее).

da~Mage, arpg с непродолжительными забегами по локациям на выживание (и возможное перерождение в найденных телах) и упрощённым инвентарём, где скиллы создаются комбинациями предметов. Видеофрагмент с инвентори из одной из ранних версий:

В диаблоиде Панделирий интерфейс более комплексный - помимо общих ячеек инвентаря есть отдельные слоты экипировки, предметы можно подбирать, ломать и выбрасывать, при наведении на предмет высвечивается подсказка. Само перетаскивание тут сделано так, чтобы требовалось зажимать предмет, чтобы тащить куда-то далеко (в отличии от da~Mage, где нужно именно кликать в точку старта и финиша), иначе он падает в первый свободный слот. Здесь тоже в качестве параметров предмета передаётся массив значений, а не одно лишь число картинки, так как некоторые местные предметы имеют заряды, а другие - прогресс изучения. К тому же, что привычно в диаблоидах, предметы могут иметь одинаковую картинку, но различаться по редкости/названию. Одним словом тут напрашивается подход к предмету как к составному конструктору, где одна картинка может обозначать разное, а сам предмет может складываться из нескольких слоёв картинок.

Pandelirium, проект приближенный к полновесному диаблоиду - со слотами экипировки, редкостью вещей и их изучением. Скиллы от комбинаций здесь тоже присутствуют, но руны для комбинаций даёт экипированное оружие и эти руны можно выучить.

В Сферамиде принцип во многом похож на реализацию интерфейса Pandelirium, но в качестве параметра предмета передаётся всего одно число (фрейм конкретной картинки). Здесь, как и в da~Mage, заклинания зависят от комбинаций предметов - нужно комбинировать особые камни, помещая их в специальные слоты камней. Кроме того тут реализован "органический инвентарь", он же более гибкая версия стандартного диабло-инвентаря, где предметы занимали определённое место - здесь различная экипировка имеет определённую форму влияния на окружающие ячейки, поэтому стоит располагать её в определённом порядке, для более компактного укладывания.

Spheramyd, простой сферический околодиаблоид, с "органическим инвентарём", слотами экипировки и камнями для комбинаций. По концепции ориентирован не на полноценную прокачку персонажа, а на краткие забеги.

В космическом аркадном Outsiders, написанном уже в Godot 4, "инвентарь" состоит из ячеек двух видов, которые несовместимы друг с другом - это ячейки для героев (экипаж), и ячейки для грузов (различные объекты, артефакты, товары, заряды, оружие). В плане кода ячейки универсальны, но у ячеек ответственных за предметы ID начинаются с 1000 (чтобы однозначно не пересекаться по ID с ячейками героев, количество которых не должно превысить пары десятков), в то время как у героев от 0 - поэтому, в зависимости от ID, ячейки по разному реагируют на перетаскивание (объекты можно перемещать только в слоты того же типа).

Массив элементов должен "честно" состоять из 1000+ элементов, если мы хотим прямо обращаться к элементу array[1001], например. Поэтому, для элементов с ID больше 999 просто заведён другой обычный массив и если код видит элемент с таким ID, то вычитает из этого ID 1000 и обращается в этот второй массив. То есть 1000-й элемент будет нулевым, 1001 - первым и так далее.

Outsiders - космическое ролевое аркадное приключение, где звездолётики разного типа возят героев по планетам и миссиям, получая способности от связи с различными героями.

На этом и остановимся.

Инвентарь в Godot