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

Merge pull request #12986 from abcdefg30/withDesc

Browse Source 
Expand the documentation of Reinforce(WithTransport)
This commit is contained in:
atlimit8
2017-03-22 10:23:36 -05:00
committed by GitHub
parent cc67f9328c 6069a12973
commit b6810f3dd3
1 changed files with 5 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
OpenRA.Mods.Common/Scripting/Global/ReinforcementsGlobal.cs
View File

@@ -66,7 +66,8 @@ namespace OpenRA.Mods.Common.Scripting
"The first member of the entryPath array will be the units' spawnpoint, " + "The first member of the entryPath array will be the units' spawnpoint, " +
"while the last one will be their destination. If actionFunc is given, " + "while the last one will be their destination. If actionFunc is given, " +
"it will be executed once a unit has reached its destination. actionFunc " + "it will be executed once a unit has reached its destination. actionFunc " +
"will be called as actionFunc(Actor actor)")] "will be called as actionFunc(Actor actor). " +
"Returns a table containing the deployed units.")]
public Actor[] Reinforce(Player owner, string[] actorTypes, CPos[] entryPath, int interval = 25, LuaFunction actionFunc = null) public Actor[] Reinforce(Player owner, string[] actorTypes, CPos[] entryPath, int interval = 25, LuaFunction actionFunc = null)
{ {
var actors = new List<Actor>(); var actors = new List<Actor>();
@@ -107,7 +108,9 @@ namespace OpenRA.Mods.Common.Scripting
"has reached the destination, it will unload its cargo unless a custom actionFunc has " + "has reached the destination, it will unload its cargo unless a custom actionFunc has " +
"been supplied. Afterwards, the transport will follow the exitPath and leave the map, " + "been supplied. Afterwards, the transport will follow the exitPath and leave the map, " +
"unless a custom exitFunc has been supplied. actionFunc will be called as " + "unless a custom exitFunc has been supplied. actionFunc will be called as " +
"actionFunc(Actor transport, Actor[] cargo). exitFunc will be called as exitFunc(Actor transport).")] "actionFunc(Actor transport, Actor[] cargo). exitFunc will be called as exitFunc(Actor transport). " +
"Returns a table in which the first value is the transport, " +
"and the second a table containing the deployed units.")]
public LuaTable ReinforceWithTransport(Player owner, string actorType, string[] cargoTypes, CPos[] entryPath, CPos[] exitPath = null, public LuaTable ReinforceWithTransport(Player owner, string actorType, string[] cargoTypes, CPos[] entryPath, CPos[] exitPath = null,
LuaFunction actionFunc = null, LuaFunction exitFunc = null) LuaFunction actionFunc = null, LuaFunction exitFunc = null)
{ {