epic/OpenRA
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve consistency between the update rule code and descriptions.

Browse Source
This commit is contained in:
Paul Chote
2018-04-28 18:05:25 +00:00
committed by abcdefg30
parent 8c2f25e249
commit efc744dec3
7 changed files with 36 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
OpenRA.Mods.Common/UpdateRules/Rules/AddEditorPlayer.cs
View File

@@ -21,20 +21,29 @@ namespace OpenRA.Mods.Common.UpdateRules.Rules
{
get
{
return "Map editor now requires an EditorPlayer to avoid loading all kinds of unnecessary player traits.";
return "Map editor now requires an EditorPlayer to avoid loading unnecessary player traits.\n" +
"A warning is displayed if this actor has not been defined.";
}
}
bool messageDisplayed;
bool warningRequired = true;
public override IEnumerable<string> AfterUpdate(ModData modData)
{
if (!messageDisplayed)
if (warningRequired)
{
messageDisplayed = true;
warningRequired = false;
yield return "The map editor now requires an EditorPlayer actor.\n" +
"Please add an EditorPlayer with the traits AlwaysVisible and Shroud to player.yaml\n(or a different rules yaml file of your choice).";
}
}
public override IEnumerable<string> UpdateActorNode(ModData modData, MiniYamlNode actorNode)
{
if (actorNode.KeyMatches("EditorPlayer"))
warningRequired = false;
yield break;
}
}
}