SilksongPrepatcher

Препатчер Silksong

Prepatcher с модификациями сборки для Hollow Knight: Silksong.

PrepatcherPlugin

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

Чтобы использовать, подпишитесь на PlayerDataVariableEvents. Переменные или переменные события. Переменные события, где T — тип поля.

Абонент принимает в качестве аргументов объект данных игрока, имя поля и немодифицированное значение (или предыдущее значение, если есть несколько подписчиков), и должен вернуть измененное значение; в случае GetVariable немодифицированное значение - это значение поля, а возвращенное значение - это то, что видит игровой код, а в случае SetVariable немодифицированное значение - это то, что игровой код пытается установить, а возвращенное значение - это значение, которое фактически написано.

Для удобства некоторые общие события были добавлены в класс PlayerDataVariableEvents. Они ведут себя так же, как и общий эквивалент, поэтому PlayerDataVariableEvents. OnGetBool похож на PlayerDataVariableEvents. Например, OnGetVariable.

Пример использования:

using GlobalEnums;
using PrepatcherPlugin;

// In your mod's Awake class

PlayerDataVariableEvents.OnSetBool += MonitorBoolSets;
PlayerDataVariableEvents.OnGetVariable += OnGetCaravanLocation;

// Defining the functions

private bool MonitorBoolSets(PlayerData pd, string fieldName, bool current)
{
	Logger.LogInfo($"Setting bool {fieldName} to {current}");
	
	// Make sure to return current if you don't want to modify the value that would be set.
	return current;
}

private CaravanTroupeLocations OnGetCaravanLocation(PlayerData pd, string fieldName, CaravanTroupeLocations current)
{
    // If the caravan is in the Marrow, make the game think it's in Greymoor. Otherwise no change.
	return current == CaravanTroupeLocations.Bone ? CaravanTroupeLocations.Greymoor : current;
}

Для удобства класс PlayerDataAccess предоставляет свойства для получения и установки значений из PlayerData. объект экземпляра при прохождении вышеупомянутых событий (с использованием функций Get/Set, определенных в неизмененном коде) для поддержания совместимости с модами, которые контролируют сохранение доступа к данным. Например, следующие эквивалентны:

bool b = PlayerData.instance.GetBool(nameof(PlayerData.hasBrolly));
PlayerData.instance.SetBool(nameof(PlayerData.hasWalljump), true);

and

bool b = PlayerDataAccess.hasBrolly;
PlayerDataAccess.hasWalljump = true;

Препатчер

Следующие патчи сделаны Prepatcher:

• Доступ к полям Route PlayerData осуществляется с помощью переменных фанков Get/Set.

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

• Заменить некоторые призывы к собранию. GetTypes с призывами к безопасным методам.

В частности, новый метод не будет бросать, когда типы, которые не загружаются, присутствуют в сборке, и будет игнорировать сборки MMHOOK (которые могут содержать много типов, ни один из которых не представляет интереса для функций, определенных в базовых игровых сборках). Чтобы проверить изменения, которые делает здесь Prepatcher, проверьте следующее без установки Prepatcher (можно легко сделать с помощью простого MonoMod Hook):

• Зарегистрируйте продолжительность NestedFadeGroup. Метод AddMissingBridgeComponents

TeamCherry.NestedFadeGroup.dll. Это выполняется один раз во время запуска, но очень медленно, если игра должна проверять множество типов из множества сборок.

• Зарегистрируйте длительность длинных (то есть более 1 мс) звонков в ReflectionUtils. GetGlobalType

playMaker.dll, особенно при входе в такие сцены, как Bone 04, Bone 10 и Greymoor 08 (среди прочих). Эти конкретные случаи обрабатываются ReflectionUtilsPatcher, но в целом замена GetTypes ускорит функции.

• Замените определенные вызовы на Type.IsAssignableFrom вызовами на безопасный метод.

По какой-то причине в определенных обстоятельствах типы будут загружаться GetTypes и не будут считаться недействительными, но будут бросать ошибку, когда аргумент Типа. От него можно отказаться. Это проблема только в некоторых случаях, когда модам не хватает мягких зависимостей.

Осмотр залатанных сборок

Чтобы проверить исправленные сборки, установите переменную конфигурации DumpAssemblies в BepInEx.cfg.