Document another pitfall in the Lua API

This commit is contained in:
Oliver Brakmann
2014-10-25 12:45:16 +02:00
parent 93456fd2ab
commit f891b626f3

View File

@@ -202,7 +202,8 @@ namespace OpenRA.Mods.RA.Scripting
"The function will return true if production could be started, false otherwise. " + "The function will return true if production could be started, false otherwise. " +
"If an actionFunc is given, it will be called as actionFunc(Actor[] actors) once " + "If an actionFunc is given, it will be called as actionFunc(Actor[] actors) once " +
"production of all actors has been completed. The actors array is guaranteed to " + "production of all actors has been completed. The actors array is guaranteed to " +
"only contain alive actors.")] "only contain alive actors. Note: This function will fail to work when called " +
"during the first tick")]
public bool Build(string[] actorTypes, LuaFunction actionFunc = null) public bool Build(string[] actorTypes, LuaFunction actionFunc = null)
{ {
var typeToQueueMap = new Dictionary<string, string>(); var typeToQueueMap = new Dictionary<string, string>();