using System; using System.Collections.Generic; using System.Linq; using System.Net.Sockets; using System.Text; using System.Threading; using System.Transactions; using MinecraftClient.ChatBots; using MinecraftClient.Inventory; using MinecraftClient.Logger; using MinecraftClient.Mapping; using MinecraftClient.Protocol; using MinecraftClient.Protocol.Handlers.Forge; using MinecraftClient.Protocol.Keys; using MinecraftClient.Protocol.Message; using MinecraftClient.Protocol.Session; using MinecraftClient.Proxy; using static MinecraftClient.Settings; namespace MinecraftClient { /// /// The main client class, used to connect to a Minecraft server. /// public class McClient : IMinecraftComHandler { public static int ReconnectionAttemptsLeft = 0; private static readonly List cmd_names = new(); private static readonly Dictionary cmds = new(); private readonly Dictionary onlinePlayers = new(); private static bool commandsLoaded = false; private readonly Queue chatQueue = new(); private static DateTime nextMessageSendTime = DateTime.MinValue; private readonly Queue threadTasks = new(); private readonly object threadTasksLock = new(); private readonly List bots = new(); private static readonly List botsOnHold = new(); private static readonly Dictionary inventories = new(); private readonly Dictionary> registeredBotPluginChannels = new(); private readonly List registeredServerPluginChannels = new(); private bool terrainAndMovementsEnabled; private bool terrainAndMovementsRequested = false; private bool inventoryHandlingEnabled; private bool inventoryHandlingRequested = false; private bool entityHandlingEnabled; private readonly object locationLock = new(); private bool locationReceived = false; private readonly World world = new(); private Queue? steps; private Queue? path; private Location location; private float? _yaw; // Used for calculation ONLY!!! Doesn't reflect the client yaw private float? _pitch; // Used for calculation ONLY!!! Doesn't reflect the client pitch private float playerYaw; private float playerPitch; private double motionY; public enum MovementType { Sneak, Walk, Sprint } private int sequenceId; // User for player block synchronization (Aka. digging, placing blocks, etc..) private readonly string host; private readonly int port; private readonly int protocolversion; private readonly string username; private Guid uuid; private string uuidStr; private readonly string sessionid; private readonly PlayerKeyPair? playerKeyPair; private DateTime lastKeepAlive; private readonly object lastKeepAliveLock = new(); private int respawnTicks = 0; private int gamemode = 0; private bool isSupportPreviewsChat; private int playerEntityID; // player health and hunger private float playerHealth; private int playerFoodSaturation; private int playerLevel; private int playerTotalExperience; private byte CurrentSlot = 0; // Entity handling private readonly Dictionary entities = new(); // server TPS private long lastAge = 0; private DateTime lastTime; private double serverTPS = 0; private double averageTPS = 20; private const int maxSamples = 5; private readonly List tpsSamples = new(maxSamples); private double sampleSum = 0; // ChatBot OnNetworkPacket event private bool networkPacketCaptureEnabled = false; public int GetServerPort() { return port; } public string GetServerHost() { return host; } public string GetUsername() { return username; } public Guid GetUserUuid() { return uuid; } public string GetUserUuidStr() { return uuidStr; } public string GetSessionID() { return sessionid; } public Location GetCurrentLocation() { return location; } public float GetYaw() { return playerYaw; } public int GetSequenceId() { return sequenceId; } public float GetPitch() { return playerPitch; } public World GetWorld() { return world; } public double GetServerTPS() { return averageTPS; } public bool GetIsSupportPreviewsChat() { return isSupportPreviewsChat; } public float GetHealth() { return playerHealth; } public int GetSaturation() { return playerFoodSaturation; } public int GetLevel() { return playerLevel; } public int GetTotalExperience() { return playerTotalExperience; } public byte GetCurrentSlot() { return CurrentSlot; } public int GetGamemode() { return gamemode; } public bool GetNetworkPacketCaptureEnabled() { return networkPacketCaptureEnabled; } public int GetProtocolVersion() { return protocolversion; } public ILogger GetLogger() { return Log; } public int GetPlayerEntityID() { return playerEntityID; } public List GetLoadedChatBots() { return new List(bots); } readonly TcpClient client; readonly IMinecraftCom handler; CancellationTokenSource? cmdprompt = null; Tuple? timeoutdetector = null; public ILogger Log; /// /// Starts the main chat client, wich will login to the server using the MinecraftCom class. /// /// A valid session obtained with MinecraftCom.GetLogin() /// Key for message signing /// The server IP /// The server port to use /// Minecraft protocol version to use /// ForgeInfo item stating that Forge is enabled public McClient(SessionToken session, PlayerKeyPair? playerKeyPair, string server_ip, ushort port, int protocolversion, ForgeInfo? forgeInfo) { terrainAndMovementsEnabled = Config.Main.Advanced.TerrainAndMovements; inventoryHandlingEnabled = Config.Main.Advanced.InventoryHandling; entityHandlingEnabled = Config.Main.Advanced.EntityHandling; sessionid = session.ID; if (!Guid.TryParse(session.PlayerID, out uuid)) uuid = Guid.Empty; uuidStr = session.PlayerID; username = session.PlayerName; host = server_ip; this.port = port; this.protocolversion = protocolversion; this.playerKeyPair = playerKeyPair; Log = Settings.Config.Logging.LogToFile ? new FileLogLogger(Config.AppVar.ExpandVars(Settings.Config.Logging.LogFile), Settings.Config.Logging.PrependTimestamp) : new FilteredLogger(); Log.DebugEnabled = Config.Logging.DebugMessages; Log.InfoEnabled = Config.Logging.InfoMessages; Log.ChatEnabled = Config.Logging.ChatMessages; Log.WarnEnabled = Config.Logging.WarningMessages; Log.ErrorEnabled = Config.Logging.ErrorMessages; /* Load commands from Commands namespace */ LoadCommands(); if (botsOnHold.Count == 0) RegisterBots(); try { client = ProxyHandler.NewTcpClient(host, port); client.ReceiveBufferSize = 1024 * 1024; client.ReceiveTimeout = Config.Main.Advanced.TcpTimeout * 1000; // Default: 30 seconds handler = Protocol.ProtocolHandler.GetProtocolHandler(client, protocolversion, forgeInfo, this); Log.Info(Translations.Get("mcc.version_supported")); timeoutdetector = new(new Thread(new ParameterizedThreadStart(TimeoutDetector)), new CancellationTokenSource()); timeoutdetector.Item1.Name = "MCC Connection timeout detector"; timeoutdetector.Item1.Start(timeoutdetector.Item2.Token); try { if (handler.Login(this.playerKeyPair, session)) { foreach (ChatBot bot in botsOnHold) BotLoad(bot, false); botsOnHold.Clear(); Log.Info(Translations.Get("mcc.joined", Config.Main.Advanced.InternalCmdChar.ToLogString())); cmdprompt = new CancellationTokenSource(); ConsoleInteractive.ConsoleReader.BeginReadThread(cmdprompt); ConsoleInteractive.ConsoleReader.MessageReceived += ConsoleReaderOnMessageReceived; ConsoleInteractive.ConsoleReader.OnKeyInput += ConsoleIO.AutocompleteHandler; } else { Log.Error(Translations.Get("error.login_failed")); goto Retry; } } catch (Exception e) { Log.Error(e.GetType().Name + ": " + e.Message); Log.Error(Translations.Get("error.join")); goto Retry; } } catch (SocketException e) { Log.Error(e.Message); Log.Error(Translations.Get("error.connect")); goto Retry; } return; Retry: if (timeoutdetector != null) { timeoutdetector.Item2.Cancel(); timeoutdetector = null; } if (ReconnectionAttemptsLeft > 0) { Log.Info(Translations.Get("mcc.reconnect", ReconnectionAttemptsLeft)); Thread.Sleep(5000); ReconnectionAttemptsLeft--; Program.Restart(); } else if (InternalConfig.InteractiveMode) { ConsoleInteractive.ConsoleReader.StopReadThread(); ConsoleInteractive.ConsoleReader.MessageReceived -= ConsoleReaderOnMessageReceived; ConsoleInteractive.ConsoleReader.OnKeyInput -= ConsoleIO.AutocompleteHandler; Program.HandleFailure(); } throw new Exception("Initialization failed."); } /// /// Register bots /// private void RegisterBots(bool reload = false) { if (Config.ChatBot.Alerts.Enabled) { BotLoad(new Alerts()); } if (Config.ChatBot.AntiAFK.Enabled) { BotLoad(new AntiAFK()); } if (Config.ChatBot.AutoAttack.Enabled) { BotLoad(new AutoAttack()); } if (Config.ChatBot.AutoCraft.Enabled) { BotLoad(new AutoCraft()); } if (Config.ChatBot.AutoDig.Enabled) { BotLoad(new AutoDig()); } if (Config.ChatBot.AutoDrop.Enabled) { BotLoad(new AutoDrop()); } if (Config.ChatBot.AutoEat.Enabled) { BotLoad(new AutoEat()); } if (Config.ChatBot.AutoFishing.Enabled) { BotLoad(new AutoFishing()); } if (Config.ChatBot.AutoRelog.Enabled) { BotLoad(new AutoRelog()); } if (Config.ChatBot.AutoRespond.Enabled) { BotLoad(new AutoRespond()); } if (Config.ChatBot.ChatLog.Enabled) { BotLoad(new ChatLog()); } if (Config.ChatBot.Farmer.Enabled) { BotLoad(new Farmer()); } if (Config.ChatBot.FollowPlayer.Enabled) { BotLoad(new FollowPlayer()); } if (Config.ChatBot.HangmanGame.Enabled) { BotLoad(new HangmanGame()); } if (Config.ChatBot.Mailer.Enabled) { BotLoad(new Mailer()); } if (Config.ChatBot.Map.Enabled) { BotLoad(new Map()); } if (Config.ChatBot.PlayerListLogger.Enabled) { BotLoad(new PlayerListLogger()); } if (Config.ChatBot.RemoteControl.Enabled) { BotLoad(new RemoteControl()); } if (Config.ChatBot.ReplayCapture.Enabled && reload) { BotLoad(new ReplayCapture()); } if (Config.ChatBot.ScriptScheduler.Enabled) { BotLoad(new ScriptScheduler()); } //Add your ChatBot here by uncommenting and adapting //BotLoad(new ChatBots.YourBot()); } /// /// Retrieve messages from the queue and send. /// Note: requires external locking. /// private void TrySendMessageToServer() { while (chatQueue.Count > 0 && nextMessageSendTime < DateTime.Now) { string text = chatQueue.Dequeue(); handler.SendChatMessage(text, playerKeyPair); nextMessageSendTime = DateTime.Now + TimeSpan.FromSeconds(Config.Main.Advanced.MessageCooldown); } } /// /// Called ~10 times per second by the protocol handler /// public void OnUpdate() { foreach (ChatBot bot in bots.ToArray()) { try { bot.Update(); bot.UpdateInternal(); } catch (Exception e) { if (e is not ThreadAbortException) Log.Warn("Update: Got error from " + bot.ToString() + ": " + e.ToString()); else throw; //ThreadAbortException should not be caught } } lock (chatQueue) { TrySendMessageToServer(); } if (terrainAndMovementsEnabled && locationReceived) { lock (locationLock) { for (int i = 0; i < Config.Main.Advanced.MovementSpeed; i++) //Needs to run at 20 tps; MCC runs at 10 tps { if (_yaw == null || _pitch == null) { if (steps != null && steps.Count > 0) { location = steps.Dequeue(); } else if (path != null && path.Count > 0) { Location next = path.Dequeue(); steps = Movement.Move2Steps(location, next, ref motionY); if (Config.Main.Advanced.MoveHeadWhileWalking) // Disable head movements to avoid anti-cheat triggers UpdateLocation(location, next + new Location(0, 1, 0)); // Update yaw and pitch to look at next step } else { location = Movement.HandleGravity(world, location, ref motionY); } } playerYaw = _yaw == null ? playerYaw : _yaw.Value; playerPitch = _pitch == null ? playerPitch : _pitch.Value; handler.SendLocationUpdate(location, Movement.IsOnGround(world, location), _yaw, _pitch); } // First 2 updates must be player position AND look, and player must not move (to conform with vanilla) // Once yaw and pitch have been sent, switch back to location-only updates (without yaw and pitch) _yaw = null; _pitch = null; } } if (Config.Main.Advanced.AutoRespawn && respawnTicks > 0) { respawnTicks--; if (respawnTicks == 0) SendRespawnPacket(); } lock (threadTasksLock) { while (threadTasks.Count > 0) { Action taskToRun = threadTasks.Dequeue(); taskToRun(); } } } #region Connection Lost and Disconnect from Server /// /// Periodically checks for server keepalives and consider that connection has been lost if the last received keepalive is too old. /// private void TimeoutDetector(object? o) { UpdateKeepAlive(); do { Thread.Sleep(TimeSpan.FromSeconds(15)); if (((CancellationToken)o!).IsCancellationRequested) return; lock (lastKeepAliveLock) { if (lastKeepAlive.AddSeconds(Config.Main.Advanced.TcpTimeout) < DateTime.Now) { if (((CancellationToken)o!).IsCancellationRequested) return; OnConnectionLost(ChatBot.DisconnectReason.ConnectionLost, Translations.Get("error.timeout")); return; } } } while (!((CancellationToken)o!).IsCancellationRequested); } /// /// Update last keep alive to current time /// private void UpdateKeepAlive() { lock (lastKeepAliveLock) { lastKeepAlive = DateTime.Now; } } /// /// Disconnect the client from the server (initiated from MCC) /// public void Disconnect() { DispatchBotEvent(bot => bot.OnDisconnect(ChatBot.DisconnectReason.UserLogout, "")); botsOnHold.Clear(); botsOnHold.AddRange(bots); if (handler != null) { handler.Disconnect(); handler.Dispose(); } if (cmdprompt != null) { cmdprompt.Cancel(); cmdprompt = null; } if (timeoutdetector != null) { timeoutdetector.Item2.Cancel(); timeoutdetector = null; } if (client != null) client.Close(); } /// /// When connection has been lost, login was denied or played was kicked from the server /// public void OnConnectionLost(ChatBot.DisconnectReason reason, string message) { handler.Dispose(); world.Clear(); if (timeoutdetector != null) { if (timeoutdetector != null && Thread.CurrentThread != timeoutdetector.Item1) timeoutdetector.Item2.Cancel(); timeoutdetector = null; } bool will_restart = false; switch (reason) { case ChatBot.DisconnectReason.ConnectionLost: message = Translations.Get("mcc.disconnect.lost"); Log.Info(message); break; case ChatBot.DisconnectReason.InGameKick: Log.Info(Translations.Get("mcc.disconnect.server")); Log.Info(message); break; case ChatBot.DisconnectReason.LoginRejected: Log.Info(Translations.Get("mcc.disconnect.login")); Log.Info(message); break; case ChatBot.DisconnectReason.UserLogout: throw new InvalidOperationException(Translations.Get("exception.user_logout")); } //Process AutoRelog last to make sure other bots can perform their cleanup tasks first (issue #1517) List onDisconnectBotList = bots.Where(bot => bot is not AutoRelog).ToList(); onDisconnectBotList.AddRange(bots.Where(bot => bot is AutoRelog)); foreach (ChatBot bot in onDisconnectBotList) { try { will_restart |= bot.OnDisconnect(reason, message); } catch (Exception e) { if (e is not ThreadAbortException) { Log.Warn("OnDisconnect: Got error from " + bot.ToString() + ": " + e.ToString()); } else throw; //ThreadAbortException should not be caught } } if (!will_restart) { ConsoleInteractive.ConsoleReader.StopReadThread(); ConsoleInteractive.ConsoleReader.MessageReceived -= ConsoleReaderOnMessageReceived; ConsoleInteractive.ConsoleReader.OnKeyInput -= ConsoleIO.AutocompleteHandler; Program.HandleFailure(); } } #endregion #region Command prompt and internal MCC commands private void ConsoleReaderOnMessageReceived(object? sender, string e) { if (client.Client == null) return; if (client.Client.Connected) { new Thread(() => { InvokeOnMainThread(() => HandleCommandPromptText(e)); }).Start(); } else return; } /// /// Allows the user to send chat messages, commands, and leave the server. /// Process text from the MCC command prompt on the main thread. /// private void HandleCommandPromptText(string text) { if (ConsoleIO.BasicIO && text.Length > 0 && text[0] == (char)0x00) { //Process a request from the GUI string[] command = text[1..].Split((char)0x00); switch (command[0].ToLower()) { case "autocomplete": if (command.Length > 1) { ConsoleIO.WriteLine((char)0x00 + "autocomplete" + (char)0x00 + handler.AutoComplete(command[1])); } else ConsoleIO.WriteLine((char)0x00 + "autocomplete" + (char)0x00); break; } } else { text = text.Trim(); if (text.Length > 0) { if (Config.Main.Advanced.InternalCmdChar.ToChar() == ' ' || text[0] == Config.Main.Advanced.InternalCmdChar.ToChar()) { string? response_msg = ""; string command = Config.Main.Advanced.InternalCmdChar.ToChar() == ' ' ? text : text[1..]; if (!PerformInternalCommand(Config.AppVar.ExpandVars(command), ref response_msg, Settings.Config.AppVar.GetVariables()) && Config.Main.Advanced.InternalCmdChar.ToChar() == '/') { SendText(text); } else if (!String.IsNullOrEmpty(response_msg)) { Log.Info(response_msg); } } else SendText(text); } } } /// /// Register a custom console command /// /// Name of the command /// Description/usage of the command /// Method for handling the command /// True if successfully registered public bool RegisterCommand(string cmdName, string cmdDesc, string cmdUsage, ChatBot.CommandRunner callback) { if (cmds.ContainsKey(cmdName.ToLower())) { return false; } else { Command cmd = new ChatBot.ChatBotCommand(cmdName, cmdDesc, cmdUsage, callback); cmds.Add(cmdName.ToLower(), cmd); cmd_names.Add(cmdName.ToLower()); return true; } } /// /// Unregister a console command /// /// /// There is no check for the command is registered by above method or is embedded command. /// Which mean this can unload any command /// /// The name of command to be unregistered /// public bool UnregisterCommand(string cmdName) { if (cmds.ContainsKey(cmdName.ToLower())) { cmds.Remove(cmdName.ToLower()); cmd_names.Remove(cmdName.ToLower()); return true; } else return false; } /// /// Perform an internal MCC command (not a server command, use SendText() instead for that!) /// /// The command /// May contain a confirmation or error message after processing the command, or "" otherwise. /// Local variables passed along with the command /// TRUE if the command was indeed an internal MCC command public bool PerformInternalCommand(string command, ref string? response_msg, Dictionary? localVars = null) { /* Process the provided command */ string command_name = command.Split(' ')[0].ToLower(); if (command_name == "help") { if (Command.HasArg(command)) { string help_cmdname = Command.GetArgs(command)[0].ToLower(); if (help_cmdname == "help") { response_msg = Translations.Get("icmd.help"); } else if (cmds.ContainsKey(help_cmdname)) { response_msg = cmds[help_cmdname].GetCmdDescTranslated(); } else response_msg = Translations.Get("icmd.unknown", command_name); } else response_msg = Translations.Get("icmd.list", String.Join(", ", cmd_names.ToArray()), Config.Main.Advanced.InternalCmdChar.ToChar()); } else if (cmds.ContainsKey(command_name)) { response_msg = cmds[command_name].Run(this, command, localVars); foreach (ChatBot bot in bots.ToArray()) { try { bot.OnInternalCommand(command_name, string.Join(" ", Command.GetArgs(command)), response_msg); } catch (Exception e) { if (e is not ThreadAbortException) { Log.Warn(Translations.Get("icmd.error", bot.ToString() ?? string.Empty, e.ToString())); } else throw; //ThreadAbortException should not be caught } } } else { response_msg = Translations.Get("icmd.unknown", command_name); return false; } return true; } public void LoadCommands() { /* Load commands from the 'Commands' namespace */ if (!commandsLoaded) { Type[] cmds_classes = Program.GetTypesInNamespace("MinecraftClient.Commands"); foreach (Type type in cmds_classes) { if (type.IsSubclassOf(typeof(Command))) { try { Command cmd = (Command)Activator.CreateInstance(type)!; cmds[Settings.ToLowerIfNeed(cmd.CmdName)] = cmd; cmd_names.Add(Settings.ToLowerIfNeed(cmd.CmdName)); foreach (string alias in cmd.GetCMDAliases()) cmds[Settings.ToLowerIfNeed(alias)] = cmd; } catch (Exception e) { Log.Warn(e.Message); } } } commandsLoaded = true; } } /// /// Reload settings and bots /// /// Marks if bots need to be hard reloaded public void ReloadSettings() { Program.ReloadSettings(); ReloadBots(); } /// /// Reload loaded bots (Only builtin bots) /// public void ReloadBots() { UnloadAllBots(); RegisterBots(true); if (client.Client.Connected) bots.ForEach(bot => bot.AfterGameJoined()); } /// /// Unload All Bots /// public void UnloadAllBots() { foreach (ChatBot bot in GetLoadedChatBots()) BotUnLoad(bot); } #endregion #region Thread-Invoke: Cross-thread method calls /// /// Invoke a task on the main thread, wait for completion and retrieve return value. /// /// Task to run with any type or return value /// Any result returned from task, result type is inferred from the task /// bool result = InvokeOnMainThread(methodThatReturnsAbool); /// bool result = InvokeOnMainThread(() => methodThatReturnsAbool(argument)); /// int result = InvokeOnMainThread(() => { yourCode(); return 42; }); /// Type of the return value public T InvokeOnMainThread(Func task) { if (!InvokeRequired) { return task(); } else { TaskWithResult taskWithResult = new(task); lock (threadTasksLock) { threadTasks.Enqueue(taskWithResult.ExecuteSynchronously); } return taskWithResult.WaitGetResult(); } } /// /// Invoke a task on the main thread and wait for completion /// /// Task to run without return value /// InvokeOnMainThread(methodThatReturnsNothing); /// InvokeOnMainThread(() => methodThatReturnsNothing(argument)); /// InvokeOnMainThread(() => { yourCode(); }); public void InvokeOnMainThread(Action task) { InvokeOnMainThread(() => { task(); return true; }); } /// /// Clear all tasks /// public void ClearTasks() { lock (threadTasksLock) { threadTasks.Clear(); } } /// /// Check if running on a different thread and InvokeOnMainThread is required /// /// True if calling thread is not the main thread public bool InvokeRequired { get { int callingThreadId = Environment.CurrentManagedThreadId; if (handler != null) { return handler.GetNetMainThreadId() != callingThreadId; } else { // net read thread (main thread) not yet ready return false; } } } #endregion #region Management: Load/Unload ChatBots and Enable/Disable settings /// /// Load a new bot /// public void BotLoad(ChatBot b, bool init = true) { if (InvokeRequired) { InvokeOnMainThread(() => BotLoad(b, init)); return; } b.SetHandler(this); bots.Add(b); if (init) DispatchBotEvent(bot => bot.Initialize(), new ChatBot[] { b }); if (handler != null) DispatchBotEvent(bot => bot.AfterGameJoined(), new ChatBot[] { b }); } /// /// Unload a bot /// public void BotUnLoad(ChatBot b) { if (InvokeRequired) { InvokeOnMainThread(() => BotUnLoad(b)); return; } b.OnUnload(); bots.RemoveAll(item => object.ReferenceEquals(item, b)); // ToList is needed to avoid an InvalidOperationException from modfiying the list while it's being iterated upon. var botRegistrations = registeredBotPluginChannels.Where(entry => entry.Value.Contains(b)).ToList(); foreach (var entry in botRegistrations) { UnregisterPluginChannel(entry.Key, b); } } /// /// Clear bots /// public void BotClear() { InvokeOnMainThread(bots.Clear); } /// /// Get Terrain and Movements status. /// public bool GetTerrainEnabled() { return terrainAndMovementsEnabled; } /// /// Get Inventory Handling Mode /// public bool GetInventoryEnabled() { return inventoryHandlingEnabled; } /// /// Get entity handling status /// /// /// Entity Handling cannot be enabled in runtime (or after joining server) public bool GetEntityHandlingEnabled() { return entityHandlingEnabled; } /// /// Enable or disable Terrain and Movements. /// Please note that Enabling will be deferred until next relog, respawn or world change. /// /// Enabled /// TRUE if the setting was applied immediately, FALSE if delayed. public bool SetTerrainEnabled(bool enabled) { if (InvokeRequired) return InvokeOnMainThread(() => SetTerrainEnabled(enabled)); if (enabled) { if (!terrainAndMovementsEnabled) { terrainAndMovementsRequested = true; return false; } } else { terrainAndMovementsEnabled = false; terrainAndMovementsRequested = false; locationReceived = false; world.Clear(); } return true; } /// /// Enable or disable Inventories. /// Please note that Enabling will be deferred until next relog. /// /// Enabled /// TRUE if the setting was applied immediately, FALSE if delayed. public bool SetInventoryEnabled(bool enabled) { if (InvokeRequired) return InvokeOnMainThread(() => SetInventoryEnabled(enabled)); if (enabled) { if (!inventoryHandlingEnabled) { inventoryHandlingRequested = true; return false; } } else { inventoryHandlingEnabled = false; inventoryHandlingRequested = false; inventories.Clear(); } return true; } /// /// Enable or disable Entity handling. /// Please note that Enabling will be deferred until next relog. /// /// Enabled /// TRUE if the setting was applied immediately, FALSE if delayed. public bool SetEntityHandlingEnabled(bool enabled) { if (InvokeRequired) return InvokeOnMainThread(() => SetEntityHandlingEnabled(enabled)); if (!enabled) { if (entityHandlingEnabled) { entityHandlingEnabled = false; return true; } else { return false; } } else { // Entity Handling cannot be enabled in runtime (or after joining server) return false; } } /// /// Enable or disable network packet event calling. /// /// /// Enable this may increase memory usage. /// /// public void SetNetworkPacketCaptureEnabled(bool enabled) { if (InvokeRequired) { InvokeOnMainThread(() => SetNetworkPacketCaptureEnabled(enabled)); return; } networkPacketCaptureEnabled = enabled; } #endregion #region Getters: Retrieve data for use in other methods or ChatBots /// /// Get max length for chat messages /// /// Max length, in characters public int GetMaxChatMessageLength() { return handler.GetMaxChatMessageLength(); } /// /// Get a list of disallowed characters in chat /// /// public static char[] GetDisallowedChatCharacters() { return new char[] { (char)167, (char)127 }; // Minecraft color code and ASCII code DEL } /// /// Get all inventories. ID 0 is the player inventory. /// /// All inventories public Dictionary GetInventories() { return inventories; } /// /// Get all Entities /// /// All Entities public Dictionary GetEntities() { return entities; } /// /// Get all players latency /// /// All players latency public Dictionary GetPlayersLatency() { Dictionary playersLatency = new(); foreach (var player in onlinePlayers) playersLatency.Add(player.Value.Name, player.Value.Ping); return playersLatency; } /// /// Get client player's inventory items /// /// Window ID of the requested inventory /// Item Dictionary indexed by Slot ID (Check wiki.vg for slot ID) public Container? GetInventory(int inventoryID) { if (InvokeRequired) return InvokeOnMainThread(() => GetInventory(inventoryID)); if (inventories.ContainsKey(inventoryID)) return inventories[inventoryID]; return null; } /// /// Get client player's inventory items /// /// Item Dictionary indexed by Slot ID (Check wiki.vg for slot ID) public Container GetPlayerInventory() { return GetInventory(0)!; } /// /// Get a set of online player names /// /// Online player names public string[] GetOnlinePlayers() { lock (onlinePlayers) { string[] playerNames = new string[onlinePlayers.Count]; int idx = 0; foreach (var player in onlinePlayers) playerNames[idx++] = player.Value.Name; return playerNames; } } /// /// Get a dictionary of online player names and their corresponding UUID /// /// Dictionay of online players, key is UUID, value is Player name public Dictionary GetOnlinePlayersWithUUID() { Dictionary uuid2Player = new(); lock (onlinePlayers) { foreach (Guid key in onlinePlayers.Keys) { uuid2Player.Add(key.ToString(), onlinePlayers[key].Name); } } return uuid2Player; } /// /// Get player info from uuid /// /// Player's UUID /// Player info public PlayerInfo? GetPlayerInfo(Guid uuid) { lock (onlinePlayers) { if (onlinePlayers.ContainsKey(uuid)) return onlinePlayers[uuid]; else return null; } } #endregion #region Action methods: Perform an action on the Server /// /// Move to the specified location /// /// Location to reach /// Allow possible but unsafe locations thay may hurt the player: lava, cactus... /// Allow non-vanilla direct teleport instead of computing path, but may cause invalid moves and/or trigger anti-cheat plugins /// If no valid path can be found, also allow locations within specified distance of destination /// Do not get closer of destination than specified distance /// How long to wait until the path is evaluated (default: 5 seconds) /// When location is unreachable, computation will reach timeout, then optionally fallback to a close location within maxOffset /// True if a path has been found public bool MoveTo(Location goal, bool allowUnsafe = false, bool allowDirectTeleport = false, int maxOffset = 0, int minOffset = 0, TimeSpan? timeout = null) { lock (locationLock) { if (allowDirectTeleport) { // 1-step path to the desired location without checking anything UpdateLocation(goal, goal); // Update yaw and pitch to look at next step handler.SendLocationUpdate(goal, Movement.IsOnGround(world, goal), _yaw, _pitch); return true; } else { // Calculate path through pathfinding. Path contains a list of 1-block movement that will be divided into steps path = Movement.CalculatePath(world, location, goal, allowUnsafe, maxOffset, minOffset, timeout ?? TimeSpan.FromSeconds(5)); return path != null; } } } /// /// Send a chat message or command to the server /// /// Text to send to the server public void SendText(string text) { if (String.IsNullOrEmpty(text)) return; int maxLength = handler.GetMaxChatMessageLength(); lock (chatQueue) { if (text.Length > maxLength) //Message is too long? { if (text[0] == '/') { //Send the first 100/256 chars of the command text = text[..maxLength]; chatQueue.Enqueue(text); } else { //Split the message into several messages while (text.Length > maxLength) { chatQueue.Enqueue(text[..maxLength]); text = text[maxLength..]; } chatQueue.Enqueue(text); } } else chatQueue.Enqueue(text); TrySendMessageToServer(); } } /// /// Allow to respawn after death /// /// True if packet successfully sent public bool SendRespawnPacket() { if (InvokeRequired) return InvokeOnMainThread(SendRespawnPacket); return handler.SendRespawnPacket(); } /// /// Registers the given plugin channel for the given bot. /// /// The channel to register. /// The bot to register the channel for. public void RegisterPluginChannel(string channel, ChatBot bot) { if (InvokeRequired) { InvokeOnMainThread(() => RegisterPluginChannel(channel, bot)); return; } if (registeredBotPluginChannels.ContainsKey(channel)) { registeredBotPluginChannels[channel].Add(bot); } else { List bots = new() { bot }; registeredBotPluginChannels[channel] = bots; SendPluginChannelMessage("REGISTER", Encoding.UTF8.GetBytes(channel), true); } } /// /// Unregisters the given plugin channel for the given bot. /// /// The channel to unregister. /// The bot to unregister the channel for. public void UnregisterPluginChannel(string channel, ChatBot bot) { if (InvokeRequired) { InvokeOnMainThread(() => UnregisterPluginChannel(channel, bot)); return; } if (registeredBotPluginChannels.ContainsKey(channel)) { List registeredBots = registeredBotPluginChannels[channel]; registeredBots.RemoveAll(item => object.ReferenceEquals(item, bot)); if (registeredBots.Count == 0) { registeredBotPluginChannels.Remove(channel); SendPluginChannelMessage("UNREGISTER", Encoding.UTF8.GetBytes(channel), true); } } } /// /// Sends a plugin channel packet to the server. See http://wiki.vg/Plugin_channel for more information /// about plugin channels. /// /// The channel to send the packet on. /// The payload for the packet. /// Whether the packet should be sent even if the server or the client hasn't registered it yet. /// Whether the packet was sent: true if it was sent, false if there was a connection error or it wasn't registered. public bool SendPluginChannelMessage(string channel, byte[] data, bool sendEvenIfNotRegistered = false) { if (InvokeRequired) return InvokeOnMainThread(() => SendPluginChannelMessage(channel, data, sendEvenIfNotRegistered)); if (!sendEvenIfNotRegistered) { if (!registeredBotPluginChannels.ContainsKey(channel)) { return false; } if (!registeredServerPluginChannels.Contains(channel)) { return false; } } return handler.SendPluginChannelPacket(channel, data); } /// /// Send the Entity Action packet with the Specified ID /// /// TRUE if the item was successfully used public bool SendEntityAction(EntityActionType entityAction) { return InvokeOnMainThread(() => handler.SendEntityAction(playerEntityID, (int)entityAction)); } /// /// Use the item currently in the player's hand /// /// TRUE if the item was successfully used public bool UseItemOnHand() { return InvokeOnMainThread(() => handler.SendUseItem(0, sequenceId)); } /// /// Use the item currently in the player's left hand /// /// TRUE if the item was successfully used public bool UseItemOnLeftHand() { return InvokeOnMainThread(() => handler.SendUseItem(1, sequenceId)); } /// /// Try to merge a slot /// /// The container where the item is located /// Items to be processed /// The ID of the slot of the item to be processed /// The slot that was put down /// The ID of the slot being put down /// Record changes /// Whether to fully merge private static bool TryMergeSlot(Container inventory, Item item, int slotId, Item curItem, int curId, List> changedSlots) { int spaceLeft = curItem.Type.StackCount() - curItem.Count; if (curItem.Type == item!.Type && spaceLeft > 0) { // Put item on that stack if (item.Count <= spaceLeft) { // Can fit into the stack item.Count = 0; curItem.Count += item.Count; changedSlots.Add(new Tuple((short)curId, curItem)); changedSlots.Add(new Tuple((short)slotId, null)); inventory.Items.Remove(slotId); return true; } else { item.Count -= spaceLeft; curItem.Count += spaceLeft; changedSlots.Add(new Tuple((short)curId, curItem)); } } return false; } /// /// Store items in a new slot /// /// The container where the item is located /// Items to be processed /// The ID of the slot of the item to be processed /// ID of the new slot /// Record changes private static void StoreInNewSlot(Container inventory, Item item, int slotId, int newSlotId, List> changedSlots) { Item newItem = new(item.Type, item.Count, item.NBT); inventory.Items[newSlotId] = newItem; inventory.Items.Remove(slotId); changedSlots.Add(new Tuple((short)newSlotId, newItem)); changedSlots.Add(new Tuple((short)slotId, null)); } /// /// Click a slot in the specified window /// /// TRUE if the slot was successfully clicked public bool DoWindowAction(int windowId, int slotId, WindowActionType action) { if (InvokeRequired) return InvokeOnMainThread(() => DoWindowAction(windowId, slotId, action)); Item? item = null; if (inventories.ContainsKey(windowId) && inventories[windowId].Items.ContainsKey(slotId)) item = inventories[windowId].Items[slotId]; List> changedSlots = new(); // List // Update our inventory base on action type Container inventory = GetInventory(windowId)!; Container playerInventory = GetInventory(0)!; if (inventory != null) { switch (action) { case WindowActionType.LeftClick: // Check if cursor have item (slot -1) if (playerInventory.Items.ContainsKey(-1)) { // When item on cursor and clicking slot 0, nothing will happen if (slotId == 0) break; // Check target slot also have item? if (inventory.Items.ContainsKey(slotId)) { // Check if both item are the same? if (inventory.Items[slotId].Type == playerInventory.Items[-1].Type) { int maxCount = inventory.Items[slotId].Type.StackCount(); // Check item stacking if ((inventory.Items[slotId].Count + playerInventory.Items[-1].Count) <= maxCount) { // Put cursor item to target inventory.Items[slotId].Count += playerInventory.Items[-1].Count; playerInventory.Items.Remove(-1); } else { // Leave some item on cursor playerInventory.Items[-1].Count -= (maxCount - inventory.Items[slotId].Count); inventory.Items[slotId].Count = maxCount; } } else { // Swap two items (inventory.Items[slotId], playerInventory.Items[-1]) = (playerInventory.Items[-1], inventory.Items[slotId]); } } else { // Put cursor item to target inventory.Items[slotId] = playerInventory.Items[-1]; playerInventory.Items.Remove(-1); } if (inventory.Items.ContainsKey(slotId)) changedSlots.Add(new Tuple((short)slotId, inventory.Items[slotId])); else changedSlots.Add(new Tuple((short)slotId, null)); } else { // Check target slot have item? if (inventory.Items.ContainsKey(slotId)) { // When taking item from slot 0, server will update us if (slotId == 0) break; // Put target slot item to cursor playerInventory.Items[-1] = inventory.Items[slotId]; inventory.Items.Remove(slotId); changedSlots.Add(new Tuple((short)slotId, null)); } } break; case WindowActionType.RightClick: // Check if cursor have item (slot -1) if (playerInventory.Items.ContainsKey(-1)) { // When item on cursor and clicking slot 0, nothing will happen if (slotId == 0) break; // Check target slot have item? if (inventory.Items.ContainsKey(slotId)) { // Check if both item are the same? if (inventory.Items[slotId].Type == playerInventory.Items[-1].Type) { // Check item stacking if (inventory.Items[slotId].Count < inventory.Items[slotId].Type.StackCount()) { // Drop 1 item count from cursor playerInventory.Items[-1].Count--; inventory.Items[slotId].Count++; } } else { // Swap two items (inventory.Items[slotId], playerInventory.Items[-1]) = (playerInventory.Items[-1], inventory.Items[slotId]); } } else { // Drop 1 item count from cursor Item itemTmp = playerInventory.Items[-1]; Item itemClone = new(itemTmp.Type, 1, itemTmp.NBT); inventory.Items[slotId] = itemClone; playerInventory.Items[-1].Count--; } } else { // Check target slot have item? if (inventory.Items.ContainsKey(slotId)) { if (slotId == 0) { // no matter how many item in slot 0, only 1 will be taken out // Also server will update us break; } if (inventory.Items[slotId].Count == 1) { // Only 1 item count. Put it to cursor playerInventory.Items[-1] = inventory.Items[slotId]; inventory.Items.Remove(slotId); } else { // Take half of the item stack to cursor if (inventory.Items[slotId].Count % 2 == 0) { // Can be evenly divided Item itemTmp = inventory.Items[slotId]; playerInventory.Items[-1] = new Item(itemTmp.Type, itemTmp.Count / 2, itemTmp.NBT); inventory.Items[slotId].Count = itemTmp.Count / 2; } else { // Cannot be evenly divided. item count on cursor is always larger than item on inventory Item itemTmp = inventory.Items[slotId]; playerInventory.Items[-1] = new Item(itemTmp.Type, (itemTmp.Count + 1) / 2, itemTmp.NBT); inventory.Items[slotId].Count = (itemTmp.Count - 1) / 2; } } } } if (inventory.Items.ContainsKey(slotId)) changedSlots.Add(new Tuple((short)slotId, inventory.Items[slotId])); else changedSlots.Add(new Tuple((short)slotId, null)); break; case WindowActionType.ShiftClick: if (slotId == 0) break; if (item != null) { /* Target slot have item */ bool lower2upper = false, upper2backpack = false, backpack2hotbar = false; // mutual exclusion bool hotbarFirst = true; // Used when upper2backpack = true int upperStartSlot = 9; int upperEndSlot = 35; int lowerStartSlot = 36; switch (inventory.Type) { case ContainerType.PlayerInventory: if (slotId >= 0 && slotId <= 8 || slotId == 45) { if (slotId != 0) hotbarFirst = false; upper2backpack = true; lowerStartSlot = 9; } else if (item != null && false /* Check if wearable */) { lower2upper = true; // upperStartSlot = ?; // upperEndSlot = ?; // Todo: Distinguish the type of equipment } else { if (slotId >= 9 && slotId <= 35) { backpack2hotbar = true; lowerStartSlot = 36; } else { lower2upper = true; upperStartSlot = 9; upperEndSlot = 35; } } break; case ContainerType.Generic_9x1: if (slotId >= 0 && slotId <= 8) { upper2backpack = true; lowerStartSlot = 9; } else { lower2upper = true; upperStartSlot = 0; upperEndSlot = 8; } break; case ContainerType.Generic_9x2: if (slotId >= 0 && slotId <= 17) { upper2backpack = true; lowerStartSlot = 18; } else { lower2upper = true; upperStartSlot = 0; upperEndSlot = 17; } break; case ContainerType.Generic_9x3: case ContainerType.ShulkerBox: if (slotId >= 0 && slotId <= 26) { upper2backpack = true; lowerStartSlot = 27; } else { lower2upper = true; upperStartSlot = 0; upperEndSlot = 26; } break; case ContainerType.Generic_9x4: if (slotId >= 0 && slotId <= 35) { upper2backpack = true; lowerStartSlot = 36; } else { lower2upper = true; upperStartSlot = 0; upperEndSlot = 35; } break; case ContainerType.Generic_9x5: if (slotId >= 0 && slotId <= 44) { upper2backpack = true; lowerStartSlot = 45; } else { lower2upper = true; upperStartSlot = 0; upperEndSlot = 44; } break; case ContainerType.Generic_9x6: if (slotId >= 0 && slotId <= 53) { upper2backpack = true; lowerStartSlot = 54; } else { lower2upper = true; upperStartSlot = 0; upperEndSlot = 53; } break; case ContainerType.Generic_3x3: if (slotId >= 0 && slotId <= 8) { upper2backpack = true; lowerStartSlot = 9; } else { lower2upper = true; upperStartSlot = 0; upperEndSlot = 8; } break; case ContainerType.Anvil: if (slotId >= 0 && slotId <= 2) { if (slotId >= 0 && slotId <= 1) hotbarFirst = false; upper2backpack = true; lowerStartSlot = 3; } else { lower2upper = true; upperStartSlot = 0; upperEndSlot = 1; } break; case ContainerType.Beacon: if (slotId == 0) { hotbarFirst = false; upper2backpack = true; lowerStartSlot = 1; } else if (item != null && item.Count == 1 && (item.Type == ItemType.NetheriteIngot || item.Type == ItemType.Emerald || item.Type == ItemType.Diamond || item.Type == ItemType.GoldIngot || item.Type == ItemType.IronIngot) && !inventory.Items.ContainsKey(0)) { lower2upper = true; upperStartSlot = 0; upperEndSlot = 0; } else { if (slotId >= 1 && slotId <= 27) { backpack2hotbar = true; lowerStartSlot = 28; } else { lower2upper = true; upperStartSlot = 1; upperEndSlot = 27; } } break; case ContainerType.BlastFurnace: case ContainerType.Furnace: case ContainerType.Smoker: if (slotId >= 0 && slotId <= 2) { if (slotId >= 0 && slotId <= 1) hotbarFirst = false; upper2backpack = true; lowerStartSlot = 3; } else if (item != null && false /* Check if it can be burned */) { lower2upper = true; upperStartSlot = 0; upperEndSlot = 0; } else { if (slotId >= 3 && slotId <= 29) { backpack2hotbar = true; lowerStartSlot = 30; } else { lower2upper = true; upperStartSlot = 3; upperEndSlot = 29; } } break; case ContainerType.BrewingStand: if (slotId >= 0 && slotId <= 3) { upper2backpack = true; lowerStartSlot = 5; } else if (item != null && item.Type == ItemType.BlazePowder) { lower2upper = true; if (!inventory.Items.ContainsKey(4) || inventory.Items[4].Count < 64) upperStartSlot = upperEndSlot = 4; else upperStartSlot = upperEndSlot = 3; } else if (item != null && false /* Check if it can be used for alchemy */) { lower2upper = true; upperStartSlot = upperEndSlot = 3; } else if (item != null && (item.Type == ItemType.Potion || item.Type == ItemType.GlassBottle)) { lower2upper = true; upperStartSlot = 0; upperEndSlot = 2; } else { if (slotId >= 5 && slotId <= 31) { backpack2hotbar = true; lowerStartSlot = 32; } else { lower2upper = true; upperStartSlot = 5; upperEndSlot = 31; } } break; case ContainerType.Crafting: if (slotId >= 0 && slotId <= 9) { if (slotId >= 1 && slotId <= 9) hotbarFirst = false; upper2backpack = true; lowerStartSlot = 10; } else { lower2upper = true; upperStartSlot = 1; upperEndSlot = 9; } break; case ContainerType.Enchantment: if (slotId >= 0 && slotId <= 1) { upper2backpack = true; lowerStartSlot = 5; } else if (item != null && item.Type == ItemType.LapisLazuli) { lower2upper = true; upperStartSlot = upperEndSlot = 1; } else { lower2upper = true; upperStartSlot = 0; upperEndSlot = 0; } break; case ContainerType.Grindstone: if (slotId >= 0 && slotId <= 2) { if (slotId >= 0 && slotId <= 1) hotbarFirst = false; upper2backpack = true; lowerStartSlot = 3; } else if (item != null && false /* Check */) { lower2upper = true; upperStartSlot = 0; upperEndSlot = 1; } else { lower2upper = true; upperStartSlot = 0; upperEndSlot = 1; } break; case ContainerType.Hopper: if (slotId >= 0 && slotId <= 4) { upper2backpack = true; lowerStartSlot = 5; } else { lower2upper = true; upperStartSlot = 0; upperEndSlot = 4; } break; case ContainerType.Lectern: return false; // break; case ContainerType.Loom: if (slotId >= 0 && slotId <= 3) { if (slotId >= 0 && slotId <= 5) hotbarFirst = false; upper2backpack = true; lowerStartSlot = 4; } else if (item != null && false /* Check for availability for staining */) { lower2upper = true; // upperStartSlot = ?; // upperEndSlot = ?; } else { if (slotId >= 4 && slotId <= 30) { backpack2hotbar = true; lowerStartSlot = 31; } else { lower2upper = true; upperStartSlot = 4; upperEndSlot = 30; } } break; case ContainerType.Merchant: if (slotId >= 0 && slotId <= 2) { if (slotId >= 0 && slotId <= 1) hotbarFirst = false; upper2backpack = true; lowerStartSlot = 3; } else if (item != null && false /* Check if it is available for trading */) { lower2upper = true; upperStartSlot = 0; upperEndSlot = 1; } else { if (slotId >= 3 && slotId <= 29) { backpack2hotbar = true; lowerStartSlot = 30; } else { lower2upper = true; upperStartSlot = 3; upperEndSlot = 29; } } break; case ContainerType.Cartography: if (slotId >= 0 && slotId <= 2) { if (slotId >= 0 && slotId <= 1) hotbarFirst = false; upper2backpack = true; lowerStartSlot = 3; } else if (item != null && item.Type == ItemType.FilledMap) { lower2upper = true; upperStartSlot = upperEndSlot = 0; } else if (item != null && item.Type == ItemType.Map) { lower2upper = true; upperStartSlot = upperEndSlot = 1; } else { if (slotId >= 3 && slotId <= 29) { backpack2hotbar = true; lowerStartSlot = 30; } else { lower2upper = true; upperStartSlot = 3; upperEndSlot = 29; } } break; case ContainerType.Stonecutter: if (slotId >= 0 && slotId <= 1) { if (slotId == 0) hotbarFirst = false; upper2backpack = true; lowerStartSlot = 2; } else if (item != null && false /* Check if it is available for stone cutteing */) { lower2upper = true; upperStartSlot = 0; upperEndSlot = 0; } else { if (slotId >= 2 && slotId <= 28) { backpack2hotbar = true; lowerStartSlot = 29; } else { lower2upper = true; upperStartSlot = 2; upperEndSlot = 28; } } break; // TODO: Define more container type here default: return false; } // Cursor have item or not doesn't matter // If hotbar already have same item, will put on it first until every stack are full // If no more same item , will put on the first empty slot (smaller slot id) // If inventory full, item will not move int itemCount = inventory.Items[slotId].Count; if (lower2upper) { int firstEmptySlot = -1; for (int i = upperStartSlot; i <= upperEndSlot; ++i) { if (inventory.Items.TryGetValue(i, out Item? curItem)) { if (TryMergeSlot(inventory, item!, slotId, curItem, i, changedSlots)) break; } else if (firstEmptySlot == -1) firstEmptySlot = i; } if (item!.Count > 0) { if (firstEmptySlot != -1) StoreInNewSlot(inventory, item, slotId, firstEmptySlot, changedSlots); else if (item.Count != itemCount) changedSlots.Add(new Tuple((short)slotId, inventory.Items[slotId])); } } else if (upper2backpack) { int hotbarEnd = lowerStartSlot + 4 * 9 - 1; if (hotbarFirst) { int lastEmptySlot = -1; for (int i = hotbarEnd; i >= lowerStartSlot; --i) { if (inventory.Items.TryGetValue(i, out Item? curItem)) { if (TryMergeSlot(inventory, item!, slotId, curItem, i, changedSlots)) break; } else if (lastEmptySlot == -1) lastEmptySlot = i; } if (item!.Count > 0) { if (lastEmptySlot != -1) StoreInNewSlot(inventory, item, slotId, lastEmptySlot, changedSlots); else if (item.Count != itemCount) changedSlots.Add(new Tuple((short)slotId, inventory.Items[slotId])); } } else { int firstEmptySlot = -1; for (int i = lowerStartSlot; i <= hotbarEnd; ++i) { if (inventory.Items.TryGetValue(i, out Item? curItem)) { if (TryMergeSlot(inventory, item!, slotId, curItem, i, changedSlots)) break; } else if (firstEmptySlot == -1) firstEmptySlot = i; } if (item!.Count > 0) { if (firstEmptySlot != -1) StoreInNewSlot(inventory, item, slotId, firstEmptySlot, changedSlots); else if (item.Count != itemCount) changedSlots.Add(new Tuple((short)slotId, inventory.Items[slotId])); } } } else if (backpack2hotbar) { int hotbarEnd = lowerStartSlot + 1 * 9 - 1; int firstEmptySlot = -1; for (int i = lowerStartSlot; i <= hotbarEnd; ++i) { if (inventory.Items.TryGetValue(i, out Item? curItem)) { if (TryMergeSlot(inventory, item!, slotId, curItem, i, changedSlots)) break; } else if (firstEmptySlot == -1) firstEmptySlot = i; } if (item!.Count > 0) { if (firstEmptySlot != -1) StoreInNewSlot(inventory, item, slotId, firstEmptySlot, changedSlots); else if (item.Count != itemCount) changedSlots.Add(new Tuple((short)slotId, inventory.Items[slotId])); } } } break; case WindowActionType.DropItem: if (inventory.Items.ContainsKey(slotId)) { inventory.Items[slotId].Count--; changedSlots.Add(new Tuple((short)slotId, inventory.Items[slotId])); } if (inventory.Items[slotId].Count <= 0) { inventory.Items.Remove(slotId); changedSlots.Add(new Tuple((short)slotId, null)); } break; case WindowActionType.DropItemStack: inventory.Items.Remove(slotId); changedSlots.Add(new Tuple((short)slotId, null)); break; } } return handler.SendWindowAction(windowId, slotId, action, item, changedSlots, inventories[windowId].StateID); } /// /// Give Creative Mode items into regular/survival Player Inventory /// /// (obviously) requires to be in creative mode /// Destination inventory slot /// Item type /// Item count /// Item NBT /// TRUE if item given successfully public bool DoCreativeGive(int slot, ItemType itemType, int count, Dictionary? nbt = null) { return InvokeOnMainThread(() => handler.SendCreativeInventoryAction(slot, itemType, count, nbt)); } /// /// Plays animation (Player arm swing) /// /// 0 for left arm, 1 for right arm /// TRUE if animation successfully done public bool DoAnimation(int animation) { return InvokeOnMainThread(() => handler.SendAnimation(animation, playerEntityID)); } /// /// Close the specified inventory window /// /// Window ID /// TRUE if the window was successfully closed /// Sending close window for inventory 0 can cause server to update our inventory if there are any item in the crafting area public bool CloseInventory(int windowId) { if (InvokeRequired) return InvokeOnMainThread(() => CloseInventory(windowId)); if (inventories.ContainsKey(windowId)) { if (windowId != 0) inventories.Remove(windowId); return handler.SendCloseWindow(windowId); } return false; } /// /// Clean all inventory /// /// TRUE if the uccessfully clear public bool ClearInventories() { if (!inventoryHandlingEnabled) return false; if (InvokeRequired) return InvokeOnMainThread(ClearInventories); inventories.Clear(); inventories[0] = new Container(0, ContainerType.PlayerInventory, "Player Inventory"); return true; } /// /// Interact with an entity /// /// /// Type of interaction (interact, attack...) /// Hand.MainHand or Hand.OffHand /// TRUE if interaction succeeded public bool InteractEntity(int entityID, InteractType type, Hand hand = Hand.MainHand) { if (InvokeRequired) return InvokeOnMainThread(() => InteractEntity(entityID, type, hand)); if (entities.ContainsKey(entityID)) { if (type == InteractType.Interact) { return handler.SendInteractEntity(entityID, (int)type, (int)hand); } else { return handler.SendInteractEntity(entityID, (int)type); } } else return false; } /// /// Place the block at hand in the Minecraft world /// /// Location to place block to /// Block face (e.g. Direction.Down when clicking on the block below to place this block) /// TRUE if successfully placed public bool PlaceBlock(Location location, Direction blockFace, Hand hand = Hand.MainHand) { return InvokeOnMainThread(() => handler.SendPlayerBlockPlacement((int)hand, location, blockFace, sequenceId)); } /// /// Attempt to dig a block at the specified location /// /// Location of block to dig /// Also perform the "arm swing" animation /// Also look at the block before digging public bool DigBlock(Location location, bool swingArms = true, bool lookAtBlock = true) { if (!GetTerrainEnabled()) return false; if (InvokeRequired) return InvokeOnMainThread(() => DigBlock(location, swingArms, lookAtBlock)); // TODO select best face from current player location Direction blockFace = Direction.Down; // Look at block before attempting to break it if (lookAtBlock) UpdateLocation(GetCurrentLocation(), location); // Send dig start and dig end, will need to wait for server response to know dig result // See https://wiki.vg/How_to_Write_a_Client#Digging for more details return handler.SendPlayerDigging(0, location, blockFace, sequenceId) && (!swingArms || DoAnimation((int)Hand.MainHand)) && handler.SendPlayerDigging(2, location, blockFace, sequenceId); } /// /// Change active slot in the player inventory /// /// Slot to activate (0 to 8) /// TRUE if the slot was changed public bool ChangeSlot(short slot) { if (slot < 0 || slot > 8) return false; if (InvokeRequired) return InvokeOnMainThread(() => ChangeSlot(slot)); CurrentSlot = Convert.ToByte(slot); return handler.SendHeldItemChange(slot); } /// /// Update sign text /// /// sign location /// text one /// text two /// text three /// text1 four public bool UpdateSign(Location location, string line1, string line2, string line3, string line4) { // TODO Open sign editor first https://wiki.vg/Protocol#Open_Sign_Editor return InvokeOnMainThread(() => handler.SendUpdateSign(location, line1, line2, line3, line4)); } /// /// Select villager trade /// /// The slot of the trade, starts at 0. public bool SelectTrade(int selectedSlot) { return InvokeOnMainThread(() => handler.SelectTrade(selectedSlot)); } /// /// Update command block /// /// command block location /// command /// command block mode /// command block flags public bool UpdateCommandBlock(Location location, string command, CommandBlockMode mode, CommandBlockFlags flags) { return InvokeOnMainThread(() => handler.UpdateCommandBlock(location, command, mode, flags)); } /// /// Teleport to player in spectator mode /// /// Player to teleport to /// Teleporting to other entityies is NOT implemented yet public bool Spectate(Entity entity) { if (entity.Type == EntityType.Player) { return SpectateByUUID(entity.UUID); } else { return false; } } /// /// Teleport to player/entity in spectator mode /// /// UUID of player/entity to teleport to public bool SpectateByUUID(Guid UUID) { if (GetGamemode() == 3) { if (InvokeRequired) return InvokeOnMainThread(() => SpectateByUUID(UUID)); return handler.SendSpectate(UUID); } else { return false; } } #endregion #region Event handlers: An event occurs on the Server /// /// Dispatch a ChatBot event with automatic exception handling /// /// /// Example for calling SomeEvent() on all bots at once: /// DispatchBotEvent(bot => bot.SomeEvent()); /// /// Action to execute on each bot /// Only fire the event for the specified bot list (default: all bots) private void DispatchBotEvent(Action action, IEnumerable? botList = null) { ChatBot[] selectedBots; if (botList != null) { selectedBots = botList.ToArray(); } else { selectedBots = bots.ToArray(); } foreach (ChatBot bot in selectedBots) { try { action(bot); } catch (Exception e) { if (e is not ThreadAbortException) { //Retrieve parent method name to determine which event caused the exception System.Diagnostics.StackFrame frame = new(1); System.Reflection.MethodBase method = frame.GetMethod()!; string parentMethodName = method.Name; //Display a meaningful error message to help debugging the ChatBot Log.Error(parentMethodName + ": Got error from " + bot.ToString() + ": " + e.ToString()); } else throw; //ThreadAbortException should not be caught here as in can happen when disconnecting from server } } } /// /// Called when a network packet received or sent /// /// /// Only called if is set to True /// /// Packet ID /// A copy of Packet Data /// The packet is login phase or playing phase /// The packet is received from server or sent by client public void OnNetworkPacket(int packetID, List packetData, bool isLogin, bool isInbound) { DispatchBotEvent(bot => bot.OnNetworkPacket(packetID, packetData, isLogin, isInbound)); } /// /// Called when a server was successfully joined /// public void OnGameJoined() { string? bandString = Config.Main.Advanced.BrandInfo.ToBrandString(); if (!String.IsNullOrWhiteSpace(bandString)) handler.SendBrandInfo(bandString.Trim()); if (Config.MCSettings.Enabled) handler.SendClientSettings( Config.MCSettings.Locale, Config.MCSettings.RenderDistance, (byte)Config.MCSettings.Difficulty, (byte)Config.MCSettings.ChatMode, Config.MCSettings.ChatColors, Config.MCSettings.Skin.GetByte(), (byte)Config.MCSettings.MainHand); if (inventoryHandlingRequested) { inventoryHandlingRequested = false; inventoryHandlingEnabled = true; Log.Info(Translations.Get("extra.inventory_enabled")); } ClearInventories(); DispatchBotEvent(bot => bot.AfterGameJoined()); } /// /// Called when the player respawns, which happens on login, respawn and world change. /// public void OnRespawn() { ClearTasks(); if (terrainAndMovementsRequested) { terrainAndMovementsEnabled = true; terrainAndMovementsRequested = false; Log.Info(Translations.Get("extra.terrainandmovement_enabled")); } if (terrainAndMovementsEnabled) { world.Clear(); } entities.Clear(); ClearInventories(); DispatchBotEvent(bot => bot.OnRespawn()); } /// /// Check if the client is currently processing a Movement. /// /// true if a movement is currently handled public bool ClientIsMoving() { return terrainAndMovementsEnabled && locationReceived && ((steps != null && steps.Count > 0) || (path != null && path.Count > 0)); } /// /// Get the current goal /// /// Current goal of movement. Location.Zero if not set. public Location GetCurrentMovementGoal() { return (ClientIsMoving() || path == null) ? Location.Zero : path.Last(); } /// /// Cancels the current movement /// /// True if there was an active path public bool CancelMovement() { bool success = ClientIsMoving(); path = null; return success; } /// /// Change the amount of sent movement packets per time /// /// Set a new walking type public void SetMovementSpeed(MovementType newSpeed) { switch (newSpeed) { case MovementType.Sneak: // https://minecraft.fandom.com/wiki/Sneaking#Effects - Sneaking 1.31m/s Config.Main.Advanced.MovementSpeed = 2; break; case MovementType.Walk: // https://minecraft.fandom.com/wiki/Walking#Usage - Walking 4.317 m/s Config.Main.Advanced.MovementSpeed = 4; break; case MovementType.Sprint: // https://minecraft.fandom.com/wiki/Sprinting#Usage - Sprinting 5.612 m/s Config.Main.Advanced.MovementSpeed = 5; break; } } /// /// Called when the server sends a new player location, /// or if a ChatBot whishes to update the player's location. /// /// The new location /// If true, the location is relative to the current location public void UpdateLocation(Location location, bool relative) { lock (locationLock) { if (relative) { this.location += location; } else this.location = location; locationReceived = true; } } /// /// Called when the server sends a new player location, /// or if a ChatBot whishes to update the player's location. /// /// The new location /// Yaw to look at /// Pitch to look at public void UpdateLocation(Location location, float yaw, float pitch) { _yaw = yaw; _pitch = pitch; UpdateLocation(location, false); } /// /// Called when the server sends a new player location, /// or if a ChatBot whishes to update the player's location. /// /// The new location /// Block coordinates to look at public void UpdateLocation(Location location, Location lookAtLocation) { double dx = lookAtLocation.X - (location.X - 0.5); double dy = lookAtLocation.Y - (location.Y + 1); double dz = lookAtLocation.Z - (location.Z - 0.5); double r = Math.Sqrt(dx * dx + dy * dy + dz * dz); float yaw = Convert.ToSingle(-Math.Atan2(dx, dz) / Math.PI * 180); float pitch = Convert.ToSingle(-Math.Asin(dy / r) / Math.PI * 180); if (yaw < 0) yaw += 360; UpdateLocation(location, yaw, pitch); } /// /// Called when the server sends a new player location, /// or if a ChatBot whishes to update the player's location. /// /// The new location /// Direction to look at public void UpdateLocation(Location location, Direction direction) { float yaw = 0; float pitch = 0; switch (direction) { case Direction.Up: pitch = -90; break; case Direction.Down: pitch = 90; break; case Direction.East: yaw = 270; break; case Direction.West: yaw = 90; break; case Direction.North: yaw = 180; break; case Direction.South: break; default: throw new ArgumentException(Translations.Get("exception.unknown_direction"), nameof(direction)); } UpdateLocation(location, yaw, pitch); } /// /// Received chat/system message from the server /// /// Message received public void OnTextReceived(ChatMessage message) { UpdateKeepAlive(); List links = new(); string messageText; if (message.isSignedChat) { if (!Config.Signature.ShowIllegalSignedChat && !message.isSystemChat && !(bool)message.isSignatureLegal!) return; messageText = ChatParser.ParseSignedChat(message, links); } else { if (message.isJson) messageText = ChatParser.ParseText(message.content, links); else messageText = message.content; } Log.Chat(messageText); if (Config.Main.Advanced.ShowChatLinks) foreach (string link in links) Log.Chat(Translations.Get("mcc.link", link)); DispatchBotEvent(bot => bot.GetText(messageText)); DispatchBotEvent(bot => bot.GetText(messageText, message.content)); } /// /// Received a connection keep-alive from the server /// public void OnServerKeepAlive() { UpdateKeepAlive(); } /// /// When an inventory is opened /// /// The inventory /// Inventory ID public void OnInventoryOpen(int inventoryID, Container inventory) { inventories[inventoryID] = inventory; if (inventoryID != 0) { Log.Info(Translations.Get("extra.inventory_open", inventoryID, inventory.Title)); Log.Info(Translations.Get("extra.inventory_interact")); DispatchBotEvent(bot => bot.OnInventoryOpen(inventoryID)); } } /// /// When an inventory is close /// /// Inventory ID public void OnInventoryClose(int inventoryID) { if (inventories.ContainsKey(inventoryID)) { if (inventoryID == 0) inventories[0].Items.Clear(); // Don't delete player inventory else inventories.Remove(inventoryID); } if (inventoryID != 0) { Log.Info(Translations.Get("extra.inventory_close", inventoryID)); DispatchBotEvent(bot => bot.OnInventoryClose(inventoryID)); } } /// /// When received window properties from server. /// Used for Frunaces, Enchanting Table, Beacon, Brewing stand, Stone cutter, Loom and Lectern /// More info about: https://wiki.vg/Protocol#Set_Container_Property /// /// Inventory ID /// Property ID /// Property Value public void OnWindowProperties(byte inventoryID, short propertyId, short propertyValue) { if (!inventories.ContainsKey(inventoryID)) return; Container inventory = inventories[inventoryID]; if (inventory.Properties.ContainsKey(propertyId)) inventory.Properties.Remove(propertyId); inventory.Properties.Add(propertyId, propertyValue); DispatchBotEvent(bot => bot.OnInventoryProperties(inventoryID, propertyId, propertyValue)); if (inventory.Type == ContainerType.Enchantment) { // We got the last property for enchantment if (propertyId == 9 && propertyValue != -1) { short topEnchantmentLevelRequirement = inventory.Properties[0]; short middleEnchantmentLevelRequirement = inventory.Properties[1]; short bottomEnchantmentLevelRequirement = inventory.Properties[2]; Enchantment topEnchantment = EnchantmentMapping.GetEnchantmentById( GetProtocolVersion(), inventory.Properties[4]); Enchantment middleEnchantment = EnchantmentMapping.GetEnchantmentById( GetProtocolVersion(), inventory.Properties[5]); Enchantment bottomEnchantment = EnchantmentMapping.GetEnchantmentById( GetProtocolVersion(), inventory.Properties[6]); short topEnchantmentLevel = inventory.Properties[7]; short middleEnchantmentLevel = inventory.Properties[8]; short bottomEnchantmentLevel = inventory.Properties[9]; StringBuilder sb = new(); sb.AppendLine(Translations.TryGet("Enchantment.enchantments_available") + ":"); sb.AppendLine(Translations.TryGet("Enchantment.tops_slot") + ":\t" + EnchantmentMapping.GetEnchantmentName(topEnchantment) + " " + EnchantmentMapping.ConvertLevelToRomanNumbers(topEnchantmentLevel) + " (" + topEnchantmentLevelRequirement + " " + Translations.TryGet("Enchantment.levels") + ")"); sb.AppendLine(Translations.TryGet("Enchantment.middle_slot") + ":\t" + EnchantmentMapping.GetEnchantmentName(middleEnchantment) + " " + EnchantmentMapping.ConvertLevelToRomanNumbers(middleEnchantmentLevel) + " (" + middleEnchantmentLevelRequirement + " " + Translations.TryGet("Enchantment.levels") + ")"); sb.AppendLine(Translations.TryGet("Enchantment.bottom_slot") + ":\t" + EnchantmentMapping.GetEnchantmentName(bottomEnchantment) + " " + EnchantmentMapping.ConvertLevelToRomanNumbers(bottomEnchantmentLevel) + " (" + bottomEnchantmentLevelRequirement + " " + Translations.TryGet("Enchantment.levels") + ")"); Log.Info(sb.ToString()); DispatchBotEvent(bot => bot.OnEnchantments( // Enchantments topEnchantment, middleEnchantment, bottomEnchantment, // Enchantment levels topEnchantmentLevel, middleEnchantmentLevel, bottomEnchantmentLevel, // Required levels for enchanting topEnchantmentLevelRequirement, middleEnchantmentLevelRequirement, bottomEnchantmentLevelRequirement)); } } } /// /// When received window items from server. /// /// Inventory ID /// Item list, key = slot ID, value = Item information public void OnWindowItems(byte inventoryID, Dictionary itemList, int stateId) { if (inventories.ContainsKey(inventoryID)) { inventories[inventoryID].Items = itemList; inventories[inventoryID].StateID = stateId; DispatchBotEvent(bot => bot.OnInventoryUpdate(inventoryID)); } } /// /// When a slot is set inside window items /// /// Window ID /// Slot ID /// Item (may be null for empty slot) public void OnSetSlot(byte inventoryID, short slotID, Item? item, int stateId) { if (inventories.ContainsKey(inventoryID)) inventories[inventoryID].StateID = stateId; // Handle inventoryID -2 - Add item to player inventory without animation if (inventoryID == 254) inventoryID = 0; // Handle cursor item if (inventoryID == 255 && slotID == -1) { inventoryID = 0; // Prevent key not found for some bots relied to this event if (inventories.ContainsKey(0)) { if (item != null) inventories[0].Items[-1] = item; else inventories[0].Items.Remove(-1); } } else { if (inventories.ContainsKey(inventoryID)) { if (item == null || item.IsEmpty) { if (inventories[inventoryID].Items.ContainsKey(slotID)) inventories[inventoryID].Items.Remove(slotID); } else inventories[inventoryID].Items[slotID] = item; } } DispatchBotEvent(bot => bot.OnInventoryUpdate(inventoryID)); } /// /// Set client player's ID for later receiving player's own properties /// /// Player Entity ID public void OnReceivePlayerEntityID(int EntityID) { playerEntityID = EntityID; } /// /// Triggered when a new player joins the game /// /// player info public void OnPlayerJoin(PlayerInfo player) { //Ignore placeholders eg 0000tab# from TabListPlus if (!ChatBot.IsValidName(player.Name)) return; if (player.Name == username) { // 1.19+ offline server is possible to return different uuid uuid = player.Uuid; uuidStr = player.Uuid.ToString().Replace("-", string.Empty); } lock (onlinePlayers) { onlinePlayers[player.Uuid] = player; } DispatchBotEvent(bot => bot.OnPlayerJoin(player.Uuid, player.Name)); } /// /// Triggered when a player has left the game /// /// UUID of the player public void OnPlayerLeave(Guid uuid) { string? username = null; lock (onlinePlayers) { if (onlinePlayers.ContainsKey(uuid)) { username = onlinePlayers[uuid].Name; onlinePlayers.Remove(uuid); } } DispatchBotEvent(bot => bot.OnPlayerLeave(uuid, username)); } /// /// Called when a plugin channel message was sent from the server. /// /// The channel the message was sent on /// The data from the channel public void OnPluginChannelMessage(string channel, byte[] data) { if (channel == "REGISTER") { string[] channels = Encoding.UTF8.GetString(data).Split('\0'); foreach (string chan in channels) { if (!registeredServerPluginChannels.Contains(chan)) { registeredServerPluginChannels.Add(chan); } } } if (channel == "UNREGISTER") { string[] channels = Encoding.UTF8.GetString(data).Split('\0'); foreach (string chan in channels) { registeredServerPluginChannels.Remove(chan); } } if (registeredBotPluginChannels.ContainsKey(channel)) { DispatchBotEvent(bot => bot.OnPluginMessage(channel, data), registeredBotPluginChannels[channel]); } } /// /// Called when an entity spawned /// public void OnSpawnEntity(Entity entity) { // The entity should not already exist, but if it does, let's consider the previous one is being destroyed if (entities.ContainsKey(entity.ID)) OnDestroyEntities(new[] { entity.ID }); entities.Add(entity.ID, entity); DispatchBotEvent(bot => bot.OnEntitySpawn(entity)); } /// /// Called when an entity effects /// public void OnEntityEffect(int entityid, Effects effect, int amplifier, int duration, byte flags, bool hasFactorData, Dictionary? factorCodec) { if (entities.ContainsKey(entityid)) DispatchBotEvent(bot => bot.OnEntityEffect(entities[entityid], effect, amplifier, duration, flags)); } /// /// Called when a player spawns or enters the client's render distance /// public void OnSpawnPlayer(int entityID, Guid uuid, Location location, byte yaw, byte pitch) { Entity playerEntity; if (onlinePlayers.TryGetValue(uuid, out PlayerInfo? player)) { playerEntity = new(entityID, EntityType.Player, location, uuid, player.Name, yaw, pitch); player.entity = playerEntity; } else playerEntity = new(entityID, EntityType.Player, location, uuid, null, yaw, pitch); OnSpawnEntity(playerEntity); } /// /// Called on Entity Equipment /// /// Entity ID /// Equipment slot. 0: main hand, 1: off hand, 2–5: armor slot (2: boots, 3: leggings, 4: chestplate, 5: helmet) /// Item) public void OnEntityEquipment(int entityid, int slot, Item? item) { if (entities.ContainsKey(entityid)) { Entity entity = entities[entityid]; if (entity.Equipment.ContainsKey(slot)) entity.Equipment.Remove(slot); if (item != null) entity.Equipment[slot] = item; DispatchBotEvent(bot => bot.OnEntityEquipment(entities[entityid], slot, item)); } } /// /// Called when the Game Mode has been updated for a player /// /// Player Name /// Player UUID (Empty for initial gamemode on login) /// New Game Mode (0: Survival, 1: Creative, 2: Adventure, 3: Spectator). public void OnGamemodeUpdate(Guid uuid, int gamemode) { // Initial gamemode on login if (uuid == Guid.Empty) this.gamemode = gamemode; // Further regular gamemode change events if (onlinePlayers.ContainsKey(uuid)) { string playerName = onlinePlayers[uuid].Name; if (playerName == username) this.gamemode = gamemode; DispatchBotEvent(bot => bot.OnGamemodeUpdate(playerName, uuid, gamemode)); } } /// /// Called when entities dead/despawn. /// public void OnDestroyEntities(int[] Entities) { foreach (int a in Entities) { if (entities.TryGetValue(a, out Entity? entity)) { DispatchBotEvent(bot => bot.OnEntityDespawn(entity)); entities.Remove(a); } } } /// /// Called when an entity's position changed within 8 block of its previous position. /// /// /// /// /// /// public void OnEntityPosition(int EntityID, Double Dx, Double Dy, Double Dz, bool onGround) { if (entities.ContainsKey(EntityID)) { Location L = entities[EntityID].Location; L.X += Dx; L.Y += Dy; L.Z += Dz; entities[EntityID].Location = L; DispatchBotEvent(bot => bot.OnEntityMove(entities[EntityID])); } } /// /// Called when an entity moved over 8 block. /// /// /// /// /// /// public void OnEntityTeleport(int EntityID, Double X, Double Y, Double Z, bool onGround) { if (entities.ContainsKey(EntityID)) { Location location = new(X, Y, Z); entities[EntityID].Location = location; DispatchBotEvent(bot => bot.OnEntityMove(entities[EntityID])); } } /// /// Called when received entity properties from server. /// /// /// public void OnEntityProperties(int EntityID, Dictionary prop) { if (EntityID == playerEntityID) { DispatchBotEvent(bot => bot.OnPlayerProperty(prop)); } } /// /// Called when the status of an entity have been changed /// /// Entity ID /// Status ID public void OnEntityStatus(int entityID, byte status) { if (entityID == playerEntityID) { DispatchBotEvent(bot => bot.OnPlayerStatus(status)); } } /// /// Called when server sent a Time Update packet. /// /// /// public void OnTimeUpdate(long WorldAge, long TimeOfDay) { // TimeUpdate sent every server tick hence used as timeout detect UpdateKeepAlive(); // calculate server tps if (lastAge != 0) { DateTime currentTime = DateTime.Now; long tickDiff = WorldAge - lastAge; Double tps = tickDiff / (currentTime - lastTime).TotalSeconds; lastAge = WorldAge; lastTime = currentTime; if (tps <= 20 && tps > 0) { // calculate average tps if (tpsSamples.Count >= maxSamples) { // full sampleSum -= tpsSamples[0]; tpsSamples.RemoveAt(0); } tpsSamples.Add(tps); sampleSum += tps; averageTPS = sampleSum / tpsSamples.Count; serverTPS = tps; DispatchBotEvent(bot => bot.OnServerTpsUpdate(tps)); } } else { lastAge = WorldAge; lastTime = DateTime.Now; } DispatchBotEvent(bot => bot.OnTimeUpdate(WorldAge, TimeOfDay)); } /// /// Called when client player's health changed, e.g. getting attack /// /// Player current health public void OnUpdateHealth(float health, int food) { playerHealth = health; playerFoodSaturation = food; if (health <= 0) { if (Config.Main.Advanced.AutoRespawn) { Log.Info(Translations.Get("mcc.player_dead_respawn")); respawnTicks = 10; } else { Log.Info(Translations.Get("mcc.player_dead", Config.Main.Advanced.InternalCmdChar.ToLogString())); } DispatchBotEvent(bot => bot.OnDeath()); } DispatchBotEvent(bot => bot.OnHealthUpdate(health, food)); } /// /// Called when experience updates /// /// Between 0 and 1 /// Level /// Total Experience public void OnSetExperience(float Experiencebar, int Level, int TotalExperience) { playerLevel = Level; playerTotalExperience = TotalExperience; DispatchBotEvent(bot => bot.OnSetExperience(Experiencebar, Level, TotalExperience)); } /// /// Called when and explosion occurs on the server /// /// Explosion location /// Explosion strength /// Amount of affected blocks public void OnExplosion(Location location, float strength, int affectedBlocks) { DispatchBotEvent(bot => bot.OnExplosion(location, strength, affectedBlocks)); } /// /// Called when Latency is updated /// /// player uuid /// Latency public void OnLatencyUpdate(Guid uuid, int latency) { if (onlinePlayers.ContainsKey(uuid)) { PlayerInfo player = onlinePlayers[uuid]; player.Ping = latency; string playerName = player.Name; foreach (KeyValuePair ent in entities) { if (ent.Value.UUID == uuid && ent.Value.Name == playerName) { ent.Value.Latency = latency; DispatchBotEvent(bot => bot.OnLatencyUpdate(ent.Value, playerName, uuid, latency)); break; } } DispatchBotEvent(bot => bot.OnLatencyUpdate(playerName, uuid, latency)); } } /// /// Called when held item change /// /// item slot public void OnHeldItemChange(byte slot) { CurrentSlot = slot; DispatchBotEvent(bot => bot.OnHeldItemChange(slot)); } /// /// Called when an update of the map is sent by the server, take a look at https://wiki.vg/Protocol#Map_Data for more info on the fields /// Map format and colors: https://minecraft.fandom.com/wiki/Map_item_format /// /// Map ID of the map being modified /// A scale of the Map, from 0 for a fully zoomed-in map (1 block per pixel) to 4 for a fully zoomed-out map (16 blocks per pixel) /// Specifies whether player and item frame icons are shown /// True if the map has been locked in a cartography table /// A list of MapIcon objects of map icons, send only if trackingPosition is true /// Numbs of columns that were updated (map width) (NOTE: If it is 0, the next fields are not used/are set to default values of 0 and null respectively) /// Map height /// x offset of the westernmost column /// z offset of the northernmost row /// a byte array of colors on the map public void OnMapData(int mapid, byte scale, bool trackingPosition, bool locked, List icons, byte columnsUpdated, byte rowsUpdated, byte mapCoulmnX, byte mapCoulmnZ, byte[]? colors) { DispatchBotEvent(bot => bot.OnMapData(mapid, scale, trackingPosition, locked, icons, columnsUpdated, rowsUpdated, mapCoulmnX, mapCoulmnZ, colors)); } /// /// Received some Title from the server /// 0 = set title, 1 = set subtitle, 3 = set action bar, 4 = set times and display, 4 = hide, 5 = reset /// title text /// suntitle text /// action bar text /// Fade In /// Stay /// Fade Out /// json text public void OnTitle(int action, string titletext, string subtitletext, string actionbartext, int fadein, int stay, int fadeout, string json) { DispatchBotEvent(bot => bot.OnTitle(action, titletext, subtitletext, actionbartext, fadein, stay, fadeout, json)); } /// /// Called when coreboardObjective /// /// objective name /// 0 to create the scoreboard. 1 to remove the scoreboard. 2 to update the display text. /// Only if mode is 0 or 2. The text to be displayed for the score /// Only if mode is 0 or 2. 0 = "integer", 1 = "hearts". public void OnScoreboardObjective(string objectivename, byte mode, string objectivevalue, int type) { string json = objectivevalue; objectivevalue = ChatParser.ParseText(objectivevalue); DispatchBotEvent(bot => bot.OnScoreboardObjective(objectivename, mode, objectivevalue, type, json)); } /// /// Called when DisplayScoreboard /// /// The entity whose score this is. For players, this is their username; for other entities, it is their UUID. /// 0 to create/update an item. 1 to remove an item. /// The name of the objective the score belongs to /// he score to be displayed next to the entry. Only sent when Action does not equal 1. public void OnUpdateScore(string entityname, int action, string objectivename, int value) { DispatchBotEvent(bot => bot.OnUpdateScore(entityname, action, objectivename, value)); } /// /// Called when the health of an entity changed /// /// Entity ID /// The health of the entity public void OnEntityHealth(int entityID, float health) { if (entities.ContainsKey(entityID)) { entities[entityID].Health = health; DispatchBotEvent(bot => bot.OnEntityHealth(entities[entityID], health)); } } /// /// Called when the metadata of an entity changed /// /// Entity ID /// The metadata of the entity public void OnEntityMetadata(int entityID, Dictionary metadata) { if (entities.ContainsKey(entityID)) { Entity entity = entities[entityID]; entity.Metadata = metadata; if (entity.Type.ContainsItem() && metadata.TryGetValue(7, out object? itemObj) && itemObj != null && itemObj.GetType() == typeof(Item)) { Item item = (Item)itemObj; if (item == null) entity.Item = new Item(ItemType.Air, 0, null); else entity.Item = item; } if (metadata.TryGetValue(6, out object? poseObj) && poseObj != null && poseObj.GetType() == typeof(Int32)) { entity.Pose = (EntityPose)poseObj; } if (metadata.TryGetValue(2, out object? nameObj) && nameObj != null && nameObj.GetType() == typeof(string)) { string name = nameObj.ToString() ?? string.Empty; entity.CustomNameJson = name; entity.CustomName = ChatParser.ParseText(name); } if (metadata.TryGetValue(3, out object? nameVisableObj) && nameVisableObj != null && nameVisableObj.GetType() == typeof(bool)) { entity.IsCustomNameVisible = bool.Parse(nameVisableObj.ToString() ?? string.Empty); } DispatchBotEvent(bot => bot.OnEntityMetadata(entity, metadata)); } } /// /// Called when tradeList is recieved after interacting with villager /// /// Window ID /// List of trades. /// Contains Level, Experience, IsRegularVillager and CanRestock . public void OnTradeList(int windowID, List trades, VillagerInfo villagerInfo) { DispatchBotEvent(bot => bot.OnTradeList(windowID, trades, villagerInfo)); } /// /// Will be called every player break block in gamemode 0 /// /// Player ID /// Block location /// Destroy stage, maximum 255 public void OnBlockBreakAnimation(int entityId, Location location, byte stage) { if (entities.ContainsKey(entityId)) { Entity entity = entities[entityId]; DispatchBotEvent(bot => bot.OnBlockBreakAnimation(entity, location, stage)); } } /// /// Will be called every animations of the hit and place block /// /// Player ID /// 0 = LMB, 1 = RMB (RMB Corrent not work) public void OnEntityAnimation(int entityID, byte animation) { if (entities.ContainsKey(entityID)) { Entity entity = entities[entityID]; DispatchBotEvent(bot => bot.OnEntityAnimation(entity, animation)); } } /// /// Will be called when a Synchronization sequence is recevied, this sequence need to be sent when breaking or placing blocks /// /// Sequence ID public void OnBlockChangeAck(int sequenceId) { this.sequenceId = sequenceId; } /// /// This method is called when the protocol handler receives server data /// /// Indicates if the server has a motd message /// Server MOTD message /// Indicates if the server has a an icon /// Server icon in Base 64 format /// Indicates if the server previews chat public void OnServerDataRecived(bool hasMotd, string motd, bool hasIcon, string iconBase64, bool previewsChat) { isSupportPreviewsChat = previewsChat; } /// /// This method is called when the protocol handler receives "Set Display Chat Preview" packet /// /// Indicates if the server previews chat public void OnChatPreviewSettingUpdate(bool previewsChat) { isSupportPreviewsChat = previewsChat; } /// /// This method is called when the protocol handler receives "Login Success" packet /// /// The player's UUID received from the server /// The player's username received from the server /// Tuple public void OnLoginSuccess(Guid uuid, string userName, Tuple[]? playerProperty) { //string UUID = uuid.ToString().Replace("-", String.Empty); //Log.Info("now UUID = " + this.uuid); //Log.Info("new UUID = " + UUID); ////handler.SetUserUUID(UUID); } /// /// Used for a wide variety of game events, from weather to bed use to gamemode to demo messages. /// /// Event type /// Depends on Reason public void OnGameEvent(byte reason, float value) { switch (reason) { case 7: DispatchBotEvent(bot => bot.OnRainLevelChange(value)); break; case 8: DispatchBotEvent(bot => bot.OnThunderLevelChange(value)); break; } } /// /// Called when a block is changed. /// /// The location of the block. /// The block public void OnBlockChange(Location location, Block block) { world.SetBlock(location, block); DispatchBotEvent(bot => bot.OnBlockChange(location, block)); } /// /// Send a click container button packet to the server. /// Used for Enchanting table, Lectern, stone cutter and loom /// /// Id of the window being clicked /// Id of the clicked button /// True if packet was successfully sent public bool ClickContainerButton(int windowId, int buttonId) { return handler.ClickContainerButton(windowId, buttonId); } #endregion } }