Modding:WorldGen API: Difference between revisions

{{GameVersion|1.15}}

We will be walking through how to plug in and add your own features to the world generation code of Vintage Story by looking at a demo mod called VSTreasureChest. The full source code for this project can be found [https://github.com/anegostudios/VSTreasureChest on Github]. We are going to walk through coding it from scratch.

In '''StartServerSide''' add the following line:

this.api.RegisterCommand("treasure", "Place a treasure chest with random items", "", PlaceTreasureChestInFrontOfPlayer, Privilege.controlserver);

private void PlaceTreasureChestInFrontOfPlayer(IServerPlayer player, int groupId, CmdArgs args)

private void PlaceTreasureChestInFrontOfPlayer(IServerPlayer player, int groupId, CmdArgs args)

         player.Entity.Pos.HorizontalAheadCopy(2).AsBlockPos, BlockFacing.UP, null

         Item item = api.World.GetItem(nextItem);

         slotNumber = Math.Min(slotNumber, chest.Inventory.QuantitySlots - 1);

         IItemSlot slot = chest.Inventory.GetSlot(slotNumber);

Lets go back to our '''PlaceTreasureChest''' method and replace the last line with the following code snippet.

BlockPos pos = player.Entity.Pos.HorizontalAheadCopy(2).AsBlockPos;

The first line is just capturing the '''BlockPos''' position object so that we can use it in two places. The next is the same as before, just placing the chest in the world. Next we go back to the '''IBlockAccessor''' to get the block entity at that position. It's important to call '''GetBlockEntity''' here because a chest is an '''Entity'''. An '''Entity''' is something that has extra behavior attached to it as opposed to a normal block. This method returns an '''IBlockEntity''' which is a generic interface for all block entities. However we specifically need a block entity that has an Inventory. Since we know the block entity we just placed is a chest then it's safe to to cast the returned '''IBlockEntity''' to an '''IBlockEntityContainer''' which is a specialized version of '''IBlockEntity''' that provides access to an '''Inventory'''. Now that we have that we pass it along to our '''AddItemStacks''' method we created earlier and additionally pass in the list of '''ItemStacks''' that are created by our '''MakeItemStacks''' method that we also created earlier. Now if you run the code again and type '''/treasure''' you should have random items in there! Try it several times and you will see them change.

this.api.Event.ChunkColumnGeneration(OnChunkColumnGeneration, EnumWorldGenPass.Vegetation, "standard");

The first argument is a delegate, which is a reference to a method. You will get a compiler error after adding that line because we have not yet created the '''OnChunkColumnGeneration''' method. We will create that next. The second argument is an Enum that indicates which world generation pass we need to hook into. Vintage story uses several passes to generate the world. Different features are available during different world gen passes. Since we will be placing chests next to trees, we need trees to be in the world so we choose to be notified during the '''EnumWorldGenPass.Vegetation''' which tells the engine that we need neighbor chunks, block layers, tall grass, bushes and trees to be available.

private void OnChunkColumnGeneration(IServerChunk[] chunks, int chunkX, int chunkZ)

private void PlaceTreasureChestInFrontOfPlayer(IServerPlayer player, int groupId, CmdArgs args)

     PlaceTreasureChest(worldBlockAccessor, player.Entity.Pos.HorizontalAheadCopy(2).AsBlockPos);

     ushort blockID = api.WorldManager.GetBlockId("chest-south");

     Block chest = api.WorldManager.GetBlockType(blockID);

     chest.TryPlaceBlockForWorldGen(blockAccessor, pos, BlockFacing.UP);

    if (chestEntity != null)

         AddItemStacks(chestEntity, MakeItemStacks());

        System.Diagnostics.Debug.WriteLine("Placed treasure chest at " + pos.ToString(), new object[] { });

        return true;

    }

         System.Diagnostics.Debug.WriteLine("FAILED TO PLACE TREASURE CHEST AT " + pos.ToString(), new object[] { });

private void OnChunkColumnGeneration(IServerChunk[] chunks, int chunkX, int chunkZ)

     int chestsPlacedCount = 0;

     for (int i = 0; i < chunks.Length; i++)

             BlockPos blockPos = new BlockPos();

             for (int x = 0; x < chunkSize; x++)

                 for (int z = 0; z < chunkSize; z++)

                     for (int y = 0; y < worldBlockAccessor.MapSizeY; y++)

                             blockPos.X = chunkX * chunkSize + x;

                             blockPos.Z = chunkZ * chunkSize + z;

                             BlockPos chestLocation = TryGetChestLocation(blockPos);

                                 bool chestWasPlaced = PlaceTreasureChest(chunkGenBlockAccessor, chestLocation);

                         else//Max chests have been placed for this chunk

     WorldProperty treeTypesFromFile = api.Assets.TryGet("worldproperties/block/wood.json").ToObject<WorldProperty>();

     foreach (WorldPropertyVariant variant in treeTypesFromFile.Variants)

         treeTypes.Add("log-" + variant.Code + "-ud");

     return treeTypes.Contains(block.Code);

                 if (IsTreeLog(underBlock)) continue;

 

 

{{Navbox/modding|Vintage Story}}