Add a comment explaining some of the sequence parsing code

2015-11-09 19:26:37 -06:00
parent 496f8d7ddf
commit 2fc391c5b8
1 changed files with 9 additions and 0 deletions
--- a/OpenRA.Mods.Common/Graphics/DefaultSpriteSequence.cs
+++ b/OpenRA.Mods.Common/Graphics/DefaultSpriteSequence.cs
@@ -37,6 +37,15 @@ namespace OpenRA.Mods.Common.Graphics
 				nodes.Remove("Defaults");
 				nodes = nodes.ToDictionary(kv => kv.Key, kv => MiniYaml.MergeStrict(kv.Value, defaults));

+				// Merge 'Defaults' animation image value. An example follows.
+				//
+				// - Before -
+				// stand:
+				// 	Facings: 8
+				//
+				// - After -
+				// stand: e1
+				// 	Facings: 8
 				foreach (var n in nodes)
 					n.Value.Value = n.Value.Value ?? defaults.Value;
 			}