Add Lua documentation details

This commit is contained in:
JovialFeline
2025-02-08 06:37:30 -05:00
committed by Gustas
parent b6dcd8d9af
commit 2030c17a8b
4 changed files with 20 additions and 13 deletions

View File

@@ -80,7 +80,8 @@ namespace OpenRA.Mods.Common.Scripting
Self.World.Add(new FlashTarget(Self, color, 0.5f, count, interval, delay));
}
[Desc("The effective owner of the actor.")]
[Desc("The effective (displayed) owner of the actor. " +
"This may differ from the true owner in some cases, such as disguised actors.")]
public Player EffectiveOwner
{
get

View File

@@ -68,7 +68,8 @@ namespace OpenRA.Mods.Common.Scripting
[ScriptActorPropertyActivity]
[Desc("Mark an objective as failed. This needs the objective ID returned " +
"by AddObjective as argument. Secondary objectives do not have any " +
"influence whatsoever on the outcome of the game.")]
"influence whatsoever on the outcome of the game. " +
"It is possible to mark a completed objective as a failure.")]
public void MarkFailedObjective(int id)
{
if (id < 0 || id >= mo.Objectives.Count)