Мод почтовой системы

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

Установка:

• Установите последнюю версию SMAPI.
• Распакуйте MailFrameworkModв /Stardew Valley/Mods.
  

Журнал изменений:

1.20.0

• Добавляет в игру новый пользовательский ресурс (DIGUS.MailFrameworkMod/MailData). Это означает, что письма MFM теперь можно загружать с помощью Content Patcher и использовать все его функции, например, токены. Он поддерживает те же свойства.
• Буквы Content Pack также загружаются в новый пользовательский актив и, следовательно, могут редактироваться с помощью Content Patcher.
• Пакеты контента теперь загружаются в кэш при запуске игры, а не перезагружаются при каждой загрузке сохранения. Вы можете принудительно перезагрузить пакеты контента с помощью консольной команды.
• Свойства «Текст» и «Заголовок» теперь поддерживают токенизированные строки.
• Ресурсы текстур теперь могут быть ресурсом игры, а не только ресурсом в папке мода.
• Новое свойство GameStateQuery как условие доставки письма.
  

1.19.0

• Новое свойство сохранять почтовое отправление действительным после того, как все условия были выполнены в течение дня, но почта не была прочитана в этот день.
• Новая функция для обработки случайно выбранных вложений
• Новое свойство, устанавливающее, сколько элементов из списка вложений следует выбрать для доставки.
• Новое свойство позволяет задать «RandomGroup» для вложения, чтобы оно выбиралось из этой группы, а не из всего списка.
• Новое свойство для установки «Веса» для заданного навесного оборудования при его случайном выборе.
• Новое свойство для установки количества элементов, которые следует выбрать из заданной группы, вместо использования значения по умолчанию.
• Новое свойство, указывающее, можно ли выбрать элемент из заданной группы более одного раза.
• Новый набор свойств для установки требования MailReceived для вложений и ответов
• Новое свойство, позволяющее удалить MailReceived после прочтения письма или выбора варианта ответа.
• Новое свойство для установки стоимости для данного варианта ответа.
• Новый тип предмета — «None». Его можно использовать, когда требуется случайная вероятность не доставить предмет, не вызывая ошибок/предупреждений в журнале.
  

1.18.0

• Новое свойство Ids заменяет Index и Name для CollectionConditions. Оно может агрегировать количество нескольких элементов, суммируя их значения для сравнения с итоговой суммой.
• Новое свойство ReplyConfig для добавления поведения ответа. Вы можете показать игроку какой-либо вариант ответа после прочтения письма, и он добавит один или несколько текстов MailReceived в зависимости от выбранного варианта. На основе этого выбора можно реализовать дополнительную логику мода.
• Исправлено письмо с рецептом, не поддерживающим свойство CustomTextColorName.
• Исправлено исключение нулевой ссылки при загрузке в игру элемента с нулевым именем.
  

1.17.1

• Письма с контентом, содержащие свойство рецепта, не должны иметь вложений, чтобы их можно было доставить повторно, если рецепт не изучен. (свойство рецепта игнорируется, если есть вложения)
• Исправление рецептов приготовления блюд с использованием той же логики, которая применялась ранее к рецептам создания блюд.
  

1.17.0

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

1.16.1

• Исправлен перевод названия рецепта.
  

1.16.0

• Обновите мод для совместимости со Stardew Valley 1.6.
• Новая команда для перезагрузки пакетов контента
• Изменено имя MailDao на MailRepository. (Влияет только на моды SMAPI, использующие его).
• Новый тип предмета «QualifiedItemId» для вложений должен работать для всех типов предметов в игре, если вы используете правильную квалификацию.
• Новая недвижимость на особых условиях. (Свадьба и рождение ребенка)
• Новое свойство для CustomTextColor, старое устарело.
• Новое свойство HasMods
• Новое свойство RequireAllMods
• Идентификаторы событий теперь являются строками. (Числа по-прежнему должны работать)
• Удалена устаревшая логика SV 1.6, включенная в MFM.
• Исправлена ошибка альфа-версии, из-за которой письмо не открывалось на странице получения почты.
  

Для моддеров, использующих пакет контента:

• Внутри папки мода находится шаблон с прокомментированными инструкциями о том, что делает каждое свойство.
• Все буквенные функции, за исключением условий и обратного вызова, такие же, как при кодировании с использованием фреймворка.
• Условия ограничены реализованными, и обратный вызов всегда устанавливает идентификатор письма как полученный. Если вам нужны расширенные условия, вам всё равно следует их закодировать. Или вы можете вежливо предложить мне добавить условие в пакет контента. Если оно имеет смысл, я, возможно, его добавлю.
• Вот шаблон, добавленный в файл мода:
  

Чтобы моддер использовал API:

• КопироватьIMailFrameworkModApiинтерфейс с методом, который вы хотите использовать из интерфейса MFM.
• КопироватьIПисьмоесли это необходимо для одного из методов.
• Методы:
  
  • RegisterContentPack- ИспользоватьHelper.ContentPacks.CreateTemporaryдля загрузки папки из вашего мода, содержащей файл mail.json и, возможно, папку i18n для переводов. Манифест не требуется, так как вы можете использовать этот параметр метода.
  • RegisterLetter- Заполните ILetter необходимыми свойствами. Также требуется условие для регистрации письма. Рекомендуется использовать обратный вызов, чтобы как минимум добавить идентификатор письма в том виде, в котором оно было получено. См. примеры ниже, в разделе "Для моддера, чтобы кодировать с MFM-зависимостью" сессия.
  • GetLetter- Вы получите объект ILetter для идентификатора письма.
  • GetMailDataString- Вы получите строку данных письма для идентификатора письма. Строка данных письма представляет собой переведённый текст и переведённый заголовок с разделителем [#].
    

Чтобы моддер мог писать код с учетом MFM-зависимости:

• Добавьте ссылку на MailFrameworkMod.dll в свой проект SMAPI.
  
  • Вы регистрируете свое письмо с помощью MailRepository.SaveLetter(Letter)
  • В начале каждого дня мод будет проверять письма, достигшие состояния готовности к доставке, и добавлять их в почтовый ящик.
  • Это письмо будет открыто первым, когда игрок проверит почтовый ящик.
  • После вскрытия письмо извлекается из почтового ящика.
  • Условием обратного вызова письма является их вызов.
  • В конце дня письма, оставшиеся в почтовом ящике, будут удалены, поэтому игра их не сохранит.
    
• Этот мод можно рассматривать как хранилище ваших писем. Он работает лучше всего, если вы загружаете все письма одновременно с игрой.
  

Примеры:

Спойлер:

Показывать

Загрузка простого письма, которое будет показано игроку, если оно не прочитано ранее, и не будет доставлено повторно после открытия игроком:
MailRepository.SaveLetter(
новое письмо(
"LetterUniqueId"
,"Пользовательский текст письма."