Modding:Добавление поведения Блока
Эта страница проверялась в последний раз для версии Vintage Story 1.9.
Введение
Поведение блоков довольно полезно, если вы хотите, чтобы разные блоки действовали одинаково, поскольку вы можете прикрепить к произвольному количеству блоков одно или несколько поведений. Возможно, вы захотите взглянуть на существующие block behaviors перед реализацией своего собственного.
В этом уроке мы создадим новое поведение, которое мы можем прикрепить к блокам, чтобы сделать их подвижными, щелкнув по ним правой кнопкой мыши.
Настройка
Требуется ознакомится со статьёй - Настройка среды для разработки. Кроме того, вам понадобятся ресурсы (тип блока, текстура и файл lang). Вы можете создать свои собственные или использовать готовые: Moving - No CS File.zip
Создание поведения
Итак, прежде всего нам нужно создать само поведение, которое является классом, расширяющим BlockBehavior
class Moving : BlockBehavior
{
public Moving(Block block) : base(block)
{
}
}
Этот класс предоставляет несколько методов, которые мы можем переопределить. Когда вы используете Visual Studio, вы можете найти полный список методов, наведя курсор мыши на «BlockBehavior» и нажав «F12».
Метод bool OnPlayerInteract (IWorldAccessor world, IPlayer byPlayer, BlockSelection blockSel, ref EnumHandling handling)
выглядит идеально подходящим для наших целей.
Что это должно сделать?
- Рассчитать новую позицию блока в зависимости от стороны, в которую смотрит игрок
- Проверить, можно ли разместить блок в этой позиции
- Удалить оригинальный блок
- Поместить новый блок, используя ранее рассчитанную позицию
public override bool OnPlayerInteract(IWorldAccessor world, IPlayer byPlayer, BlockSelection blockSel, ref EnumHandling handling)
{
// Находим целевую позицию
BlockPos pos = blockSel.Position.AddCopy(blockSel.Face.GetOpposite());
// Можем ли мы разместить блок там?
if (world.BlockAccessor.GetBlock(pos).IsReplacableBy(block))
{
// Remove the block at the current position and place it at the target position
world.BlockAccessor.SetBlock(0, blockSel.Position);
world.BlockAccessor.SetBlock(block.BlockId, pos);
}
// Сообщаем игровому движку о других действиях блока, которые мы обрабатывали при взаимодействии игроков с блоком.
// Если бы мы не установили поле обработки, игрок все равно мог бы размещать блоки, если бы он держал их в руках.
handling = EnumHandling.PreventDefault;
return true;
}
Регистрация
Чтобы зарегистрировать BlockBehavior, нам нужно создать класс мода, переопределить Start (ICoreAPI)
и зарегистрировать его с заданным именем:
public class MovingBlocks : ModSystem
{
public override void Start(ICoreAPI api)
{
base.Start(api);
api.RegisterBlockBehaviorClass("Moving", typeof(Moving));
}
}
Distribution
In order to finish everything, open the modtools and type in pack <your mod id>
. Now you can take the zip file and share it with other people.
- for VS 1.9: Moving_v1.0.0.zip
- for VS 1.6: Moving.zip
Testing
Advanced Behavior
Our behavior is still rather simple, but there are a lot more possibilities. A behavior can have special properties, which can be defined by the blocktype itself.
Example
The behavior liquid supports some special properties as shown in this example of the water blocktype:
behaviors: [
{
name: "FiniteSpreadingLiquid",
properties:
{
spreadDelay: 150,
liquidCollisionSound: "hotmetal",
sourceReplacementCode: "obsidian",
flowingReplacementCode: "basalt"
}
}
],
Parsing properties
In order to take care of special properties there is a method called Initialize(JsonObject)
. Each blocktype creates a new instance of the behavior, so the method can be used to parse the properties.
So what kind of properties could we add?
- push distance
- pull block if player is sneaking
First of all, we need to override the method in our block behavior class ...
public override void Initialize(JsonObject properties)
{
base.Initialize(properties);
}
Additionally we need to add two fields, one for the distance and another one if the player should pull the block while sneaking ...
public int distance = 1;
public bool pull = false;
Now we can parse the two properties like so:
distance = properties["distance"].AsInt(1);
pull = properties["pull"].AsBool(false);
The next thing we need to change is the interact method itself, so that it takes care of the distance and the pull properties ...
public override bool OnPlayerInteract(IWorldAccessor world, IPlayer byPlayer, BlockSelection blockSel, ref EnumHandling handling)
{
BlockPos pos = blockSel.Position.AddCopy(pull && byPlayer.WorldData.EntityControls.Sneak ? blockSel.Face : blockSel.Face.GetOpposite(), distance);
if (world.BlockAccessor.GetBlock(pos).IsReplacableBy(block))
{
world.BlockAccessor.SetBlock(0, blockSel.Position);
world.BlockAccessor.SetBlock(block.BlockId, pos);
}
handling = EnumHandling.PreventDefault;
return true;
}
Adding another block
Let's create another block using this behavior, but this time we will configure some additional properties ...
behaviors: [
{
name: "Moving",
properties: {
"distance": 2,
"pull": true
}
}
],
The block will be pushed two blocks instead of one and the player can pull it by sneaking while right clicking.
Mod Download
- for VS 1.9: AdvancedMoving_v1.0.0.zip
- for VS 1.6: AdvancedMoving.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.
Modding | |
---|---|
Modding Introduction | Getting Started • Пакет тем |
Content Modding | Content Mods • Developing a Content Mod • Basic Tutorials • Intermediate Tutorials • Advanced Tutorials • Content Mod Concepts |
Code Modding | Code Mods • Setting up your Development Environment |
Property Overview | Item • Entity • Block • Block Behaviors • Block Classes • Block Entities • Block Entity Behaviors • World properties |
Workflows & Infrastructure | Modding Efficiency Tips • Mod-engine compatibility • Mod Extensibility • VS Engine |
Additional Resources | Community Resources • Modding API Updates • Programming Languages • List of server commands • List of client commands • Client startup parameters • Server startup parameters Example Mods • API Docs • GitHub Repository |