added some more comments to the example mod

This commit is contained in:
Ell 2021-08-02 03:11:08 +02:00
parent 0a3d3aa3f0
commit 633a7d2762
2 changed files with 5 additions and 0 deletions

View file

@ -6,6 +6,8 @@ using TinyLife.Objects;
using TinyLife.World; using TinyLife.World;
namespace ExampleMod { namespace ExampleMod {
// note that having a custom class for a furniture item like this is entirely optional
// but it allows for additional functionalities as displayed in this example
public class CustomTable : Furniture { public class CustomTable : Furniture {
private static readonly Random Random = new(); private static readonly Random Random = new();

View file

@ -34,7 +34,10 @@ namespace ExampleMod {
public override void AddGameContent(GameImpl game) { public override void AddGameContent(GameImpl game) {
// adding a custom furniture item // adding a custom furniture item
FurnitureType.Register(new FurnitureType.TypeSettings("ExampleMod.CustomTable", new Point(1, 1), ObjectCategory.Table, 150, ColorScheme.SimpleWood) { FurnitureType.Register(new FurnitureType.TypeSettings("ExampleMod.CustomTable", new Point(1, 1), ObjectCategory.Table, 150, ColorScheme.SimpleWood) {
// specify the type that should be constructed when this furniture type is placed
// if this is not specified, the Furniture class is used, which is used for furniture without special animations or data
ConstructedType = typeof(CustomTable), ConstructedType = typeof(CustomTable),
// specifying icons for custom clothes and furniture is optional, but using the mod's icon helps users recognize a mod's features
Icon = this.Icon, Icon = this.Icon,
// allow chairs and plates to be slotted into and onto the table // allow chairs and plates to be slotted into and onto the table
ObjectSpots = ObjectSpot.TableSpots(new Point(1, 1)).ToArray() ObjectSpots = ObjectSpot.TableSpots(new Point(1, 1)).ToArray()