MoonstormSharedUtils

Moonstorm Shared Utils - Content Loading and General Utility Framework for Large Content Mods.

MoonstormSharedUtils, иначе известный как MSU, представляет собой API, предназначенный для работы вокруг системы ThunderKit для создания модов контента.

Первоначально часть API и Framework, созданная для обновления Starstorm2 до настройки ThunderKit для лучшего опыта разработки, она экспоненциально выросла в собственную отдельную библиотеку, поэтому любой, кто хочет создавать большие модификаторы контента с помощью Thunderkit, может использовать ее. (Starstorm2)

Цели API

МГУ борется за следующие цели в отношении развития моды и управления.

• Простые, но мощные системы управления и загрузки контента для игры.
• Надежная структура, построенная на модулях, которая позволяет автоматизировать различные части рабочего процесса моддинга, такие как выполнение оборудования, монстр и взаимодействующее появление и многое другое.
• Упрощение рабочего процесса ThunderKit путем предоставления пользовательского набора CompossableObjects для управления манифестами, путями и трубопроводами.
• Высокий акцент на использовании систем, предоставляемых игрой по крючкам, когда это возможно, таких как по умолчанию предоставленные делегаты, поведение базовых элементов и многое другое.
• Использование существующей структуры R2API для энергетических систем, таких как модификации директора.
• Акцент на работе в редакторе вместо работы над кодом для создания активов.

Ключевые особенности

The IContentPiece, IContentPieceProvider and Module Framework

В то время как только модифицированные коды создают свой контент (Prefabs, ScriptableObjects и т. д.) во время выполнения и обычно во время пробуждения, это вызывает проблемы, известные как «Навсегда черный экран», где большинство систем мода инициализируются до начала загрузки экрана игры. Это дает представление о том, что игра заморожена и не реагирует на забывчивых пользователей. И хотя это верно, управление загрузкой и взаимодействием между пользовательским контентом из Assetbundles и системами игры затруднено.

MSU решает эту проблему с помощью триединства ContentPiece, ContentPiece Provider и Module Framework. Эта троица используется, чтобы позволить модам загружать свои активы асинхронно во время экрана загрузки и заставлять их работать должным образом с системами базовой игры.

IContentPiece

• Представляет собой некоторую форму контента, которую мод добавляет
• Каждый ContentPiece привязан к определенному модулю, который обрабатывает загрузку и реализацию Контента.
• ContentPieces имеют методы доступности, которые модуль использует, чтобы знать, какой контент загружать и инициализировать.
• ContentPiece имеет метод асинхронной загрузки, который модуль использует во время инициализации, который используется для асинхронной загрузки активов для вашего контента.
• Будучи интерфейсом, API обеспечивает дальнейшие реализации:
• IContentPiece, который представляет собой контент, связанный с конкретным UnityEngine. Объект.
• MSU включает в себя следующие интерфейсы, которые реализуют «IContentPiece»
• «IArtifactContentPiece, для ArtifactDefs»
• `IEquipmentContentPiece for EquipmentDefs`
• Подинтерфейс под названием «IEliteContent» Piece управляет EliteDefs, связанным с определенным оборудованием.
• `IItemContentPiece for ItemDefs`.
• Подинтерфейс под названием «IVoidItemContentPiece» управляет коррупционной системой, добавленной в Survivors of the Void.
• `IItemTierContentPiecefor ItemTierDefs`
• «ISceneContentPiece для SceneDefs»
• «IKeyItemContentPiece for KeyItemDefs» (как и N’tormat)
• IGameObjectContentPiece, который представляет собой контент, привязанный к определенному типу UnityEngine. Моноповедение
• MSU включает в себя следующие интерфейсы, которые реализуют ‘IGameObjectContent Пьеса
• ICharacterContentPiece для персонажей
• Подинтерфейс под названием «IMonsterContentPiece» может использоваться для управления враждебными монстрами
• Подинтерфейс под названием «ISurvivorContent» Piece может использоваться для управления новыми выжившими.
• `IInteractableContentPiece for Interactables`.
• «IVanillaSurvivorContentPiece», который представляет собой модификацию для выжившего ванильного человека.
• Классы IContentPiece также имеют вспомогательные интерфейсы, которые могут быть реализованы для расширения их функциональности, такие как:
• «IContentPackModifier» для добавления дополнительных ресурсов в пакет контента вашего мода
• «IAsyncContentInitializer» для инициализации определенного контента асинхронным способом

Модули

• Модуль — это класс, который управляет загрузкой и взаимодействием классов «IContentPiece» с базовой игрой.
• Каждый модуль обрабатывает определенный тип интерфейса, а также возможные подинтерфейсы.
• Модуль знает, какие классы можно инстанцировать и инициализировать с помощью системы «IContentProvider».
• После того, как вы предоставите модуль «IContentProviderto», вы можете назвать его методом инициализации, чтобы получить обратно Coroutine, который инициализирует ваш контент асинхронным образом.
• МГУ поставляет следующие модули:
• ArtifactModule управляет IArtifactContentPieces, интерфейсом ArtifactModule с R2API. ArtifactCode' добавит в игру новые коды. Он также будет обрабатывать правильное подключение и расцепление артефакта, так что только когда артефакт включен, он включен.
• Шарактер Модуль, управляет ICharacterContent Исполнитель: ISurvivorContent Piece и IMonsterContent Piece, модуль интерфейсов с R2API. Режиссер должен справиться с появлением монстров на этапах игры.
• «EquipmentModule, управляет IEquipmentContentPiece и IEliteContentPiece», модуль использует один крючок для управления вызовами исполнения для оборудования.
• Интеракта