public ItemPrefab(XElement element, string filePath, bool allowOverriding)
{
FilePath = filePath;
ConfigElement = element;
originalName = element.GetAttributeString("name", "");
name = originalName;
identifier = element.GetAttributeString("identifier", "");
if (!Enum.TryParse(element.GetAttributeString("category", "Misc"), true, out MapEntityCategory category))
{
category = MapEntityCategory.Misc;
}
Category = category;
var parentType = element.Parent?.GetAttributeString("itemtype", "") ?? string.Empty;
//nameidentifier can be used to make multiple items use the same names and descriptions
string nameIdentifier = element.GetAttributeString("nameidentifier", "");
if (string.IsNullOrEmpty(originalName))
{
if (string.IsNullOrEmpty(nameIdentifier))
{
name = TextManager.Get("EntityName." + identifier, true) ?? string.Empty;
}
else
{
name = TextManager.Get("EntityName." + nameIdentifier, true) ?? string.Empty;
}
}
else if (Category.HasFlag(MapEntityCategory.Legacy))
{
// Legacy items use names as identifiers, so we have to define them in the xml. But we also want to support the translations. Therefore
if (string.IsNullOrEmpty(nameIdentifier))
{
name = TextManager.Get("EntityName." + identifier, true) ?? originalName;
}
else
{
name = TextManager.Get("EntityName." + nameIdentifier, true) ?? originalName;
}
if (string.IsNullOrWhiteSpace(identifier))
{
identifier = GenerateLegacyIdentifier(originalName);
}
}
if (string.Equals(parentType, "wrecked", StringComparison.OrdinalIgnoreCase))
{
if (!string.IsNullOrEmpty(name))
{
name = TextManager.GetWithVariable("wreckeditemformat", "[name]", name);
}
}
if (string.IsNullOrEmpty(name))
{
DebugConsole.ThrowError($"Unnamed item ({identifier})in {filePath}!");
}
DebugConsole.Log(" " + name);
Aliases = new HashSet <string>
(element.GetAttributeStringArray("aliases", null, convertToLowerInvariant: true) ??
element.GetAttributeStringArray("Aliases", new string[0], convertToLowerInvariant: true));
Aliases.Add(originalName.ToLowerInvariant());
Triggers = new List <Rectangle>();
DeconstructItems = new List <DeconstructItem>();
FabricationRecipes = new List <FabricationRecipe>();
DeconstructTime = 1.0f;
Tags = new HashSet <string>(element.GetAttributeStringArray("tags", new string[0], convertToLowerInvariant: true));
if (!Tags.Any())
{
Tags = new HashSet <string>(element.GetAttributeStringArray("Tags", new string[0], convertToLowerInvariant: true));
}
if (element.Attribute("cargocontainername") != null)
{
DebugConsole.ThrowError("Error in item prefab \"" + name + "\" - cargo container should be configured using the item's identifier, not the name.");
}
SerializableProperty.DeserializeProperties(this, element);
if (string.IsNullOrEmpty(Description))
{
if (string.IsNullOrEmpty(nameIdentifier))
{
Description = TextManager.Get("EntityDescription." + identifier, true) ?? string.Empty;
}
else
{
Description = TextManager.Get("EntityDescription." + nameIdentifier, true) ?? string.Empty;
}
}
foreach (XElement subElement in element.Elements())
{
switch (subElement.Name.ToString().ToLowerInvariant())
{
case "sprite":
string spriteFolder = "";
if (!subElement.GetAttributeString("texture", "").Contains("/"))
{
spriteFolder = Path.GetDirectoryName(filePath);
}
canSpriteFlipX = subElement.GetAttributeBool("canflipx", true);
canSpriteFlipY = subElement.GetAttributeBool("canflipy", true);
sprite = new Sprite(subElement, spriteFolder, lazyLoad: true);
if (subElement.Attribute("sourcerect") == null)
{
DebugConsole.ThrowError("Warning - sprite sourcerect not configured for item \"" + Name + "\"!");
}
size = sprite.size;
if (subElement.Attribute("name") == null && !string.IsNullOrWhiteSpace(Name))
{
sprite.Name = Name;
}
sprite.EntityID = identifier;
break;
case "price":
string locationType = subElement.GetAttributeString("locationtype", "");
if (prices == null)
{
prices = new Dictionary <string, PriceInfo>();
}
prices[locationType.ToLowerInvariant()] = new PriceInfo(subElement);
break;
#if CLIENT
case "inventoryicon":
string iconFolder = "";
if (!subElement.GetAttributeString("texture", "").Contains("/"))
{
iconFolder = Path.GetDirectoryName(filePath);
}
InventoryIcon = new Sprite(subElement, iconFolder, lazyLoad: true);
break;
case "brokensprite":
string brokenSpriteFolder = "";
if (!subElement.GetAttributeString("texture", "").Contains("/"))
{
brokenSpriteFolder = Path.GetDirectoryName(filePath);
}
var brokenSprite = new BrokenItemSprite(
new Sprite(subElement, brokenSpriteFolder, lazyLoad: true),
subElement.GetAttributeFloat("maxcondition", 0.0f),
subElement.GetAttributeBool("fadein", false));
int spriteIndex = 0;
for (int i = 0; i < BrokenSprites.Count && BrokenSprites[i].MaxCondition < brokenSprite.MaxCondition; i++)
{
spriteIndex = i;
}
BrokenSprites.Insert(spriteIndex, brokenSprite);
break;
case "decorativesprite":
string decorativeSpriteFolder = "";
if (!subElement.GetAttributeString("texture", "").Contains("/"))
{
decorativeSpriteFolder = Path.GetDirectoryName(filePath);
}
int groupID = 0;
DecorativeSprite decorativeSprite = null;
if (subElement.Attribute("texture") == null)
{
groupID = subElement.GetAttributeInt("randomgroupid", 0);
}
else
{
decorativeSprite = new DecorativeSprite(subElement, decorativeSpriteFolder, lazyLoad: true);
DecorativeSprites.Add(decorativeSprite);
groupID = decorativeSprite.RandomGroupID;
}
if (!DecorativeSpriteGroups.ContainsKey(groupID))
{
DecorativeSpriteGroups.Add(groupID, new List <DecorativeSprite>());
}
DecorativeSpriteGroups[groupID].Add(decorativeSprite);
break;
case "containedsprite":
string containedSpriteFolder = "";
if (!subElement.GetAttributeString("texture", "").Contains("/"))
{
containedSpriteFolder = Path.GetDirectoryName(filePath);
}
var containedSprite = new ContainedItemSprite(subElement, containedSpriteFolder, lazyLoad: true);
if (containedSprite.Sprite != null)
{
ContainedSprites.Add(containedSprite);
}
break;
#endif
case "deconstruct":
DeconstructTime = subElement.GetAttributeFloat("time", 1.0f);
foreach (XElement deconstructItem in subElement.Elements())
{
if (deconstructItem.Attribute("name") != null)
{
DebugConsole.ThrowError("Error in item config \"" + Name + "\" - use item identifiers instead of names to configure the deconstruct items.");
continue;
}
DeconstructItems.Add(new DeconstructItem(deconstructItem));
}
break;
case "fabricate":
case "fabricable":
case "fabricableitem":
fabricationRecipeElements.Add(subElement);
break;
case "preferredcontainer":
var preferredContainer = new PreferredContainer(subElement);
if (preferredContainer.Primary.Count == 0 && preferredContainer.Secondary.Count == 0)
{
DebugConsole.ThrowError($"Error in item prefab {Name}: preferred container has no preferences defined ({subElement.ToString()}).");
}
else
{
PreferredContainers.Add(preferredContainer);
}
break;
case "trigger":
Rectangle trigger = new Rectangle(0, 0, 10, 10)
{
X = subElement.GetAttributeInt("x", 0),
Y = subElement.GetAttributeInt("y", 0),
Width = subElement.GetAttributeInt("width", 0),
Height = subElement.GetAttributeInt("height", 0)
};
Triggers.Add(trigger);
break;
case "levelresource":
foreach (XElement levelCommonnessElement in subElement.Elements())
{
string levelName = levelCommonnessElement.GetAttributeString("levelname", "").ToLowerInvariant();
if (!LevelCommonness.ContainsKey(levelName))
{
LevelCommonness.Add(levelName, levelCommonnessElement.GetAttributeFloat("commonness", 0.0f));
}
}
break;
case "suitabletreatment":
if (subElement.Attribute("name") != null)
{
DebugConsole.ThrowError("Error in item prefab \"" + Name + "\" - suitable treatments should be defined using item identifiers, not item names.");
}
string treatmentIdentifier = subElement.GetAttributeString("identifier", "").ToLowerInvariant();
float suitability = subElement.GetAttributeFloat("suitability", 0.0f);
treatmentSuitability.Add(treatmentIdentifier, suitability);
break;
}
}
if (sprite == null)
{
DebugConsole.ThrowError("Item \"" + Name + "\" has no sprite!");
#if SERVER
sprite = new Sprite("", Vector2.Zero);
sprite.SourceRect = new Rectangle(0, 0, 32, 32);
#else
sprite = new Sprite(TextureLoader.PlaceHolderTexture, null, null)
{
Origin = TextureLoader.PlaceHolderTexture.Bounds.Size.ToVector2() / 2
};
#endif
size = sprite.size;
sprite.EntityID = identifier;
}
if (string.IsNullOrEmpty(identifier))
{
DebugConsole.ThrowError(
"Item prefab \"" + name + "\" has no identifier. All item prefabs have a unique identifier string that's used to differentiate between items during saving and loading.");
}
AllowedLinks = element.GetAttributeStringArray("allowedlinks", new string[0], convertToLowerInvariant: true).ToList();
Prefabs.Add(this, allowOverriding);
}
private bool IsItemConditionAcceptable(Item item, PreferredContainer pc) => item.ConditionPercentage >= pc.MinCondition && item.ConditionPercentage <= pc.MaxCondition;
public ItemPrefab(XElement element, string filePath, bool allowOverriding)
{
FilePath = filePath;
ConfigElement = element;
originalName = element.GetAttributeString("name", "");
name = originalName;
identifier = element.GetAttributeString("identifier", "");
string categoryStr = element.GetAttributeString("category", "Misc");
if (!Enum.TryParse(categoryStr, true, out MapEntityCategory category))
{
category = MapEntityCategory.Misc;
}
Category = category;
var parentType = element.Parent?.GetAttributeString("itemtype", "") ?? string.Empty;
//nameidentifier can be used to make multiple items use the same names and descriptions
string nameIdentifier = element.GetAttributeString("nameidentifier", "");
//works the same as nameIdentifier, but just replaces the description
string descriptionIdentifier = element.GetAttributeString("descriptionidentifier", "");
if (string.IsNullOrEmpty(originalName))
{
if (string.IsNullOrEmpty(nameIdentifier))
{
name = TextManager.Get("EntityName." + identifier, true) ?? string.Empty;
}
else
{
name = TextManager.Get("EntityName." + nameIdentifier, true) ?? string.Empty;
}
}
else if (Category.HasFlag(MapEntityCategory.Legacy))
{
// Legacy items use names as identifiers, so we have to define them in the xml. But we also want to support the translations. Therefore
if (string.IsNullOrEmpty(nameIdentifier))
{
name = TextManager.Get("EntityName." + identifier, true) ?? originalName;
}
else
{
name = TextManager.Get("EntityName." + nameIdentifier, true) ?? originalName;
}
if (string.IsNullOrWhiteSpace(identifier))
{
identifier = GenerateLegacyIdentifier(originalName);
}
}
if (string.Equals(parentType, "wrecked", StringComparison.OrdinalIgnoreCase))
{
if (!string.IsNullOrEmpty(name))
{
name = TextManager.GetWithVariable("wreckeditemformat", "[name]", name);
}
}
if (string.IsNullOrEmpty(name))
{
DebugConsole.ThrowError($"Unnamed item ({identifier}) in {filePath}!");
}
DebugConsole.Log(" " + name);
Aliases = new HashSet <string>
(element.GetAttributeStringArray("aliases", null, convertToLowerInvariant: true) ??
element.GetAttributeStringArray("Aliases", new string[0], convertToLowerInvariant: true));
Aliases.Add(originalName.ToLowerInvariant());
Triggers = new List <Rectangle>();
DeconstructItems = new List <DeconstructItem>();
FabricationRecipes = new List <FabricationRecipe>();
DeconstructTime = 1.0f;
if (element.Attribute("allowasextracargo") != null)
{
AllowAsExtraCargo = element.GetAttributeBool("allowasextracargo", false);
}
Tags = new HashSet <string>(element.GetAttributeStringArray("tags", new string[0], convertToLowerInvariant: true));
if (!Tags.Any())
{
Tags = new HashSet <string>(element.GetAttributeStringArray("Tags", new string[0], convertToLowerInvariant: true));
}
if (element.Attribute("cargocontainername") != null)
{
DebugConsole.ThrowError("Error in item prefab \"" + name + "\" - cargo container should be configured using the item's identifier, not the name.");
}
SerializableProperty.DeserializeProperties(this, element);
if (string.IsNullOrEmpty(Description))
{
if (!string.IsNullOrEmpty(descriptionIdentifier))
{
Description = TextManager.Get("EntityDescription." + descriptionIdentifier, true) ?? string.Empty;
}
else if (string.IsNullOrEmpty(nameIdentifier))
{
Description = TextManager.Get("EntityDescription." + identifier, true) ?? string.Empty;
}
else
{
Description = TextManager.Get("EntityDescription." + nameIdentifier, true) ?? string.Empty;
}
}
var allowDroppingOnSwapWith = element.GetAttributeStringArray("allowdroppingonswapwith", new string[0]);
if (allowDroppingOnSwapWith.Any())
{
AllowDroppingOnSwap = true;
foreach (string tag in allowDroppingOnSwapWith)
{
this.allowDroppingOnSwapWith.Add(tag);
}
}
foreach (XElement subElement in element.Elements())
{
switch (subElement.Name.ToString().ToLowerInvariant())
{
case "sprite":
string spriteFolder = "";
if (!subElement.GetAttributeString("texture", "").Contains("/"))
{
spriteFolder = Path.GetDirectoryName(filePath);
}
CanSpriteFlipX = subElement.GetAttributeBool("canflipx", true);
CanSpriteFlipY = subElement.GetAttributeBool("canflipy", true);
sprite = new Sprite(subElement, spriteFolder, lazyLoad: true);
if (subElement.Attribute("sourcerect") == null)
{
DebugConsole.ThrowError("Warning - sprite sourcerect not configured for item \"" + Name + "\"!");
}
size = sprite.size;
if (subElement.Attribute("name") == null && !string.IsNullOrWhiteSpace(Name))
{
sprite.Name = Name;
}
sprite.EntityID = identifier;
break;
case "price":
if (locationPrices == null)
{
locationPrices = new Dictionary <string, PriceInfo>();
}
if (subElement.Attribute("baseprice") != null)
{
foreach (Tuple <string, PriceInfo> priceInfo in PriceInfo.CreatePriceInfos(subElement, out DefaultPrice))
{
if (priceInfo == null)
{
continue;
}
locationPrices.Add(priceInfo.Item1, priceInfo.Item2);
}
}
else if (subElement.Attribute("buyprice") != null)
{
string locationType = subElement.GetAttributeString("locationtype", "").ToLowerInvariant();
locationPrices.Add(locationType, new PriceInfo(subElement));
}
break;
case "upgradeoverride":
{
#if CLIENT
var sprites = new List <DecorativeSprite>();
foreach (XElement decorSprite in subElement.Elements())
{
if (decorSprite.Name.ToString().Equals("decorativesprite", StringComparison.OrdinalIgnoreCase))
{
sprites.Add(new DecorativeSprite(decorSprite));
}
}
UpgradeOverrideSprites.Add(subElement.GetAttributeString("identifier", ""), sprites);
#endif
break;
}
#if CLIENT
case "inventoryicon":
{
string iconFolder = "";
if (!subElement.GetAttributeString("texture", "").Contains("/"))
{
iconFolder = Path.GetDirectoryName(filePath);
}
InventoryIcon = new Sprite(subElement, iconFolder, lazyLoad: true);
}
break;
case "minimapicon":
{
string iconFolder = "";
if (!subElement.GetAttributeString("texture", "").Contains("/"))
{
iconFolder = Path.GetDirectoryName(filePath);
}
MinimapIcon = new Sprite(subElement, iconFolder, lazyLoad: true);
}
break;
case "infectedsprite":
{
string iconFolder = "";
if (!subElement.GetAttributeString("texture", "").Contains("/"))
{
iconFolder = Path.GetDirectoryName(filePath);
}
InfectedSprite = new Sprite(subElement, iconFolder, lazyLoad: true);
}
break;
case "damagedinfectedsprite":
{
string iconFolder = "";
if (!subElement.GetAttributeString("texture", "").Contains("/"))
{
iconFolder = Path.GetDirectoryName(filePath);
}
DamagedInfectedSprite = new Sprite(subElement, iconFolder, lazyLoad: true);
}
break;
case "brokensprite":
string brokenSpriteFolder = "";
if (!subElement.GetAttributeString("texture", "").Contains("/"))
{
brokenSpriteFolder = Path.GetDirectoryName(filePath);
}
var brokenSprite = new BrokenItemSprite(
new Sprite(subElement, brokenSpriteFolder, lazyLoad: true),
subElement.GetAttributeFloat("maxcondition", 0.0f),
subElement.GetAttributeBool("fadein", false),
subElement.GetAttributePoint("offset", Point.Zero));
int spriteIndex = 0;
for (int i = 0; i < BrokenSprites.Count && BrokenSprites[i].MaxCondition < brokenSprite.MaxCondition; i++)
{
spriteIndex = i;
}
BrokenSprites.Insert(spriteIndex, brokenSprite);
break;
case "decorativesprite":
string decorativeSpriteFolder = "";
if (!subElement.GetAttributeString("texture", "").Contains("/"))
{
decorativeSpriteFolder = Path.GetDirectoryName(filePath);
}
int groupID = 0;
DecorativeSprite decorativeSprite = null;
if (subElement.Attribute("texture") == null)
{
groupID = subElement.GetAttributeInt("randomgroupid", 0);
}
else
{
decorativeSprite = new DecorativeSprite(subElement, decorativeSpriteFolder, lazyLoad: true);
DecorativeSprites.Add(decorativeSprite);
groupID = decorativeSprite.RandomGroupID;
}
if (!DecorativeSpriteGroups.ContainsKey(groupID))
{
DecorativeSpriteGroups.Add(groupID, new List <DecorativeSprite>());
}
DecorativeSpriteGroups[groupID].Add(decorativeSprite);
break;
case "containedsprite":
string containedSpriteFolder = "";
if (!subElement.GetAttributeString("texture", "").Contains("/"))
{
containedSpriteFolder = Path.GetDirectoryName(filePath);
}
var containedSprite = new ContainedItemSprite(subElement, containedSpriteFolder, lazyLoad: true);
if (containedSprite.Sprite != null)
{
ContainedSprites.Add(containedSprite);
}
break;
#endif
case "deconstruct":
DeconstructTime = subElement.GetAttributeFloat("time", 1.0f);
AllowDeconstruct = true;
RandomDeconstructionOutput = subElement.GetAttributeBool("chooserandom", false);
RandomDeconstructionOutputAmount = subElement.GetAttributeInt("amount", 1);
foreach (XElement deconstructItem in subElement.Elements())
{
if (deconstructItem.Attribute("name") != null)
{
DebugConsole.ThrowError("Error in item config \"" + Name + "\" - use item identifiers instead of names to configure the deconstruct items.");
continue;
}
DeconstructItems.Add(new DeconstructItem(deconstructItem));
}
RandomDeconstructionOutputAmount = Math.Min(RandomDeconstructionOutputAmount, DeconstructItems.Count);
break;
case "fabricate":
case "fabricable":
case "fabricableitem":
fabricationRecipeElements.Add(subElement);
break;
case "preferredcontainer":
var preferredContainer = new PreferredContainer(subElement);
if (preferredContainer.Primary.Count == 0 && preferredContainer.Secondary.Count == 0)
{
DebugConsole.ThrowError($"Error in item prefab {Name}: preferred container has no preferences defined ({subElement.ToString()}).");
}
else
{
PreferredContainers.Add(preferredContainer);
}
break;
case "trigger":
Rectangle trigger = new Rectangle(0, 0, 10, 10)
{
X = subElement.GetAttributeInt("x", 0),
Y = subElement.GetAttributeInt("y", 0),
Width = subElement.GetAttributeInt("width", 0),
Height = subElement.GetAttributeInt("height", 0)
};
Triggers.Add(trigger);
break;
case "levelresource":
foreach (XElement levelCommonnessElement in subElement.GetChildElements("commonness"))
{
string levelName = levelCommonnessElement.GetAttributeString("leveltype", "").ToLowerInvariant();
if (!levelCommonnessElement.GetAttributeBool("fixedquantity", false))
{
if (!LevelCommonness.ContainsKey(levelName))
{
LevelCommonness.Add(levelName, levelCommonnessElement.GetAttributeFloat("commonness", 0.0f));
}
}
else
{
if (!LevelQuantity.ContainsKey(levelName))
{
LevelQuantity.Add(levelName, new FixedQuantityResourceInfo(
levelCommonnessElement.GetAttributeInt("clusterquantity", 0),
levelCommonnessElement.GetAttributeInt("clustersize", 0),
levelCommonnessElement.GetAttributeBool("isislandspecific", false),
levelCommonnessElement.GetAttributeBool("allowatstart", true)));
}
}
}
break;
case "suitabletreatment":
if (subElement.Attribute("name") != null)
{
DebugConsole.ThrowError("Error in item prefab \"" + Name + "\" - suitable treatments should be defined using item identifiers, not item names.");
}
string treatmentIdentifier = subElement.GetAttributeString("identifier", "").ToLowerInvariant();
float suitability = subElement.GetAttributeFloat("suitability", 0.0f);
treatmentSuitability.Add(treatmentIdentifier, suitability);
break;
}
}
// Set the default price in case the prices are defined in the old way
// with separate Price elements and there is no default price explicitly set
if (locationPrices != null && locationPrices.Any())
{
DefaultPrice ??= new PriceInfo(GetMinPrice() ?? 0, false);
}
//backwards compatibility
if (categoryStr.Equals("Thalamus", StringComparison.OrdinalIgnoreCase))
{
Category = MapEntityCategory.Wrecked;
Subcategory = "Thalamus";
}
if (sprite == null)
{
DebugConsole.ThrowError("Item \"" + Name + "\" has no sprite!");
#if SERVER
sprite = new Sprite("", Vector2.Zero);
sprite.SourceRect = new Rectangle(0, 0, 32, 32);
#else
sprite = new Sprite(TextureLoader.PlaceHolderTexture, null, null)
{
Origin = TextureLoader.PlaceHolderTexture.Bounds.Size.ToVector2() / 2
};
#endif
size = sprite.size;
sprite.EntityID = identifier;
}
if (string.IsNullOrEmpty(identifier))
{
DebugConsole.ThrowError(
"Item prefab \"" + name + "\" has no identifier. All item prefabs have a unique identifier string that's used to differentiate between items during saving and loading.");
}
#if DEBUG
if (!Category.HasFlag(MapEntityCategory.Legacy) && !HideInMenus)
{
if (!string.IsNullOrEmpty(originalName))
{
DebugConsole.AddWarning($"Item \"{(string.IsNullOrEmpty(identifier) ? name : identifier)}\" has a hard-coded name, and won't be localized to other languages.");
}
}
#endif
AllowedLinks = element.GetAttributeStringArray("allowedlinks", new string[0], convertToLowerInvariant: true).ToList();
Prefabs.Add(this, allowOverriding);
this.CalculatePrefabUIntIdentifier(Prefabs);
}
private static Dictionary <ItemContainer, PreferredContainer> GetValidContainers(PreferredContainer preferredContainer, IEnumerable <ItemContainer> allContainers, Dictionary <ItemContainer, PreferredContainer> validContainers, bool primary)
{
validContainers.Clear();
foreach (ItemContainer container in allContainers)
{
if (!container.AutoFill)
{
continue;
}
if (primary)
{
if (!ItemPrefab.IsContainerPreferred(preferredContainer.Primary, container))
{
continue;
}
}
else
{
if (!ItemPrefab.IsContainerPreferred(preferredContainer.Secondary, container))
{
continue;
}
}
if (!validContainers.ContainsKey(container))
{
validContainers.Add(container, preferredContainer);
}
}
return(validContainers);
}