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

LuaDocs punctuation fixes

Browse Source
This commit is contained in:
Thijs Waalen
2014-09-06 19:28:59 +02:00
parent a9b5e1d911
commit eb959c5858
5 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
OpenRA.Mods.RA/Scripting/Global/ActorGlobal.cs
View File

@@ -58,7 +58,7 @@ namespace OpenRA.Scripting
return a;
}
[Desc("Returns the build time (in ticks) of the requested unit type")]
[Desc("Returns the build time (in ticks) of the requested unit type.")]
public int BuildTime(string type)
{
ActorInfo ai;

2
OpenRA.Mods.RA/Scripting/Global/MapGlobal.cs
View File

@@ -100,7 +100,7 @@ namespace OpenRA.Mods.RA.Scripting
}
[Desc("Returns the actor that was specified with a given name in " +
"the map file (or nil, if the actor is dead or not found")]
"the map file (or nil, if the actor is dead or not found).")]
public Actor NamedActor(string actorName)
{
Actor ret;

8
OpenRA.Mods.RA/Scripting/Global/TriggerGlobal.cs
View File

@@ -130,14 +130,14 @@ namespace OpenRA.Mods.RA.Scripting
GetScriptTriggers(player.PlayerActor).RegisterCallback(Trigger.OnObjectiveAdded, func, context);
}
[Desc("Call a function when this player completes an objective " +
[Desc("Call a function when this player completes an objective. " +
"The callback function will be called as func(Player player, int objectiveID).")]
public void OnObjectiveCompleted(Player player, LuaFunction func)
{
GetScriptTriggers(player.PlayerActor).RegisterCallback(Trigger.OnObjectiveCompleted, func, context);
}
[Desc("Call a function when this player fails an objective " +
[Desc("Call a function when this player fails an objective. " +
"The callback function will be called as func(Player player, int objectiveID).")]
public void OnObjectiveFailed(Player player, LuaFunction func)
{
@@ -165,13 +165,13 @@ namespace OpenRA.Mods.RA.Scripting
GetScriptTriggers(a).RegisterCallback(Trigger.OnCapture, func, context);
}
[Desc("Removes all triggers from this actor")]
[Desc("Removes all triggers from this actor.")]
public void ClearAll(Actor a)
{
GetScriptTriggers(a).ClearAll();
}
[Desc("Removes the specified trigger from this actor")]
[Desc("Removes the specified trigger from this actor.")]
public void Clear(Actor a, string triggerName)
{
var trigger = (Trigger)Enum.Parse(typeof(Trigger), triggerName);

4
OpenRA.Mods.RA/Scripting/Global/UtilsGlobal.cs
View File

@@ -58,7 +58,7 @@ namespace OpenRA.Mods.RA.Scripting
return true;
}
[Desc("Skips over the first numElements members of the array and returns the rest")]
[Desc("Skips over the first numElements members of the array and returns the rest.")]
public LuaTable Skip(LuaTable table, int numElements)
{
var t = context.CreateTable();
@@ -75,7 +75,7 @@ namespace OpenRA.Mods.RA.Scripting
return table.Values.Random<LuaValue>(context.World.SharedRandom);
}
[Desc("Expands the given footprint one step along the coordinate axes, and (if requested) diagonals")]
[Desc("Expands the given footprint one step along the coordinate axes, and (if requested) diagonals.")]
public LuaTable ExpandFootprint(LuaTable cells, bool allowDiagonal)
{
var footprint = cells.Values.Select(c =>

2
OpenRA.Mods.RA/Scripting/Properties/ProductionProperties.cs
View File

@@ -27,7 +27,7 @@ namespace OpenRA.Mods.RA.Scripting
}
[ScriptActorPropertyActivity]
[Desc("Build a unit, ignoring the production queue. The activity will wait if the exit is blocked")]
[Desc("Build a unit, ignoring the production queue. The activity will wait if the exit is blocked.")]
public void Produce(string actorType, string raceVariant = null)
{
ActorInfo actorInfo;