Fix bot module update rule NRE on overrides

We cannot reliably update overrides of base HackyAI definitions,
unless they (re-)define Type.
If they don't, we now instead just list their locations.
This commit is contained in:
reaperrr
2018-11-25 13:05:47 +01:00
committed by Paul Chote
parent 20ba45d467
commit bdbc19376a

View File

@@ -26,6 +26,7 @@ namespace OpenRA.Mods.Common.UpdateRules.Rules
} }
} }
readonly List<string> locations = new List<string>();
bool messageShown; bool messageShown;
readonly string[] harvesterFields = readonly string[] harvesterFields =
@@ -40,13 +41,19 @@ namespace OpenRA.Mods.Common.UpdateRules.Rules
public override IEnumerable<string> AfterUpdate(ModData modData) public override IEnumerable<string> AfterUpdate(ModData modData)
{ {
var message = "You may want to check your AI yamls for possible redundant module entries.\n" +
"Additionally, make sure the Player actor has the ConditionManager trait and add it manually if it doesn't.";
if (!messageShown) if (!messageShown)
yield return message; yield return "You may want to check your AI yamls for possible redundant module entries.\n" +
"Additionally, make sure the Player actor has the ConditionManager trait and add it manually if it doesn't.";
messageShown = true; messageShown = true;
if (locations.Any())
yield return "This update rule can only autoamtically update the base HackyAI definitions,\n" +
"not any overrides in other files (unless they redefine Type).\n" +
"You will have to manually check and possibly update the following locations:\n" +
UpdateUtils.FormatMessageList(locations);
locations.Clear();
} }
public override IEnumerable<string> UpdateActorNode(ModData modData, MiniYamlNode actorNode) public override IEnumerable<string> UpdateActorNode(ModData modData, MiniYamlNode actorNode)
@@ -54,24 +61,39 @@ namespace OpenRA.Mods.Common.UpdateRules.Rules
if (actorNode.Key != "Player") if (actorNode.Key != "Player")
yield break; yield break;
var hackyAIs = actorNode.ChildrenMatching("HackyAI"); var hackyAIs = actorNode.ChildrenMatching("HackyAI", includeRemovals: false);
if (!hackyAIs.Any()) if (!hackyAIs.Any())
yield break; yield break;
var addNodes = new List<MiniYamlNode>(); var addNodes = new List<MiniYamlNode>();
// We add a 'default' HarvesterBotModule in any case, // We add a 'default' HarvesterBotModule in any case (unless the file doesn't contain any HackyAI base definition),
// and only add more for AIs that define custom values for one of its fields. // and only add more for AIs that define custom values for one of its fields.
var defaultHarvNode = new MiniYamlNode("HarvesterBotModule", ""); var defaultHarvNode = new MiniYamlNode("HarvesterBotModule", "");
var addDefaultHarvModule = false;
foreach (var hackyAINode in hackyAIs) foreach (var hackyAINode in hackyAIs)
{ {
// HackyAIInfo.Name might contain spaces, so Type is better suited to be used as condition name // HackyAIInfo.Name might contain spaces, so Type is better suited to be used as condition name.
var aiType = hackyAINode.LastChildMatching("Type").NodeValue<string>(); // Type can be 'null' if the place we're updating is overriding the default rules (like a map's rules.yaml).
// If that's the case, it's better to not perform most of the updates on this particular yaml file,
// as most - or more likely all - necessary updates will already have been performed on the base ai yaml.
var aiTypeNode = hackyAINode.LastChildMatching("Type");
var aiType = aiTypeNode != null ? aiTypeNode.NodeValue<string>() : null;
if (aiType == null)
{
locations.Add("{0} ({1})".F(hackyAINode.Key, hackyAINode.Location.Filename));
continue;
}
addDefaultHarvModule = true;
var conditionString = "enable-" + aiType + "-ai"; var conditionString = "enable-" + aiType + "-ai";
var requiresCondition = new MiniYamlNode("RequiresCondition", conditionString); var requiresCondition = new MiniYamlNode("RequiresCondition", conditionString);
var addGrantConditionOnBotOwner = true; var addGrantConditionOnBotOwner = true;
// Don't add GrantConditionOnBotOwner if it's already been added with matching condition
var grantBotConditions = actorNode.ChildrenMatching("GrantConditionOnBotOwner"); var grantBotConditions = actorNode.ChildrenMatching("GrantConditionOnBotOwner");
foreach (var grant in grantBotConditions) foreach (var grant in grantBotConditions)
if (grant.LastChildMatching("Condition").NodeValue<string>() == conditionString) if (grant.LastChildMatching("Condition").NodeValue<string>() == conditionString)
@@ -140,7 +162,8 @@ namespace OpenRA.Mods.Common.UpdateRules.Rules
} }
} }
addNodes.Add(defaultHarvNode); if (addDefaultHarvModule)
addNodes.Add(defaultHarvNode);
foreach (var node in addNodes) foreach (var node in addNodes)
actorNode.AddNode(node); actorNode.AddNode(node);