Modding:Block Entity: Difference between revisions

From Vintage Story Wiki
m (VeryGoodDog moved page Block Entity to Modding:Block Entity)
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__FORCETOC__
__FORCETOC__
{{GameVersion|1.9}}


== Introduction ==
= Introduction =


A block entity is a construct that you can tack onto an existing block to give it additional functionality. Whenever a block should do something on a regular interval or store extra information, such as the contents of a chest block, you need a block entity. It's highly recommend to have read the tutorial about [[Basic Modding|Basic Blocks]] and [[Advanced Blocks|Block Class]] in order to understand this tutorial properly.
A block entity is a construct that you can tack onto an existing block to give it additional functionality. Whenever a block should do something on a regular interval or store extra information, such as the contents of a chest block, you need a block entity. It's highly recommend to have read the tutorial about [[Basic Modding|Basic Blocks]] and [[Advanced Blocks|Block Class]] in order to understand this tutorial properly.
Line 49: Line 50:


<syntaxhighlight lang="c#">
<syntaxhighlight lang="c#">
         public void onTick(float par)
         public void OnTick(float par)
         {
         {
          
          
Line 61: Line 62:
         {
         {
             base.Initialize(api);
             base.Initialize(api);
             RegisterGameTickListener(onTick, 20);
             RegisterGameTickListener(OnTick, 20);
         }
         }
</syntaxhighlight>
</syntaxhighlight>
Line 68: Line 69:


<syntaxhighlight lang="c#">
<syntaxhighlight lang="c#">
         public void onTick(float par)
         public void OnTick(float par)
         {
         {
             timer++;
             timer++;
             if(timer > 60)
             if(timer > 60)
             {
             {
                 Block block = api.World.BlockAccessor.GetBlock(pos);
                 Block block = Api.World.BlockAccessor.GetBlock(Pos);
                 if (block.Code.Path.EndsWith("-on"))
                 if (block.Code.Path.EndsWith("-on"))
                     block = api.World.GetBlock(block.CodeWithParts("off"));
                {
                     block = Api.World.GetBlock(block.CodeWithParts("off"));
                }
                 else
                 else
                     block = api.World.GetBlock(block.CodeWithParts("on"));
                {
                 api.World.BlockAccessor.SetBlock(block.BlockId, pos);
                     block = Api.World.GetBlock(block.CodeWithParts("on"));
                 }
 
                Api.World.BlockAccessor.SetBlock(block.BlockId, Pos);
             }
             }
         }
         }
Line 128: Line 134:
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. It will work in the same way as ordinary mods, you can install it by copying it into the mods folder.
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. It will work in the same way as ordinary mods, you can install it by copying it into the mods folder.


= Mod Download =
* for VS 1.12 (Source only): [https://github.com/anegostudios/vsmodexamples/tree/ac7eeaed597b8a25dcfc2366b9c51cd92850d2b9/Mods/Ticking GitHub]
* for VS 1.9: [https://wiki.vintagestory.at/images/8/80/Ticking_v1.0.0.zip Ticking_v1.0.0.zip]
* for VS 1.9: [https://wiki.vintagestory.at/images/8/80/Ticking_v1.0.0.zip Ticking_v1.0.0.zip]
* for VS 1.6: [https://wiki.vintagestory.at/images/6/65/Ticking.zip Ticking.zip]
* for VS 1.6: [https://wiki.vintagestory.at/images/6/65/Ticking.zip Ticking.zip]
47

edits