Modding:Функциональные Блоки

Эта страница проверялась в последний раз для версии Vintage Story 1.19.3.

Этот руководство по code mod требует наличия среды разработки. Если у вас её еще нет, прочтите руководство по настройке среды для разработки . Также рекомендуется сначала прочитать про Простые Блоки и изучить их устройство если вы не сделали этого ранее.

Создание Батута

В этом уроке мы создадим блок с более продвинутой функциональностью: Батут.

Ассеты Блока

Как и в случае с нашим Простым Блоком , первое, что нам нужно - это assets блока. Создайте тип блока trampoline.json на основе нашего блока, созданного в предыдущем руководстве.

В нашем файле blocktype нам нужно добавить свойство class. Это свойство, по сути, указывает нашему новому блоку, что он будет управляться определенным классом C#.

	class: "trampoline",

Мы создадим этот класс в нашей среде разработки, чтобы придать блоку желаемую функциональность. Вы можете скачать ассеты мода здесь. Все, что вам нужно сделать, это поместить содержимое этого zip-файла в директорию assets в вашем проекте разработки.

Класс Блока

Чтобы создать наш мод, нам понадобится несколько новых файлов *.cs в нашем проекте.

Система Мода

Для того чтобы создать мод, нам нужно создать класс, который будет наследоваться от ModSystem. Это позволит регистрировать всевозможные вещи, но пока мы ограничимся регистрацией только нашего класса блока.

public class TrampolineMod : ModSystem
{
    
}

Теперь вам нужно переопределить метод Start(ICoreAPI) и зарегистрировать класс.

Функция RegisterBlockClass имеет два параметра: первый - идентификатор класса блока, который мы используем в json-файлах blocktype. Убедитесь, что он идентичен классу, который мы указали в нашем предыдущем файле активов. Второй параметр - это тип нашего класса блока.

public class TrampolineMod : ModSystem
{
    public override void Start(ICoreAPI api)
    {
        base.Start(api);
        api.RegisterBlockClass("trampoline", typeof(TrampolineBlock));
    }
}

Так как класса TrampolineBlock ещё не существует, это место будет отображаться как синтаксическая ошибка.

Класс Блока

Давайте создадим наш класс блока, который, конечно, должен унаследовать класс Block:

Давайте создадим наш класс блока. При именовании скриптов блоков рекомендуется называть их в формате "{Name}Block". В случае с батутом мы назовем наш скрипт TrampolineBlock.cs. Любой класс блока должен наследоваться от Block, предоставляющий ему необходимую нам функциональность:

public class TrampolineBlock : Block
{

}

Это должно решить все синтаксические ошибки.

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

Метод void OnEntityCollide(IWorldAccessor world, Entity entity, BlockPos pos, BlockFacing facing, Vec3d collideSpeed, bool isImpact) выглядит как неплохой вариант для реализации прыгучего функционала. Заметьте, что каждый блок батута размещенный в игре будет совместно использовать один и тот же экземпляр TrampolineBlock. Поскольку этот объект используется несколькими блоками, он не имеет поля для позиции блока. Поэтому в обработчике события присутствует параметр pos.

Когда объект должен отскочить?

1. Сущность должна отскочить в тот момент, когда она приземляется на вершину блока, а не, когда она уже стоит на нем. Поэтому isImpact должно быть true.
2. Сущность должна сталкиваться вертикально. Стороны блока не должны отталкивать сущность. Таким образом, осью стороны axis facing должна быть Y.

Как мы можем заставить объект подпрыгивать?

Чтобы заставить объект подпрыгнуть, нам нужно изменить его направление. Поэтому мы можем просто изменить направление его движения. Чем быстрее сущность будет двигаться во время столкновения, тем дальше она будет отброшена. Но простое изменение направления движения не будет идеальным. Сущность никогда не потеряет своего движения и будет бесконечно отскакивать. Поэтому давайте сделаем что-нибудь, что заставит сущность терять 20% своего движения при каждом отскоке:

entity.Pos.Motion.Y *= -0.8;

The *= is a shorthand way of writing:

entity.Pos.Motion.Y = entity.Pos.Motion.Y * -0.8;

---

Если собрать всё воедино, это должно выглядеть так:

public class TrampolineBlock : Block
{
    public override void OnEntityCollide(IWorldAccessor world, Entity entity, BlockPos pos, BlockFacing facing, Vec3d collideSpeed, bool isImpact)
    {
        if (isImpact && facing.Axis == EnumAxis.Y)
        {
            entity.Pos.Motion.Y *= -0.8;
        }
    }
}

Хотя этот код уже работает, некоторые звуковые эффекты были бы весьма кстати. Мы можем реализовать это, добавив в наш блок поле звуковой ссылки, которое можно использовать для воспроизведения звука game:tick.

public AssetLocation tickSound = new AssetLocation("game", "tick");

Этот tickSound будет воспроизводиться каждый раз, когда объект отскакивает:

world.PlaySoundAt(tickSound, entity.Pos.X, entity.Pos.Y, entity.Pos.Z);

---

Если вы всё сделали правильно, то ваш файл должен быть похож на:

using Vintagestory.API.Common;
using Vintagestory.API.Common.Entities;
using Vintagestory.API.MathTools;

namespace VSExampleMods
{
    public class TrampolineMod : ModSystem
    {

        public override void Start(ICoreAPI api)
        {
            base.Start(api);
            api.RegisterBlockClass("trampoline", typeof(TrampolineBlock));
        }
    }

    public class TrampolineBlock : Block
    {
        public AssetLocation tickSound = new AssetLocation("game", "tick");

        public override void OnEntityCollide(IWorldAccessor world, Entity entity, BlockPos pos, BlockFacing facing, Vec3d collideSpeed, bool isImpact)
        {
            if (isImpact && facing.Axis == EnumAxis.Y)
            {
                world.PlaySoundAt(tickSound, entity.Pos.X, entity.Pos.Y, entity.Pos.Z);
                entity.Pos.Motion.Y *= -0.8;
            }
        }
    }
}

Конечно, вы можете скачать файл напрямую Trampoline.cs.

Тестирование

Наконец мы можем запустить наш первый тест. Выглядит неплохо, так ведь?

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

Распространение

Использование нового шаблона мода

Если вы используете шаблон мода, следуйте инструкциям Настройка среды разработки, чтобы упаковать ваш мод для дальнейшего распространения.

Использование Modtools (старый способ)

Если вы используете программу modtools, откройте её и введите pack <your mod id>. Теперь вы можете взять zip-файл и поделиться им с другими людьми. Он будет работать так же, как и обычные моды, вы можете установить его, скопировав в папку mods.

Скачать Мод

Варианты мода из этого руководства:

• для версии 1.9: Trampoline_vs1.9_v1.0.0.zip
• для версии 1.5: Trampoline.zip

Дальнейшие Шаги

Теперь, когда вы успешно создали функциональный блок, вы можете пойти еще дальше, научившись использовать Сущность Блоков и создавать собственные Поведения Блоков. Оба эти руководства научат вас добавлять еще больше механики в ваши пользовательские блоки.

Или вы можете попробовать создать Функциональный Предмет, если вы еще этого не сделали.

Wondering where some links have gone?
The modding navbox is going through some changes! Check out Navigation Box Updates for more info and help finding specific pages.