Modding:Adding Block Behavior: Difference between revisions

From Vintage Story Wiki

Modding:Adding Block Behavior (view source)

Revision as of 17:01, 27 March 2024

1,628 bytes added ,  1 month ago
m
Updated navbox to new code navbox.
No edit summary
m (Updated navbox to new code navbox.)
 
(14 intermediate revisions by 6 users not shown)
Line 1: Line 1:
<languages />
<languages/>
<translate>
<translate>
<!--T:89-->
__FORCETOC__
__FORCETOC__
''Mod written for version 1.9 of Vintage Story''
</translate>
<translate>
<!--T:48-->
{{GameVersion|1.19.3}}
</translate>


== Introduction ==
<translate>
= Introduction = <!--T:49-->
Block Behaviors are useful when you want different blocks to act in the same way, as you can attach one or more block behaviors to an arbitrary number of blocks.
Block Behaviors are useful when you want different blocks to act in the same way, as you can attach one or more block behaviors to an arbitrary number of blocks.
You may want to have a look at the existing [[Block Json Properties#p_behaviors|block behaviors]] before implementing your own.
You may want to have a look at the existing [[Block Json Properties#p_behaviors|block behaviors]] before implementing your own.


<!--T:50-->
In this tutorial we'll create a new Behavior that we can attach to blocks to make them movable by right clicking them.
In this tutorial we'll create a new Behavior that we can attach to blocks to make them movable by right clicking them.
</translate>


== Setting up ==
<translate>
== Setting up == <!--T:51-->


<!--T:52-->
A [[Setting up your Development Environment|development workspace]] is required. Additionally you will need the assets (blocktype, texture and lang file). You can either create your one owns or use those pre-made ones: [https://wiki.vintagestory.at/images/2/2f/Moving_-_No_CS_File.zip Moving - No CS File.zip]
A [[Setting up your Development Environment|development workspace]] is required. Additionally you will need the assets (blocktype, texture and lang file). You can either create your one owns or use those pre-made ones: [https://wiki.vintagestory.at/images/2/2f/Moving_-_No_CS_File.zip Moving - No CS File.zip]
</translate>


== Creating the behavior ==
<translate>
== Creating the behavior == <!--T:53-->


<!--T:54-->
So first of all we need to create the behavior itself, which is a class extending BlockBehavior
So first of all we need to create the behavior itself, which is a class extending BlockBehavior
</translate>
<syntaxhighlight lang="csharp">
<syntaxhighlight lang="csharp">
class Moving : BlockBehavior
class Moving : BlockBehavior
Line 27: Line 42:
</syntaxhighlight>
</syntaxhighlight>


<translate>
<!--T:55-->
This class provides several methods we can override. When you use Visual Studio you can find a full list of a methods by hovering with the mouse of "BlockBehavior" and pressing "F12".
This class provides several methods we can override. When you use Visual Studio you can find a full list of a methods by hovering with the mouse of "BlockBehavior" and pressing "F12".


<!--T:56-->
----
----


The method <code>bool OnPlayerInteract(IWorldAccessor world, IPlayer byPlayer, BlockSelection blockSel, ref EnumHandling handling)</code> looks to be ideal for our purpose.
<!--T:57-->
The method <code>bool OnBlockInteractStart(IWorldAccessor world, IPlayer byPlayer, BlockSelection blockSel, ref EnumHandling handling)</code> looks to be ideal for our purpose.


<!--T:58-->
What should it do?
What should it do?


# Calculate the new position of the block depending on the face the player is looking at
<!--T:59-->
# Check if the block can be placed at this position
# Calculate the new position to move the block to, based on the block face the player is looking at.
# Remove the original block
# Check if the block can be placed at this new position.
# Place the new block using the previously calculated position
# Remove the block at the old position.
# Place the same type of block at the new position.
# [[Modding:Behavior_Traversal|Skip]] the default logic that would otherwise place whatever item is held at the old position.
</translate>


<syntaxhighlight lang="c#">
<syntaxhighlight lang="c#">
     public override bool OnPlayerInteract(IWorldAccessor world, IPlayer byPlayer, BlockSelection blockSel, ref EnumHandling handling)
     public override bool OnBlockInteractStart(IWorldAccessor world, IPlayer byPlayer, BlockSelection blockSel, ref EnumHandling handling)
     {
     {
         // Find the target position
<translate>
         BlockPos pos = blockSel.Position.AddCopy(blockSel.Face.GetOpposite());
         <!--T:60-->
 
// Find the target position
         // Can we place the block there?
</translate>
         BlockPos pos = blockSel.Position.AddCopy(blockSel.Face.Opposite);
<translate>
         <!--T:61-->
// Can we place the block there?
</translate>
         if (world.BlockAccessor.GetBlock(pos).IsReplacableBy(block))
         if (world.BlockAccessor.GetBlock(pos).IsReplacableBy(block))
         {
         {
             // Remove the block at the current position and place it at the target position
<translate>
             <!--T:88-->
// Remove the block at the current position and place it at the target position
</translate>
             world.BlockAccessor.SetBlock(0, blockSel.Position);
             world.BlockAccessor.SetBlock(0, blockSel.Position);
             world.BlockAccessor.SetBlock(block.BlockId, pos);
             world.BlockAccessor.SetBlock(block.BlockId, pos);
         }
         }
 
<translate>
         // Notify the game engine other block behaviors that we handled the players interaction with the block.
         <!--T:62-->
// Notify the game engine other block behaviors that we handled the players interaction with the block.
         // If we would not set the handling field the player would still be able to place blocks if he has them in hands.
         // If we would not set the handling field the player would still be able to place blocks if he has them in hands.
</translate>
         handling = EnumHandling.PreventDefault;
         handling = EnumHandling.PreventDefault;
         return true;
         return true;
Line 61: Line 94:
</syntaxhighlight>
</syntaxhighlight>


== Register ==
<translate>
== Register == <!--T:63-->


<!--T:64-->
In order the register the BlockBehavior we need to create a mod class, override <code>Start(ICoreAPI)</code> and register it with the given name:
In order the register the BlockBehavior we need to create a mod class, override <code>Start(ICoreAPI)</code> and register it with the given name:
</translate>


<syntaxhighlight lang="c#">
<syntaxhighlight lang="c#">
Line 69: Line 105:
     {
     {


        public override void Start(ICoreAPI api)
public override void Start(ICoreAPI api)
         {
         {
             base.Start(api);
             base.Start(api);
Line 75: Line 111:
         }
         }


    }
}
</syntaxhighlight>
</syntaxhighlight>


== Distribution ==
<translate>
== Distribution == <!--T:65-->


<!--T:66-->
In order to finish everything, open the modtools and type in <code>pack <your mod id></code>. Now you can take the zip file and share it with other people.
In order to finish everything, open the modtools and type in <code>pack <your mod id></code>. Now you can take the zip file and share it with other people.
* for VS 1.9: [https://wiki.vintagestory.at/images/2/2a/Moving_v1.0.0.zip Moving_v1.0.0.zip]
* for VS 1.9: [https://wiki.vintagestory.at/images/2/2a/Moving_v1.0.0.zip Moving_v1.0.0.zip]
* for VS 1.6: [https://wiki.vintagestory.at/images/c/cb/Moving.zip Moving.zip]
* for VS 1.6: [https://wiki.vintagestory.at/images/c/cb/Moving.zip Moving.zip]


== Testing ==
== Testing == <!--T:67-->
</translate>


<youtube>8eVG0uQF2xs</youtube>
<youtube>8eVG0uQF2xs</youtube>


= Advanced Behavior =
<translate>
= Advanced Behavior = <!--T:68-->


<!--T:69-->
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.
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.
</translate>


== Example ==
<translate>
== Example == <!--T:70-->


<!--T:71-->
The behavior liquid supports some special properties as shown in this example of the water blocktype:
The behavior liquid supports some special properties as shown in this example of the water blocktype:
</translate>


<syntaxhighlight lang="json">
<syntaxhighlight lang="json">
Line 111: Line 156:
</syntaxhighlight>
</syntaxhighlight>


== Parsing properties ==
<translate>
== Parsing properties == <!--T:72-->


<!--T:73-->
In order to take care of special properties there is a method called <code>Initialize(JsonObject)</code>. Each blocktype creates a new instance of the behavior, so the method can be used to parse the properties.
In order to take care of special properties there is a method called <code>Initialize(JsonObject)</code>. Each blocktype creates a new instance of the behavior, so the method can be used to parse the properties.


<!--T:74-->
So what kind of properties could we add?
So what kind of properties could we add?
* push distance
* push distance
* pull block if player is sneaking
* pull block if player is sneaking


<!--T:75-->
First of all, we need to override the method in our block behavior class ...
First of all, we need to override the method in our block behavior class ...
</translate>


<syntaxhighlight lang="c#">
<syntaxhighlight lang="c#">
Line 128: Line 178:
</syntaxhighlight>
</syntaxhighlight>


<translate>
<!--T:76-->
Additionally we need to add two fields, one for the distance and another one if the player should pull the block while sneaking ...
Additionally we need to add two fields, one for the distance and another one if the player should pull the block while sneaking ...
</translate>


<syntaxhighlight lang="c#">
<syntaxhighlight lang="c#">
Line 135: Line 188:
</syntaxhighlight>
</syntaxhighlight>


<translate>
<!--T:77-->
Now we can parse the two properties like so:
Now we can parse the two properties like so:
</translate>


<syntaxhighlight lang="c#">
<syntaxhighlight lang="c#">
Line 144: Line 200:
----
----


<translate>
<!--T:78-->
The next thing we need to change is the interact method itself, so that it takes care of the distance and the pull properties ...
The next thing we need to change is the interact method itself, so that it takes care of the distance and the pull properties ...
</translate>
<syntaxhighlight lang="c#">
<syntaxhighlight lang="c#">
         public override bool OnPlayerInteract(IWorldAccessor world, IPlayer byPlayer, BlockSelection blockSel, ref EnumHandling handling)
         public override bool OnBlockInteractStart(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);
<translate>
            <!--T:79-->
// Find the target position
</translate>
             BlockPos pos = blockSel.Position.AddCopy(pull && byPlayer.WorldData.EntityControls.Sneak ? blockSel.Face : blockSel.Face.Opposite, distance);
 
<translate>
            <!--T:80-->
// Can we place the block there?
</translate>
             if (world.BlockAccessor.GetBlock(pos).IsReplacableBy(block))
             if (world.BlockAccessor.GetBlock(pos).IsReplacableBy(block))
             {
             {
<translate>
                <!--T:81-->
// Remove the block at the current position and place it at the target position
</translate>
                 world.BlockAccessor.SetBlock(0, blockSel.Position);
                 world.BlockAccessor.SetBlock(0, blockSel.Position);
                 world.BlockAccessor.SetBlock(block.BlockId, pos);
                 world.BlockAccessor.SetBlock(block.BlockId, pos);
             }
             }
<translate>
            <!--T:82-->
// Notify the game engine other block behaviors that we handled the players interaction with the block.
            // If we would not set the handling field the player would still be able to place blocks if he has them in hands.
</translate>
             handling = EnumHandling.PreventDefault;
             handling = EnumHandling.PreventDefault;
             return true;
             return true;
Line 159: Line 237:
</syntaxhighlight>
</syntaxhighlight>


== Adding another block ==
<translate>
== Adding another block == <!--T:83-->


<!--T:84-->
Let's create another block using this behavior, but this time we will configure some additional properties ...
Let's create another block using this behavior, but this time we will configure some additional properties ...
</translate>


<syntaxhighlight lang="json">
<syntaxhighlight lang="json">
Line 175: Line 256:
</syntaxhighlight>
</syntaxhighlight>


<translate>
<!--T:85-->
The block will be pushed two blocks instead of one and the player can pull it by sneaking while right clicking.
The block will be pushed two blocks instead of one and the player can pull it by sneaking while right clicking.
</translate>


=== Mod Links ===
<translate>
= Mod Download = <!--T:86-->


<!--T:87-->
* for VS 1.9: [https://wiki.vintagestory.at/images/7/7b/Advancedmoving_v1.0.0.zip AdvancedMoving_v1.0.0.zip]
* for VS 1.9: [https://wiki.vintagestory.at/images/7/7b/Advancedmoving_v1.0.0.zip AdvancedMoving_v1.0.0.zip]
* for VS 1.6: [https://wiki.vintagestory.at/images/7/72/AdvancedMoving.zip AdvancedMoving.zip]
* for VS 1.6: [https://wiki.vintagestory.at/images/7/72/AdvancedMoving.zip AdvancedMoving.zip]
</translate>


 
{{Navbox/codemodding}}
 
{{Navbox/modding|Vintage Story}}
 
 
</translate>
Nateonus
Confirmedusers
536

edits

Retrieved from "https://wiki.vintagestory.at/index.php/Special:MobileDiff/9079...175614"