using Barotrauma.Extensions; using Barotrauma.Items.Components; using Microsoft.Xna.Framework; using System; using System.Collections.Generic; using System.Xml.Linq; using System.Linq; namespace Barotrauma { public enum OrderCategory { Emergency, Movement, Power, Maintenance, Operate } struct OrderInfo { public string ComponentIdentifier { get; set; } public Order Order { get; private set; } public string OrderOption { get; private set; } public OrderInfo(Order order, string orderOption) { ComponentIdentifier = "currentorder"; Order = order; OrderOption = orderOption; } public OrderInfo(OrderInfo orderInfo) { ComponentIdentifier = "previousorder"; Order = orderInfo.Order; OrderOption = orderInfo.OrderOption; } public bool MatchesOrder(Order order, string option) => order.Identifier == Order.Identifier && option == OrderOption; } class Order { public static Dictionary Prefabs { get; private set; } public static Dictionary> OrderCategoryIcons { get; private set; } public static List PrefabList { get; private set; } public static Order GetPrefab(string identifier) { if (!Prefabs.TryGetValue(identifier, out Order order)) { DebugConsole.ThrowError($"Cannot find an order with the identifier '{identifier}'!"); } return order; } public Order Prefab { get; private set; } public readonly string Name; /// /// Name that can be used with the contextual version of the order /// public readonly string ContextualName; public readonly Sprite SymbolSprite; public readonly Type ItemComponentType; public readonly bool CanTypeBeSubclass; public readonly string[] TargetItems; public readonly string Identifier; private Color? color; public Color Color { get { if (color.HasValue) { return color.Value; } else if (Category.HasValue && OrderCategoryIcons.TryGetValue((OrderCategory)Category, out Tuple sprite)) { return sprite.Item2; } else { return Color.White; } } private set { color = value; } } //if true, the order is issued to all available characters public bool TargetAllCharacters { get; } public bool IsReport => TargetAllCharacters && !MustSetTarget; public readonly float FadeOutTime; public Entity TargetEntity; public ItemComponent TargetItemComponent; public readonly bool UseController; public Controller ConnectedController; public Character OrderGiver; public OrderCategory? Category { get; private set; } //legacy support public readonly string[] AppropriateJobs; public readonly string[] Options; private readonly Dictionary OptionNames; public readonly Dictionary OptionSprites; private readonly Dictionary minimapIcons; public Dictionary MinimapIcons => IsPrefab ? minimapIcons : Prefab.minimapIcons; public readonly bool MustSetTarget; public readonly string AppropriateSkill; public readonly bool Hidden; public bool HasOptions => (IsPrefab ? Options : Prefab.Options).Length > 1; public bool IsPrefab { get; private set; } public readonly bool MustManuallyAssign; public readonly OrderTarget TargetPosition; private ISpatialEntity targetSpatialEntity; public ISpatialEntity TargetSpatialEntity { get { if (targetSpatialEntity == null) { if (TargetType == OrderTargetType.WallSection && WallSectionIndex.HasValue) { targetSpatialEntity = (TargetEntity as Structure)?.Sections[WallSectionIndex.Value]; } else { targetSpatialEntity = TargetEntity ?? TargetPosition as ISpatialEntity; } } return targetSpatialEntity; } } public enum OrderTargetType { Entity, Position, WallSection } public OrderTargetType TargetType { get; } public int? WallSectionIndex { get; } public bool IsIgnoreOrder { get; } /// /// Should the order icon be drawn when the order target is inside a container /// public bool DrawIconWhenContained { get; } public static void Init() { Prefabs = new Dictionary(); OrderCategoryIcons = new Dictionary>(); foreach (ContentFile file in GameMain.Instance.GetFilesOfType(ContentType.Orders)) { XDocument doc = XMLExtensions.TryLoadXml(file.Path); if (doc == null) { continue; } var mainElement = doc.Root; bool allowOverriding = false; if (doc.Root.IsOverride()) { mainElement = doc.Root.FirstElement(); allowOverriding = true; } foreach (XElement sourceElement in mainElement.Elements()) { var element = sourceElement.IsOverride() ? sourceElement.FirstElement() : sourceElement; string name = element.Name.ToString(); if (name.Equals("order", StringComparison.OrdinalIgnoreCase)) { string identifier = element.GetAttributeString("identifier", null); if (string.IsNullOrWhiteSpace(identifier)) { DebugConsole.ThrowError($"Error in file {file.Path}: The order element '{name}' does not have an identifier! All orders must have a unique identifier."); continue; } if (Prefabs.TryGetValue(identifier, out Order duplicate)) { if (allowOverriding || sourceElement.IsOverride()) { DebugConsole.NewMessage($"Overriding an existing order '{identifier}' with another one defined in '{file.Path}'", Color.Yellow); Prefabs.Remove(identifier); } else { DebugConsole.ThrowError($"Error in file {file.Path}: Duplicate element with the idenfitier '{identifier}' found in '{file.Path}'! All orders must have a unique identifier. Use tags to override an order with the same identifier."); continue; } } var newOrder = new Order(element); newOrder.Prefab = newOrder; Prefabs.Add(identifier, newOrder); } else if (name.Equals("ordercategory", StringComparison.OrdinalIgnoreCase)) { var category = (OrderCategory)Enum.Parse(typeof(OrderCategory), element.GetAttributeString("category", "undefined"), true); if (OrderCategoryIcons.ContainsKey(category)) { if (allowOverriding || sourceElement.IsOverride()) { DebugConsole.NewMessage($"Overriding an existing icon for the '{category}' order category with another one defined in '{file}'", Color.Yellow); OrderCategoryIcons.Remove(category); } else { DebugConsole.ThrowError($"Error in file {file}: Duplicate element for the '{category}' order category found in '{file}'! All order categories must be unique. Use tags to override an order category."); continue; } } var spriteElement = element.GetChildElement("sprite"); if (spriteElement != null) { var sprite = new Sprite(spriteElement, lazyLoad: true); var color = element.GetAttributeColor("color", Color.White); OrderCategoryIcons.Add(category, new Tuple(sprite, color)); } } } } PrefabList = new List(Prefabs.Values); } /// /// Constructor for order prefabs /// private Order(XElement orderElement) { Identifier = orderElement.GetAttributeString("identifier", ""); Name = TextManager.Get("OrderName." + Identifier, returnNull: true) ?? "Name not found"; ContextualName = TextManager.Get("OrderNameContextual." + Identifier, returnNull: true) ?? Name; string targetItemType = orderElement.GetAttributeString("targetitemtype", ""); if (!string.IsNullOrWhiteSpace(targetItemType)) { try { ItemComponentType = Type.GetType("Barotrauma.Items.Components." + targetItemType, true, true); } catch (Exception e) { DebugConsole.ThrowError("Error in the order definitions: item component type " + targetItemType + " not found", e); } } CanTypeBeSubclass = orderElement.GetAttributeBool("cantypebesubclass", false); TargetItems = orderElement.GetAttributeStringArray("targetitems", new string[0], trim: true, convertToLowerInvariant: true); color = orderElement.GetAttributeColor("color"); FadeOutTime = orderElement.GetAttributeFloat("fadeouttime", 0.0f); UseController = orderElement.GetAttributeBool("usecontroller", false); TargetAllCharacters = orderElement.GetAttributeBool("targetallcharacters", false); AppropriateJobs = orderElement.GetAttributeStringArray("appropriatejobs", new string[0]); Options = orderElement.GetAttributeStringArray("options", new string[0]); var category = orderElement.GetAttributeString("category", null); if (!string.IsNullOrWhiteSpace(category)) { this.Category = (OrderCategory)Enum.Parse(typeof(OrderCategory), category, true); } MustSetTarget = orderElement.GetAttributeBool("mustsettarget", false); AppropriateSkill = orderElement.GetAttributeString("appropriateskill", null); Hidden = orderElement.GetAttributeBool("hidden", false); var optionNames = TextManager.Get("OrderOptions." + Identifier, true)?.Split(',', ',') ?? orderElement.GetAttributeStringArray("optionnames", new string[0]); OptionNames = new Dictionary(); for (int i = 0; i < Options.Length && i < optionNames.Length; i++) { OptionNames.Add(Options[i], optionNames[i].Trim()); } if (OptionNames.Count != Options.Length) { DebugConsole.ThrowError("Error in Order " + Name + " - the number of option names doesn't match the number of options."); OptionNames.Clear(); Options.ForEach(o => OptionNames.Add(o, o)); } var spriteElement = orderElement.GetChildElement("sprite"); if (spriteElement != null) { SymbolSprite = new Sprite(spriteElement, lazyLoad: true); } OptionSprites = new Dictionary(); if (Options != null && Options.Length > 0) { var optionSpriteElements = orderElement.GetChildElement("optionsprites")?.GetChildElements("sprite"); if (optionSpriteElements != null && optionSpriteElements.Any()) { for (int i = 0; i < Options.Length; i++) { if (i >= optionSpriteElements.Count()) { break; }; var sprite = new Sprite(optionSpriteElements.ElementAt(i), lazyLoad: true); OptionSprites.Add(Options[i], sprite); } } } minimapIcons = new Dictionary(); var minimapIconElements = orderElement.GetChildElements("minimapicon"); foreach (XElement minimapIconElement in minimapIconElements) { var id = minimapIconElement.GetAttributeString("id", null); if (string.IsNullOrWhiteSpace(id)) { continue; } minimapIcons.Add(id, new Sprite(minimapIconElement.GetChildElement("sprite"), lazyLoad: true)); } IsPrefab = true; MustManuallyAssign = orderElement.GetAttributeBool("mustmanuallyassign", false); IsIgnoreOrder = Identifier == "ignorethis" || Identifier == "unignorethis"; DrawIconWhenContained = orderElement.GetAttributeBool("displayiconwhencontained", false); } /// /// Constructor for order instances /// public Order(Order prefab, Entity targetEntity, ItemComponent targetItem, Character orderGiver = null, bool isAutonomous = false) { Prefab = prefab.Prefab ?? prefab; Name = prefab.Name; ContextualName = prefab.ContextualName; Identifier = prefab.Identifier; ItemComponentType = prefab.ItemComponentType; CanTypeBeSubclass = prefab.CanTypeBeSubclass; TargetItems = prefab.TargetItems; Options = prefab.Options; SymbolSprite = prefab.SymbolSprite; Color = prefab.Color; UseController = prefab.UseController; TargetAllCharacters = prefab.TargetAllCharacters; AppropriateJobs = prefab.AppropriateJobs; FadeOutTime = prefab.FadeOutTime; MustSetTarget = prefab.MustSetTarget; AppropriateSkill = prefab.AppropriateSkill; Category = prefab.Category; MustManuallyAssign = prefab.MustManuallyAssign; IsIgnoreOrder = prefab.IsIgnoreOrder; DrawIconWhenContained = prefab.DrawIconWhenContained; Hidden = prefab.Hidden; OrderGiver = orderGiver; TargetEntity = targetEntity; if (targetItem != null) { if (UseController) { ConnectedController = targetItem.Item?.FindController(); if (ConnectedController == null) { DebugConsole.AddWarning("AI: Tried to use a controller for operating an item, but couldn't find any."); UseController = false; } } TargetEntity = targetItem.Item; TargetItemComponent = targetItem; } TargetType = OrderTargetType.Entity; IsPrefab = false; } public Order(Order prefab, OrderTarget target, Character orderGiver = null) : this(prefab, targetEntity: null, targetItem: null, orderGiver) { TargetPosition = target; TargetType = OrderTargetType.Position; } public Order(Order prefab, Structure wall, int? sectionIndex, Character orderGiver = null) : this(prefab, targetEntity: wall, null, orderGiver: orderGiver) { WallSectionIndex = sectionIndex; TargetType = OrderTargetType.WallSection; } public bool HasAppropriateJob(Character character) { if (character.Info == null || character.Info.Job == null) { return false; } if (character.Info.Job.Prefab.AppropriateOrders.Any(appropriateOrderId => Identifier == appropriateOrderId)) { return true; } if (!JobPrefab.Prefabs.Any(jp => jp.AppropriateOrders.Contains(Identifier)) && (AppropriateJobs == null || AppropriateJobs.Length == 0)) { return true; } for (int i = 0; i < AppropriateJobs.Length; i++) { if (character.Info.Job.Prefab.Identifier.Equals(AppropriateJobs[i], StringComparison.OrdinalIgnoreCase)) { return true; } } return false; } public string GetChatMessage(string targetCharacterName, string targetRoomName, bool givingOrderToSelf, string orderOption = "") { orderOption ??= ""; string messageTag = (givingOrderToSelf && !TargetAllCharacters ? "OrderDialogSelf." : "OrderDialog.") + Identifier; if (!string.IsNullOrEmpty(orderOption)) { messageTag += "." + orderOption; } if (targetCharacterName == null) { targetCharacterName = ""; } if (targetRoomName == null) { targetRoomName = ""; } string msg = TextManager.GetWithVariables(messageTag, new string[2] { "[name]", "[roomname]" }, new string[2] { targetCharacterName, targetRoomName }, new bool[2] { false, true }, true); if (msg == null) { return ""; } return msg; } /// /// Get the target item component based on the target item type /// public ItemComponent GetTargetItemComponent(Item item) { if (item?.Components == null || ItemComponentType == null) { return null; } foreach (ItemComponent component in item.Components) { if (component?.GetType() is Type componentType) { if (componentType == ItemComponentType) { return component; } if (CanTypeBeSubclass && componentType.IsSubclassOf(ItemComponentType)) { return component; } } } return null; } public bool TryGetTargetItemComponent(Item item, out ItemComponent firstMatchingComponent) { firstMatchingComponent = GetTargetItemComponent(item); return firstMatchingComponent != null; } /// Only returns items which are interactable for this character public List GetMatchingItems(Submarine submarine, bool mustBelongToPlayerSub, CharacterTeamType? requiredTeam = null, Character interactableFor = null) { List matchingItems = new List(); if (submarine == null) { return matchingItems; } if (ItemComponentType != null || TargetItems.Length > 0) { matchingItems = TargetItems.Length > 0 ? Item.ItemList.FindAll(it => TargetItems.Contains(it.Prefab.Identifier) || it.HasTag(TargetItems)) : Item.ItemList.FindAll(it => TryGetTargetItemComponent(it, out _)); if (mustBelongToPlayerSub) { matchingItems.RemoveAll(it => it.Submarine?.Info != null && it.Submarine.Info.Type != SubmarineType.Player); } matchingItems.RemoveAll(it => it.Submarine != submarine && !submarine.DockedTo.Contains(it.Submarine)); if (requiredTeam.HasValue) { matchingItems.RemoveAll(it => it.Submarine == null || it.Submarine.TeamID != requiredTeam.Value); } matchingItems.RemoveAll(it => it.NonInteractable); if (UseController) { matchingItems.RemoveAll(i => i.Components.None(c => c.GetType() == ItemComponentType) && !i.TryFindController(out _)); } if (interactableFor != null) { matchingItems.RemoveAll(it => !it.IsInteractable(interactableFor) || (UseController && it.FindController() is Controller c && !c.Item.IsInteractable(interactableFor))); } } return matchingItems; } /// Only returns items which are interactable for this character public List GetMatchingItems(bool mustBelongToPlayerSub, Character interactableFor = null) { Submarine submarine = Character.Controlled != null && Character.Controlled.TeamID == CharacterTeamType.Team2 && Submarine.MainSubs.Length > 1 ? Submarine.MainSubs[1] : Submarine.MainSub; return GetMatchingItems(submarine, mustBelongToPlayerSub, interactableFor: interactableFor); } public string GetOptionName(string id) { return Prefab == null ? OptionNames[id] : Prefab.OptionNames[id]; } public string GetOptionName(int index) { if (index < 0 || index >= Options.Length) { return null; } return GetOptionName(Options[index]); } } }