add registry helper methods (closes #2)

Author: devpikachu

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 **:sparkles: Features**
 - Added `System.RegisterClasses` virtual method ([#5](https://git.omni.ms/vintage-story-mods/common-mod/issues/5))
+- Added registry helper methods ([#2](https://git.omni.ms/vintage-story-mods/common-mod/issues/2))
 
 **:hammer: Refactors**
 - Cleanup pass ([#1](https://git.omni.ms/vintage-story-mods/common-mod/issues/1))

Common.Mod/System.cs

@@ -7,6 +7,7 @@
 using JetBrains.Annotations;
 using Vintagestory.API.Client;
 using Vintagestory.API.Common;
+using Vintagestory.API.Common.Entities;
 using Vintagestory.API.Config;
 using Vintagestory.API.Server;
 using GamePaths = Common.Mod.Core.GamePaths;
@@ -18,11 +19,15 @@ namespace Common.Mod;
 public abstract class System<TSystem> : ModSystem, ISystem
     where TSystem : System<TSystem>
 {
+    #region Events
+
     public event ISystem.AssetsLoadedHandler? OnAssetsLoaded;
     public event ISystem.AssetsFinalizedHandler? OnAssetsFinalized;
     public event ISystem.ServerPlayerJoinedHandler? OnServerPlayerJoined;
     public event ISystem.ClientPlayerJoinedHandler? OnClientPlayerJoined;
 
+    #endregion Events
+
     private const string ConfigLibModId = "configlib";
 
     [UsedImplicitly(ImplicitUseKindFlags.Access)]
@@ -35,6 +40,8 @@ protected System()
         Instance = this as TSystem ?? throw new NullReferenceException();
     }
 
+    #region Abstracts
+
     public abstract string ModId();
     public abstract string ModVersion();
     public abstract string ModName();
@@ -43,6 +50,10 @@ protected System()
 
     protected abstract void RegisterConfigs(IConfigSystem configSystem);
 
+    #endregion Abstracts
+
+    #region StartPre
+
     public override void StartPre(ICoreAPI api)
     {
         // Core API, side, ISystem
@@ -141,6 +152,10 @@ public override void AssetsFinalize(ICoreAPI api)
         OnAssetsFinalized?.Invoke();
     }
 
+    #endregion StartPre
+
+    #region Start
+
     public override void Start(ICoreAPI api)
     {
         RegisterClasses(api);
@@ -156,6 +171,8 @@ public override void StartClientSide(ICoreClientAPI api)
         api.Event.PlayerJoin += _OnClientPlayerJoined;
     }
 
+    #endregion Start
+
     public override void Dispose()
     {
         var api = Container.Resolve<ICoreAPI>();
@@ -172,6 +189,8 @@ public override void Dispose()
         }
     }
 
+    #region Virtuals
+
     [UsedImplicitly]
     protected virtual void ServerRegisterNetworkMessages(IServerNetworkChannel channel)
     {
@@ -199,6 +218,87 @@ protected virtual void RegisterClasses(ICoreAPI api)
     {
     }
 
+    #endregion Virtuals
+
+    #region Registry Helpers
+
+    [UsedImplicitly]
+    protected void RegisterEntity<TEntity>(ICoreAPI api, string className)
+        where TEntity : Entity
+    {
+        api.RegisterEntity(PrefixName(className), typeof(TEntity));
+    }
+
+    [UsedImplicitly]
+    protected void RegisterEntityClass(ICoreAPI api, string className, EntityProperties properties)
+    {
+        api.RegisterEntityClass(PrefixName(className), properties);
+    }
+
+    [UsedImplicitly]
+    protected void RegisterEntityBehaviorClass<TEntityBehavior>(ICoreAPI api, string className)
+        where TEntityBehavior : EntityBehavior
+    {
+        api.RegisterEntityBehaviorClass(PrefixName(className), typeof(TEntityBehavior));
+    }
+
+    [UsedImplicitly]
+    protected void RegisterBlockClass<TBlock>(ICoreAPI api, string className)
+        where TBlock : Block
+    {
+        api.RegisterBlockClass(PrefixName(className), typeof(TBlock));
+    }
+
+    [UsedImplicitly]
+    protected void RegisterBlockBehaviorClass<TBlockBehavior>(ICoreAPI api, string className)
+        where TBlockBehavior : BlockBehavior
+    {
+        api.RegisterBlockBehaviorClass(PrefixName(className), typeof(TBlockBehavior));
+    }
+
+    [UsedImplicitly]
+    protected void RegisterBlockEntityClass<TBlockEntity>(ICoreAPI api, string className)
+        where TBlockEntity : BlockEntity
+    {
+        api.RegisterBlockEntityClass(PrefixName(className), typeof(TBlockEntity));
+    }
+
+    [UsedImplicitly]
+    protected void RegisterBlockEntityBehaviorClass<TBlockEntityBehavior>(ICoreAPI api, string className)
+        where TBlockEntityBehavior : BlockEntityBehavior
+    {
+        api.RegisterBlockEntityBehaviorClass(PrefixName(className), typeof(TBlockEntityBehavior));
+    }
+
+    [UsedImplicitly]
+    protected void RegisterCropBehavior<TCropBehavior>(ICoreAPI api, string className)
+        where TCropBehavior : CropBehavior
+    {
+        api.RegisterCropBehavior(PrefixName(className), typeof(TCropBehavior));
+    }
+
+    [UsedImplicitly]
+    protected void RegisterItemClass<TItem>(ICoreAPI api, string className)
+        where TItem : Item
+    {
+        api.RegisterItemClass(PrefixName(className), typeof(TItem));
+    }
+
+    [UsedImplicitly]
+    protected void RegisterCollectibleBehaviorClass<TCollectibleBehavior>(ICoreAPI api, string className)
+        where TCollectibleBehavior : CollectibleBehavior
+    {
+        api.RegisterCollectibleBehaviorClass(PrefixName(className), typeof(TCollectibleBehavior));
+    }
+
+    [UsedImplicitly]
+    protected void RegisterMountable(ICoreAPI api, string className, GetMountableDelegate mountableInstantiator)
+    {
+        api.RegisterMountable(PrefixName(className), mountableInstantiator);
+    }
+
+    #endregion Registry Helpers
+
     private void _OnServerPlayerJoined(IServerPlayer player)
     {
         // Config synchronization
@@ -214,4 +314,6 @@ private void _OnClientPlayerJoined(IClientPlayer player)
     {
         OnClientPlayerJoined?.Invoke(player);
     }
+
+    private string PrefixName(string name) => $"{ModId()}:{name}";
 }