提交: ca0f0d1c56f86ab1dddfe64e3900f6743b50b603 - admintoolkit (git)

Administrator's Toolkit VS plugin

Commit MetaInfo

• 修订版: ca0f0d1c56f86ab1dddfe64e3900f6743b50b603 (tree)
• 时间: 2022-06-22 10:18:57
• 作者: melchior <melchior@user...>
• Commiter: melchior

Log Message

Idler W.I.P. ,

更改概述

• modified: AdminToolkit/AdminModConfig.cs
• modified: AdminToolkit/AdminToolkit.csproj
• modified: AdminToolkit/AdminToolkitMod.cs
• add: AdminToolkit/Commands/IdlePlayerControl.cs
• modified: AdminToolkit/assets/atk/lang/en.json

差异

--- a/AdminToolkit/AdminModConfig.cs
+++ b/AdminToolkit/AdminModConfig.cs
@@ -54,6 +54,12 @@ namespace AdminToolkit
 		/// </summary>
 		public bool VariableSpawnpoints { get; set; }
 
+		/// <summary>
+		/// Time to permit players to Idle (no movement), before Auto-kick
+		/// </summary>
+		/// <value>Time span</value>
+		public TimeSpan IdleTimeout { get; set; }
+
 		public AdminModConfig( )
 		{
 			this.PlayerRoleRestrain = "suvisitor";
@@ -64,6 +70,7 @@ namespace AdminToolkit
 			this.BackupDelay = new TimeSpan(4, 0, 0);
 			this.BackupCount = 6;
 			this.Autobackup = false;
+			this.IdleTimeout = new TimeSpan(0, 0, 0);// 0 = OFF
 		}
 
 

--- a/AdminToolkit/AdminToolkit.csproj
+++ b/AdminToolkit/AdminToolkit.csproj
@@ -83,6 +83,7 @@
     <Compile Include="Commands\VariableSpawnpoints.cs" />
     <Compile Include="ATK_BasicFeatures.cs" />
     <Compile Include="Helpers\MultiLang.cs" />
+    <Compile Include="Commands\IdlePlayerControl.cs" />
   </ItemGroup>
   <ItemGroup>
     <Folder Include="VS_libs\" />

--- a/AdminToolkit/AdminToolkitMod.cs
+++ b/AdminToolkit/AdminToolkitMod.cs
@@ -28,10 +28,10 @@ namespace AdminToolkit
 		 * [DONE] Keeps track of Elapsed game calendar days for players
 		 * [DONE] Alter ADMIN text to look 'different' (optional)
 		 * [DONE] Cyclic automatic Backups
-		 * [WIP} Broadcast messages, on a schedule ??????
-		 * [???] Custom Server name : custom formats to indicate server state/time/things
-		 * [IDEA]: Player VIRTUAL (temp) Inventory; Move Player inventory to alternate [world] D.B. as Inventory backup
-		 * [WIP]: Variable Player (re)Spawn points from a list ~ at random
+		 * [WIP]  Broadcast messages, on a schedule ??????
+		 * [RSCH] Custom Server name : custom formats to indicate server state/time/season/things		 
+		 * [DONE?]: Variable Player (re)Spawn points from a list ~ at random
+		 * [RSCH] Idle player eject on time(out)
 		 * 
 		 * WORKAROUND -- Localized messages are by SERVERS Native Language code...Not the players...
 		 */
@@ -109,6 +109,8 @@ namespace AdminToolkit
 			this.ServerAPI.RegisterCommand(new BackupCycleCommand(this.ServerAPI) );
 			//this.ServerAPI.RegisterCommand(new BannerControl(this.ServerAPI));
 			this.ServerAPI.RegisterCommand(new PingerCommand(this.ServerAPI));
+			this.ServerAPI.RegisterCommand(new IdlePlayerControl(this.ServerAPI));
+
 			if (this.CachedConfiguration.VariableSpawnpoints) { this.ServerAPI.RegisterCommand(new VariableSpawnpoints(this.ServerAPI)); }
 
 			if (CachedConfiguration.BoomingVoice) {

--- /dev/null
+++ b/AdminToolkit/Commands/IdlePlayerControl.cs
@@ -0,0 +1,124 @@
+using System;
+
+using System.Linq;
+using System.Text;
+using System.Collections.Generic;
+
+using Vintagestory.API.Common;
+using Vintagestory.API.Server;
+using Vintagestory.Server;
+using Vintagestory.API.Common.Entities;
+
+namespace AdminToolkit
+{
+	public class IdlePlayerControl : AdminModCommand
+	{
+		const string idleKick_Key = @"atk:idle-kick";
+
+		uint kick_tally;
+		long timerIdent;
+
+		Dictionary<string, EntityPos> playerPositions;
+
+
+		public IdlePlayerControl(ICoreServerAPI _serverAPI) : base(_serverAPI)
+		{
+		playerPositions = new Dictionary<string, EntityPos>(32);
+		this.Command = "idlekick";
+		this.Description = "Adjust Idle-ejector system settings.";
+		this.Syntax = @" set {time} | stats ";
+		this.RequiredPrivilege = Privilege.kick;
+		this.handler += HandleIdlerCommand;
+		ServerAPI.Event.PlayerLeave += PlayerLeft;
+		ServerAPI.Event.PlayerDisconnect += PlayerLeft;
+		
+		if (this.CachedConfiguration.IdleTimeout.TotalMinutes >= 5f) {
+		ServerAPI.Event.ServerRunPhase(EnumServerRunPhase.RunGame, RestartTimers);
+		}
+
+		}
+
+		private void HandleIdlerCommand(IServerPlayer player, int groupId, CmdArgs args)
+		{
+		var command = args.PopWord(string.Empty).ToLowerInvariant();
+
+		switch (command) {				
+			case @"set":
+				//Change default & next cycle check time
+				var timeMinutes = args.PopInt(0);
+				if (timeMinutes >= 5) {
+				TimeSpan newTimeout = new TimeSpan(0, timeMinutes.Value, 0);
+				this.CachedConfiguration.IdleTimeout = newTimeout;
+				player.SendMessage(groupId, $"Changed Idle timeout to: {newTimeout}", EnumChatType.CommandSuccess);
+				RestartTimers();
+				} else 
+					player.SendMessage(groupId, "no change; Value must be >= 5", EnumChatType.CommandError);
+			break;
+
+			case @"stats":
+			if (this.CachedConfiguration.IdleTimeout.TotalMinutes >= 5f) 
+				{ player.SendMessage(groupId, $"Ejected: {kick_tally} player(s), Timeout = {this.CachedConfiguration.IdleTimeout}", EnumChatType.CommandSuccess); }
+				else { player.SendMessage(groupId, "offline.", EnumChatType.CommandSuccess);	}
+			break;
+
+			default:			
+				player.SendMessage(groupId, $"Unrecognised command: {command}", EnumChatType.CommandError);
+			break;
+			}
+		}
+
+		private void RestartTimers( )
+		{			
+		if (timerIdent != 0L) 
+			{
+			ServerAPI.Event.UnregisterCallback(timerIdent);
+			playerPositions.Clear( );
+			FindIdlers(0f );
+			}
+		timerIdent = ServerAPI.Event.RegisterCallback(FindIdlers, ( int )this.CachedConfiguration.IdleTimeout.TotalMilliseconds);
+		}
+
+		private void FindIdlers(float delta )
+		{
+		#if DEBUG
+		Logger.VerboseDebug("Starting idle player check");
+		#endif
+
+		foreach (var srvPlayer in ServerAPI.Server.Players.Where(plr => plr.ConnectionState == EnumClientState.Playing)) {
+			if (srvPlayer?.WorldData?.CurrentGameMode != EnumGameMode.Spectator) {
+				EntityPos oldPos;
+				if (playerPositions.TryGetValue(srvPlayer.PlayerUID, out oldPos)) {
+					if (oldPos.BasicallySameAsIgnoreAngles(srvPlayer.Entity.ServerPos, 0.001f)) {
+							if ( srvPlayer.Entity.CurrentControls.HasFlag( EnumEntityActivity.Idle) ||
+							    srvPlayer.Entity.CurrentControls.HasFlag(EnumEntityActivity.FloorSitting) ||
+							    srvPlayer.Entity.CurrentControls.HasFlag(EnumEntityActivity.Dead) ||
+							    srvPlayer.Entity.CurrentControls.HasFlag(EnumEntityActivity.None) )
+							{
+								//Eee's not movin' 
+								KickIdler(srvPlayer);
+							}
+
+						}
+				}
+				else {
+					playerPositions.Add(srvPlayer.PlayerUID, srvPlayer.Entity.ServerPos);
+					}
+				}
+			}
+		}
+
+		private void KickIdler(IServerPlayer them)
+		{
+		kick_tally++;
+		var message = MultiLang.Get(them.LanguageCode, idleKick_Key, them.PlayerName);
+		them.Disconnect(message);		 
+		ServerAPI.BroadcastMessageToAllGroups(message, EnumChatType.Notification);
+		}
+
+		private void PlayerLeft(IServerPlayer byPlayer)
+		{
+		if (playerPositions.ContainsKey(byPlayer.PlayerUID)) playerPositions.Remove(byPlayer.PlayerUID);
+		}
+}
+}
+

--- a/AdminToolkit/assets/atk/lang/en.json
+++ b/AdminToolkit/assets/atk/lang/en.json
@@ -10,4 +10,5 @@
 	"atk:accepted-rules":"{0} HAS ACCEPTED THE RULES!",
 	"atk:promoted-to":"{0} have been promoted to: {1}",
 	"atk:demoted-to":"{0} have been demoted to: {1}",
+    "atk:idle-kick":"{0} Ejected because of Idleness...",
 }