View source for Modding:Block Entity/ru

__FORCETOC__
{{GameVersion|1.16}}
<languages/>
= Введение =

Блочная сущность — это конструкция, которую вы можете прикрепить к существующему блоку, чтобы придать ему дополнительную функциональность. Всякий раз, когда блок должен что-то делать через регулярные промежутки времени или хранить дополнительную информацию, например содержимое блока сундука, вам нужна сущность блока. Настоятельно рекомендуется прочитать руководство по [[Modding:Asset System/ru|базовым блокам]] и [[Modding:Advanced Blocks/ru|классам блоков]], чтобы правильно понять это руководство.

== Переключатель текстур ==

Давайте создадим блок, который меняет свою текстуру каждые 3 секунды. Он должен иметь два варианта: <code>"on"</code> и <code>"off"</code>. Кроме того, нам нужно определить класс blockentity следующим образом:
<syntaxhighlight lang="json">
	entityClass: "tickingcounter",
</syntaxhighlight>

Вы можете загрузить ассеты [https://wiki.vintagestory.at/images/d/d4/Ticking_-_No_CS_File.zip здесь] и поместить их в папку с модами.

== Сущность блока ==

Теперь нам нужно зарегистрировать наш класс blockentity и поэтому нам нужно создать новый файл *.cs в нашем проекте. Назовем его <code>Ticking.cs</code>.

Прежде всего вам нужно создать сам класс blockentity. Поэтому вам нужно расширить <code>BlockEntity</code>:

<syntaxhighlight lang="c#">
    public class TickingBlockEntity : BlockEntity
    {
    
    }
</syntaxhighlight>

----

Этот класс должен иметь таймер, когда таймер достигает 3 секунд, он должен заменить текущий блок другим состоянием.

Чтобы создать таймер, нам нужно зарегистрировать прослушиватель тиков. Поэтому нам нужно переопределить <code>Initialize(ICoreAPI)</code>:

<syntaxhighlight lang="c#">
        public override void Initialize(ICoreAPI api)
        {
            base.Initialize(api);
        }
</syntaxhighlight>

добавить счетчик (который должен увеличиваться за тик)...

<syntaxhighlight lang="c#">
        public float timer;
</syntaxhighlight>

... и собственно метод тиканья...

<syntaxhighlight lang="c#">
        public void OnGameTick(float dt)
        {
        
        }
</syntaxhighlight>

Чтобы зарегистрировать метод тиканья, мы можем использовать <code>RegisterGameTickListener</code> в <code>Initialize</code>.

<syntaxhighlight lang="c#">
        public override void Initialize(ICoreAPI api)
        {
            base.Initialize(api);
            RegisterGameTickListener(OnGameTick, 50);
        }
</syntaxhighlight>

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

<syntaxhighlight lang="c#">
        public void OnGameTick(float dt)
        {
            timer += dt;
            if(timer >= 3)
            {
                Block block = Api.World.BlockAccessor.GetBlock(Pos);
                if (block.Code.Path.EndsWith("-on"))
                {
                    block = Api.World.GetBlock(block.CodeWithParts("off"));
                }
                else
                {
                    block = Api.World.GetBlock(block.CodeWithParts("on"));
                }

                Api.World.BlockAccessor.SetBlock(block.BlockId, Pos);
            }
        }
</syntaxhighlight>

----

Кроме того, нам нужно сохранить текущее время:

<syntaxhighlight lang="c#">
        public override void ToTreeAttributes(ITreeAttribute tree)
        {
            base.ToTreeAttributes(tree);
            tree.SetFloat("timer", timer);
        }

        public override void FromTreeAttributes(ITreeAttribute tree, IWorldAccessor worldForResolving)
        {
            base.FromTreeAttributes(tree, worldForResolving);
            timer = tree.GetFloat("timer");
        }

</syntaxhighlight>

== Регистрация объекта блока ==

Регистрация класса блочной сущности довольно проста (скорее похожа на регистрацию блочного класса). Вам нужен класс мода и переопределить <code>Start(ICoreAPI)</code>:

<syntaxhighlight lang="c#">
    public class Ticking : ModSystem
    {

        public override void Start(ICoreAPI api)
        {
            base.Start(api);
            api.RegisterBlockEntityClass("tickingcounter", typeof(TickingBlockEntity));
        }

    }
</syntaxhighlight>

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

Теперь все готово для запуска первого теста:

<youtube>QQUibC4H9TI</youtube>

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

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

= Скачать мод =
* для VS 1.12 (только исходник): [https://github.com/anegostudios/vsmodexamples/tree/ac7eeaed597b8a25dcfc2366b9c51cd92850d2b9/Mods/Ticking GitHub]
* для VS 1.9: [https://wiki.vintagestory.at/images/8/80/Ticking_v1.0.0.zip Ticking_v1.0.0.zip]
* для VS 1.6: [https://wiki.vintagestory.at/images/6/65/Ticking.zip Ticking.zip]


{{Navbox/modding|Vintage Story}}