Commit: 9e9f04a4367d778dcb2f2d338360533a5c7a7ee2 - admintoolkit (git)

Administrator's Toolkit VS plugin

Commit MetaInfo

• Revisión: 9e9f04a4367d778dcb2f2d338360533a5c7a7ee2 (tree)
• Tiempo: 2020-09-09 08:35:29
• Autor: melchior <melchior@user...>
• Commiter: melchior

Log Message

Added Variable Spawnpoints feature (W.I.P.)

Cambiar Resumen

• modified: AdminToolkit/AdminModConfig.cs
• modified: AdminToolkit/AdminToolkit.csproj
• modified: AdminToolkit/AdminToolkitMod.cs
• modified: AdminToolkit/Commands/BannerControl.cs
• add: AdminToolkit/Commands/VariableSpawnpoints.cs
• modified: AdminToolkit/modinfo.json

Diferencia incremental

--- a/AdminToolkit/AdminModConfig.cs
+++ b/AdminToolkit/AdminModConfig.cs
@@ -49,6 +49,11 @@ namespace AdminToolkit
 		/// <value>The booming voice.</value>
 		public bool BoomingVoice { get; set; }
 
+		/// <summary>
+		/// Semi-Randomize spawn point from a set list
+		/// </summary>
+		public bool VariableSpawnpoints { get; set; }
+
 		public AdminModConfig( )
 		{
 			this.PlayerRoleRestrain = "suvisitor";

--- a/AdminToolkit/AdminToolkit.csproj
+++ b/AdminToolkit/AdminToolkit.csproj
@@ -76,6 +76,7 @@
     <Compile Include="Commands\RulesCommand.cs" />
     <Compile Include="Commands\BannerControl.cs" />
     <Compile Include="Commands\PingerCommand.cs" />
+    <Compile Include="Commands\VariableSpawnpoints.cs" />
   </ItemGroup>
   <ItemGroup>
     <Folder Include="VS_libs\" />

--- a/AdminToolkit/AdminToolkitMod.cs
+++ b/AdminToolkit/AdminToolkitMod.cs
@@ -27,6 +27,8 @@ namespace AdminToolkit
 		 * [DONE] Cyclic automatic Backups
 		 * [WIP} Broadcast messages, on a schedule ??????
 		 * [???] Custom Server name : custom formats to indicate server state/time/things
+		 * [IDEA]: Player inventory Insurance; recover lost items for a (two) time fee... one policy per player.
+		 * [WIP]: Variable Player (re)Spawn points from a list ~ at random
 		 */
 
 		private ICoreAPI API { get; set; }
@@ -97,8 +99,9 @@ namespace AdminToolkit
 			this.ServerAPI.RegisterCommand(new RulesCommand(this.ServerAPI) );
 			this.ServerAPI.RegisterCommand(new AdminListingCommand(this.ServerAPI) );
 			this.ServerAPI.RegisterCommand(new BackupCycleCommand(this.ServerAPI) );
-			this.ServerAPI.RegisterCommand(new BannerControl(this.ServerAPI));
+			//this.ServerAPI.RegisterCommand(new BannerControl(this.ServerAPI));
 			this.ServerAPI.RegisterCommand(new PingerCommand(this.ServerAPI));
+			this.ServerAPI.RegisterCommand(new VariableSpawnpoints(this.ServerAPI));
 
 			if (CachedConfiguration.BoomingVoice) {
 				this.ServerAPI.Event.PlayerChat += BoomingVoiceOfAuthority;

--- a/AdminToolkit/Commands/BannerControl.cs
+++ b/AdminToolkit/Commands/BannerControl.cs
@@ -1,14 +1,20 @@
 using System;
+using System.Collections.ObjectModel;
 
 using ProtoBuf;
 
 using Vintagestory.API.Common;
 using Vintagestory.API.Server;
+using Vintagestory.API.Util;
 
 namespace AdminToolkit
 {
 	public class BannerControl : AdminModCommand
 	{
+		private const string _bannerDataKey = @"banners";
+
+		private BannerList Banners { get; set; }
+
 		/// <summary>
 		/// Control and Configuration of automatic Broadcast 'banners' / M.O.T.H.
 		/// </summary>
@@ -30,17 +36,69 @@ namespace AdminToolkit
 		this.Command = "banners";
 		this.Description = "Control future broadcast 'banners' & repeating Messages";
 		this.RequiredPrivilege = Privilege.announce;
+		this.Syntax = @"Add / Remove / Replace / List";
 		this.handler += HandleBannerCommand;
 		}
 
 		private void ReactivateBanners( )
 		{
+		var bannerBytes = ServerAPI.WorldManager.SaveGame.GetData(_bannerDataKey);
+
+		if (bannerBytes != null) {
+		this.Banners = SerializerUtil.Deserialize<BannerList>(bannerBytes);
+		Logger.Notification("Loaded Banners Data; ({0})", Banners.Count);
+		}
+		else {
+		BannerList emptyBannerList = new BannerList( );
+
+		var emptybannerListBytes = SerializerUtil.Serialize<BannerList>(emptyBannerList);
+
+		ServerAPI.WorldManager.SaveGame.StoreData(_bannerDataKey, emptybannerListBytes);
+
+		this.Banners = emptyBannerList;
+		Logger.Notification("Created (empty) Banners Data");
+		}
+
 
 		}
 
 
 		private void HandleBannerCommand(IServerPlayer player, int groupId, CmdArgs args)
 		{
+			
+		if (args.Length >= 1) {
+		string cmd = args.PopWord(string.Empty);
+		switch (cmd.ToLowerInvariant()) 
+		{
+		//Add <slot#> <repeat/once> <DD:HH:MM:SS> "text"
+		//Remove <slot#>
+		//Replace <slot#> "text"
+		//List
+		case "add":
+
+		break;
+
+		case "remove":
+
+		break;
+
+		case "replace":
+
+		break;
+
+		case "list":
+
+		break;
+
+		default:
+		player.SendMessage(groupId, "Unrecognised command ", EnumChatType.CommandError);
+		break;
+
+		}
+		}
+		else {
+		player.SendMessage(groupId, "Supply a command verb", EnumChatType.CommandError);
+		}
 
 		}
 
@@ -48,16 +106,37 @@ namespace AdminToolkit
 		public struct BannerEntry
 		{
 			[ProtoMember(1)]
-			public string Message;
+			public byte Entry;
 
 			[ProtoMember(2)]
-			public TimeSpan EventTime;
+			public string Message;
 
 			[ProtoMember(3)]
-			public bool Repeat;
+			public TimeSpan EventTime;//Delay between tick events
 
+			[ProtoMember(4)]
+			public bool Repeat;//Self Re-register on execution of tick event
+		}
 
+		[ProtoContract]
+		public class BannerList : KeyedCollection<byte, BannerEntry>
+		{
+			protected override byte GetKeyForItem(BannerEntry item)
+			{
+			return item.Entry;
+			}
+
+			public void Append(BannerEntry banner)
+			{
+			banner.Entry = ( byte )this.Count;
+			Add(banner);
+			}
+
+			private new void Add(BannerEntry item)
+			{
+				//Not directly.
+			}
 		}
-}
+	}
 }
 

--- /dev/null
+++ b/AdminToolkit/Commands/VariableSpawnpoints.cs
@@ -0,0 +1,243 @@
+using System;
+using System.Linq;
+using System.Collections.Generic;
+
+using Vintagestory.API.Common;
+using Vintagestory.API.Config;
+using Vintagestory.API.MathTools;
+using Vintagestory.API.Server;
+using Vintagestory.API.Util;
+
+using Vintagestory.Server;
+
+using ProtoBuf;
+
+
+namespace AdminToolkit
+{
+	[ProtoContract]
+	public struct Spawnpoint
+	{
+		[ProtoMember(1)]
+		public PlayerSpawnPos Location;
+
+		[ProtoMember(2)]
+		public string Name;
+
+		public Spawnpoint(string name, Vec3i loc)
+		{
+		Name = name;
+		Location = new PlayerSpawnPos {
+			x = loc.X,
+			y = loc.Y,
+			z = loc.Z
+		};
+		}
+
+	}
+
+	public class VariableSpawnpoints : AdminModCommand
+	{
+		private const string _spawnsDataKey = @"spawnpoints";
+		private Random random = new Random();
+
+		private List<Spawnpoint> Spawnpoints { get; set; }
+
+	
+		public VariableSpawnpoints(ICoreServerAPI _serverAPI) : base(_serverAPI)
+		{				
+		this.Command = "spawnpoints";
+		this.Description = "Control add/remove/adjust List of approved player spawn points";
+		this.RequiredPrivilege = Privilege.setspawn;
+		this.Syntax = @"Add {name} {123,456,-678}|here / Remove {name} / List / Enable / Disable";
+		this.handler += HandleCommand;
+
+		ServerAPI.Event.ServerRunPhase(EnumServerRunPhase.RunGame, ReloadSpawnpoints);
+		ServerAPI.Event.PlayerCreate += NewPlayerCreation;
+		ServerAPI.Event.PlayerDeath += PlayerDied;
+		ServerAPI.Event.ServerRunPhase(EnumServerRunPhase.Shutdown, PersistSpawnpoints);
+		}
+
+		private void ReloadSpawnpoints( )
+		{
+		var spawnsBytes = ServerAPI.WorldManager.SaveGame.GetData(_spawnsDataKey);
+
+		if (spawnsBytes != null) {
+		this.Spawnpoints = SerializerUtil.Deserialize<List<Spawnpoint>>(spawnsBytes);
+		Logger.Notification("Loaded Variable-Spawns # ({0})", Spawnpoints.Count);
+		}
+		else {
+		this.Spawnpoints = new List<Spawnpoint>( );
+
+		var emptySpawnsList = SerializerUtil.Serialize(this.Spawnpoints);
+
+		ServerAPI.WorldManager.SaveGame.StoreData(_spawnsDataKey, emptySpawnsList);
+						
+		Logger.Notification("Created (empty) Spawnpoints Data");
+		}
+
+		
+		}
+
+		private void PersistSpawnpoints( )
+		{			
+		if (this.Spawnpoints != null && this.Spawnpoints.Count > 0) {
+		var spawnDatas = SerializerUtil.Serialize(this.Spawnpoints);
+		ServerAPI.WorldManager.SaveGame.StoreData(_spawnsDataKey, spawnDatas);
+		Logger.Notification("Persisted Spawnpoints Data");
+		}
+
+		}
+
+		private void HandleCommand(IServerPlayer player, int groupId, CmdArgs args)
+		{
+		string name;
+		Vec3i position;
+		
+		
+
+		if (args.Length >= 1) {
+		string cmd = args.PopWord(string.Empty).ToLowerInvariant();
+		switch (cmd) {
+		
+		case "add":
+			name = args.PopWord("?");
+
+			if (String.Equals(args.PeekWord(), "here", StringComparison.OrdinalIgnoreCase)) {
+			position = player.Entity.Pos.XYZInt;
+			}
+			position = args.PopVec3i(player.Entity.Pos.XYZInt);			
+			if (AddSpawnpoint(name, position)) {
+			player.SendMessage(groupId, "Added Spawnpoint", EnumChatType.CommandSuccess);
+			}
+			break;
+
+		case "remove":
+			name = args.PopWord( );
+			if (RemoveSpawnpoint(name)) {
+			player.SendMessage(groupId, "Removed Spawnpoint", EnumChatType.CommandSuccess);
+			}
+			break;
+
+		case "list":
+			ListSpawnpoints(groupId, player);
+			break;
+
+		case "enable":
+			Toggle(true);
+			break;
+			
+		case "disable":
+			Toggle(false);
+			break;
+
+		default:
+			player.SendMessage(groupId, "Unrecognised command ", EnumChatType.CommandError);
+			break;
+
+		}
+		}
+		else {
+		player.SendMessage(groupId, "Supply a command verb", EnumChatType.CommandError);
+		}
+
+		}
+
+		private bool AddSpawnpoint(string name, Vec3i position)
+		{
+		//Check position is 'safe'; 2~ blocks air, and solid block BELOW...
+		var surfaceBlock = ServerAPI.World.BlockAccessor.GetBlock(position.AsBlockPos);
+		var aboveBlock = ServerAPI.World.BlockAccessor.GetBlock(position.AddCopy(BlockFacing.UP).AsBlockPos);
+		var belowBlock = ServerAPI.World.BlockAccessor.GetBlock(position.AddCopy(BlockFacing.DOWN).AsBlockPos);
+
+		if (belowBlock.MatterState == EnumMatterState.Solid &&
+			aboveBlock.BlockMaterial == EnumBlockMaterial.Air &&
+			surfaceBlock.BlockMaterial == EnumBlockMaterial.Air) {
+		//Appears OK...
+		Logger.VerboseDebug($"Adding variable spawnpoint '{name}' @ {position}");
+		var newSpawnpoint = new Spawnpoint(name, position);
+
+		this.Spawnpoints.Add(newSpawnpoint);
+		return true;
+		}
+		else {
+		Logger.VerboseDebug($"Apparently spawnpoint Unsafe! @ {position}");	
+		}
+
+		return false;
+		}
+
+		private bool RemoveSpawnpoint(string name)
+		{
+
+		if (this.Spawnpoints.Count > 0) {
+		var count = this.Spawnpoints.RemoveAll(sp => String.Equals(sp.Name, name, StringComparison.InvariantCultureIgnoreCase));
+		return count > 0;
+		}
+
+		return false;
+		}
+
+		private void ListSpawnpoints( int chatGroupId, IServerPlayer player )
+		{
+		if (this.Spawnpoints.Count > 0) {
+		foreach (var sp in this.Spawnpoints) {
+		player.SendMessage(chatGroupId, $"Spawn: '{sp.Name}' @({sp.Location})", EnumChatType.CommandSuccess);
+		}
+		}
+		}
+
+		private void Toggle(bool state)
+		{
+		this.CachedConfiguration.VariableSpawnpoints = state;
+		}
+
+		private void NewPlayerCreation( IServerPlayer byPlayer)
+		{			
+		if (this.CachedConfiguration.VariableSpawnpoints && this.Spawnpoints.Count > 0) {
+				
+		var swpd = byPlayer.WorldData as ServerWorldPlayerData;
+		if (swpd.SpawnPosition == null) {
+		var newSP = RandomSpawnpoint( );
+		byPlayer.SetSpawnPosition(newSP.Location);
+		#if DEBUG
+		Logger.VerboseDebug($"New spawn Pos: '{newSP.Name}' @ {newSP.Location} ");
+		#endif
+		}
+		}
+		}
+
+		private void PlayerDied(IServerPlayer byPlayer, DamageSource damageSource)
+		{
+		if (this.CachedConfiguration.VariableSpawnpoints && this.Spawnpoints.Count > 0) {
+
+		var swpd = byPlayer.WorldData as ServerWorldPlayerData;
+		if (swpd.SpawnPosition == null || KnownSpawn(swpd.SpawnPosition)) {
+		var newSP = RandomSpawnpoint( );
+		byPlayer.SetSpawnPosition(newSP.Location);
+		#if DEBUG
+		Logger.VerboseDebug( $"Changed spawn Pos: '{newSP.Name}' @ {newSP.Location} ");
+		#endif
+		}
+		}
+		}
+
+		private Spawnpoint RandomSpawnpoint( )
+		{
+		return this.Spawnpoints[random.Next(0, Spawnpoints.Count - 1)];
+		}
+
+		private bool KnownSpawn(PlayerSpawnPos aSpawn)
+		{
+		if (this.Spawnpoints.Count > 0) {
+		return this.Spawnpoints.Any(vsps => vsps.Location.x == aSpawn.x 
+				                    && vsps.Location.y == aSpawn.y 
+				                    && vsps.Location.z == aSpawn.z);
+		}
+
+		return false;
+		}
+	}
+}
+
+

--- a/AdminToolkit/modinfo.json
+++ b/AdminToolkit/modinfo.json
@@ -1,11 +1,11 @@
 {
   "type": "code",
   "name": "Administrator's Toolkit mod",
-  "description" : "Provides misc. Admin functions;\n list admins, print & accept rules (multi-lingual) , auto-backup...",
+  "description" : "Provides misc. Admin functions;\n admin listing, rules display (multi-lingual), auto-backup & more...",
   "authors": ["Melchior", ],
-  "version": "0.3.5",
+  "version": "0.3.6",
   "dependencies": { 
-	"game": "1.12.4"	
+	"game": "1.13.0"	
   },
   "requiredonclient":false,
   "website": "https://osdn.net/users/melchior/pf/admintoolkit/"