Modding:Advanced Items: Difference between revisions

From Vintage Story Wiki

Modding:Advanced Items (view source)

Revision as of 08:49, 21 May 2019

453 bytes added ,  4 years ago
no edit summary
No edit summary
No edit summary
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__FORCETOC__
__FORCETOC__


It's highly recommended to read [[Basic Item]] first. Additionally this tutorial requires a development environment. If you don't have one already you should read the tutorial [[Setting up a dev environment]].
It's highly recommended to read [[Basic Item]] first. Additionally this tutorial requires a development environment. If you don't have one already you should read the tutorial [[Setting up your Development Environment]].


= Tunnel pickaxe =
= Tunnel pickaxe =
Line 9: Line 9:
== Item Assets ==
== Item Assets ==


First of all we need to create a new item, including a texture and a lang file. Those assets are pretty straight forward and you can download them [http://wiki.vintagestory.at/images/c/cd/Tunnler_-_No_CS_File.zip here]. Just place the file in your mods folder and you are ready to start programming.
First of all we need to create a new item, including a texture and a lang file. Those assets are pretty straight forward and you can download them [https://wiki.vintagestory.at/images/c/cd/Tunnler_-_No_CS_File.zip here]. Just place the file in your mods folder and you are ready to start programming.


There is only one new property in your json item file called <code>class</code>:
There is only one new property in your json item file called <code>class</code>:
Line 22: Line 22:
If you have read the [[Advanced Blocks]] Tutorial already, this should be fimilar to you.
If you have read the [[Advanced Blocks]] Tutorial already, this should be fimilar to you.


In order to register your item class, we need to create a mod, which is basically a class exendting ModBase:
In order to register your item class, we need to create a mod, which is basically a class exendting ModSystem:


<syntaxhighlight lang="c#">
<syntaxhighlight lang="c#">
public class TunnlerMod : ModBase
public class TunnlerMod : ModSystem
{
{
      
      
Line 34: Line 34:


<syntaxhighlight lang="c#">
<syntaxhighlight lang="c#">
public class TunnlerMod : ModBase
public class TunnlerMod : ModSystem
{
{
     public override void Start(ICoreAPI api)
     public override void Start(ICoreAPI api)
Line 86: Line 86:
Now we can implement <code>OnBlockBroken</code> rather easily, by taken care of every possible axis the player could face:
Now we can implement <code>OnBlockBroken</code> rather easily, by taken care of every possible axis the player could face:
<syntaxhighlight lang="c#">
<syntaxhighlight lang="c#">
public override void OnBlockBroken(IWorldAccessor world, IEntity byEntity, IItemSlot itemslot, BlockSelection blockSel)
public override bool OnBlockBrokenWith(IWorldAccessor world, Entity byEntity, ItemSlot itemslot, BlockSelection blockSel)
{
{
     base.OnBlockBroken(world, byEntity, itemslot, blockSel);
     if (base.OnBlockBrokenWith(world, byEntity, itemslot, blockSel))
    if (byEntity is IEntityPlayer)
     {
     {
         IPlayer player = world.PlayerByUid((byEntity as IEntityPlayer).PlayerUID);
         if (byEntity is EntityPlayer)
        switch (blockSel.Face.Axis)
         {
         {
             case EnumAxis.X:
             IPlayer player = world.PlayerByUid((byEntity as EntityPlayer).PlayerUID);
                destroyBlocks(world, blockSel.Position.AddCopy(0, -1, -1), blockSel.Position.AddCopy(0, 1, 1), player);
            switch (blockSel.Face.Axis)
                break;
            {
            case EnumAxis.Y:
                case EnumAxis.X:
                destroyBlocks(world, blockSel.Position.AddCopy(-1, 0, -1), blockSel.Position.AddCopy(1, 0, 1), player);
                    destroyBlocks(world, blockSel.Position.AddCopy(0, -1, -1), blockSel.Position.AddCopy(0, 1, 1), player);
                break;
                    break;
            case EnumAxis.Z:
                case EnumAxis.Y:
                destroyBlocks(world, blockSel.Position.AddCopy(-1, -1, 0), blockSel.Position.AddCopy(1, 1, 0), player);
                    destroyBlocks(world, blockSel.Position.AddCopy(-1, 0, -1), blockSel.Position.AddCopy(1, 0, 1), player);
                break;
                    break;
                case EnumAxis.Z:
                    destroyBlocks(world, blockSel.Position.AddCopy(-1, -1, 0), blockSel.Position.AddCopy(1, 1, 0), player);
                    break;
            }
         }
         }
     }      
        return true;
     }
    return false;
}
}
</syntaxhighlight>
</syntaxhighlight>
Line 119: Line 123:
namespace ExampleMods
namespace ExampleMods
{
{
     public class TunnlerMod : ModBase
     public class TunnlerMod : ModSystem
     {
     {


Line 152: Line 156:
         }
         }


         public override void OnBlockBroken(IWorldAccessor world, IEntity byEntity, IItemSlot itemslot, BlockSelection blockSel)
         public override bool OnBlockBrokenWith(IWorldAccessor world, Entity byEntity, ItemSlot itemslot, BlockSelection blockSel)
         {
         {
             base.OnBlockBroken(world, byEntity, itemslot, blockSel);
             if (base.OnBlockBrokenWith(world, byEntity, itemslot, blockSel))
            if (byEntity is IEntityPlayer)
             {
             {
                 IPlayer player = world.PlayerByUid((byEntity as IEntityPlayer).PlayerUID);
                 if (byEntity is EntityPlayer)
                switch (blockSel.Face.Axis)
                 {
                 {
                     case EnumAxis.X:
                     IPlayer player = world.PlayerByUid((byEntity as EntityPlayer).PlayerUID);
                        destroyBlocks(world, blockSel.Position.AddCopy(0, -1, -1), blockSel.Position.AddCopy(0, 1, 1), player);
                    switch (blockSel.Face.Axis)
                        break;
                    {
                    case EnumAxis.Y:
                        case EnumAxis.X:
                        destroyBlocks(world, blockSel.Position.AddCopy(-1, 0, -1), blockSel.Position.AddCopy(1, 0, 1), player);
                            destroyBlocks(world, blockSel.Position.AddCopy(0, -1, -1), blockSel.Position.AddCopy(0, 1, 1), player);
                        break;
                            break;
                    case EnumAxis.Z:
                        case EnumAxis.Y:
                        destroyBlocks(world, blockSel.Position.AddCopy(-1, -1, 0), blockSel.Position.AddCopy(1, 1, 0), player);
                            destroyBlocks(world, blockSel.Position.AddCopy(-1, 0, -1), blockSel.Position.AddCopy(1, 0, 1), player);
                        break;
                            break;
                        case EnumAxis.Z:
                            destroyBlocks(world, blockSel.Position.AddCopy(-1, -1, 0), blockSel.Position.AddCopy(1, 1, 0), player);
                            break;
                    }
                 }
                 }
             }      
                return true;
             }
            return false;
         }
         }


Line 178: Line 186:
</syntaxhighlight>
</syntaxhighlight>


You can also download the file directly: [http://wiki.vintagestory.at/images/a/ad/Tunnler.cs Tunnler.cs].
You can also download the file directly: [https://wiki.vintagestory.at/images/a/ad/Tunnler.cs Tunnler.cs].


== Testing ==
== Testing ==
Line 188: Line 196:
== Distribution ==
== Distribution ==


In order to finish your mod, you need to place your *.cs file in the zip archive. Once that is done you can share it with other people. It will work in the same way as ordinary mods, you can install it by copying it into the <code>mods</code> 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 <code>mods</code> folder.
 
Here is my version:
* for VS v1.9: [https://wiki.vintagestory.at/images/7/7b/Tunnler_vs1.9_v1.0.0.zip Tunnler_vs1.9_v1.0.0.zip]
* for VS v1.8: [https://wiki.vintagestory.at/images/6/66/Tunnler.zip Tunnler.zip]
 


Here is the complete example mod: [http://wiki.vintagestory.at/images/6/66/Tunnler.zip Tunnler.zip]
{{Navbox/modding|Vintage Story}}
CreativeMD
Confirmedusers, editor, Administrators
886

edits

Retrieved from "https://wiki.vintagestory.at/index.php/Special:MobileDiff/931...4847"