Fix RCS1226
This commit is contained in:
@@ -1106,6 +1106,9 @@ dotnet_diagnostic.RCS1220.severity = warning
|
||||
# Make class sealed.
|
||||
dotnet_diagnostic.RCS1225.severity = warning
|
||||
|
||||
# Add paragraph to documentation comment.
|
||||
dotnet_diagnostic.RCS1226.severity = warning
|
||||
|
||||
# Unnecessary explicit use of enumerator.
|
||||
dotnet_diagnostic.RCS1230.severity = warning
|
||||
|
||||
|
||||
@@ -146,18 +146,22 @@ namespace OpenRA.Activities
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// <para>
|
||||
/// Called every tick to run activity logic. Returns false if the activity should
|
||||
/// remain active, or true if it is complete. Cancelled activities must ensure they
|
||||
/// return the actor to a consistent state before returning true.
|
||||
///
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// Child activities can be queued using QueueChild, and these will be ticked
|
||||
/// instead of the parent while they are active. Activities that need to run logic
|
||||
/// in parallel with child activities should set ChildHasPriority to false and
|
||||
/// manually call TickChildren.
|
||||
///
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// Queuing one or more child activities and returning true is valid, and causes
|
||||
/// the activity to be completed immediately (without ticking again) once the
|
||||
/// children have completed.
|
||||
/// </para>
|
||||
/// </summary>
|
||||
public virtual bool Tick(Actor self)
|
||||
{
|
||||
@@ -222,10 +226,11 @@ namespace OpenRA.Activities
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Prints the activity tree, starting from the top or optionally from a given origin.
|
||||
///
|
||||
/// <para>Prints the activity tree, starting from the top or optionally from a given origin.</para>
|
||||
/// <para>
|
||||
/// Call this method from any place that's called during a tick, such as the Tick() method itself or
|
||||
/// the Before(First|Last)Run() methods. The origin activity will be marked in the output.
|
||||
/// </para>
|
||||
/// </summary>
|
||||
/// <param name="self">The actor performing this activity.</param>
|
||||
/// <param name="origin">Activity from which to start traversing, and which to mark. If null, mark the calling activity, and start traversal from the top.</param>
|
||||
|
||||
@@ -74,14 +74,17 @@ namespace OpenRA.Scripting
|
||||
/// Provides global bindings in Lua code.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// Instance methods and properties declared in derived classes will be made available in Lua. Use
|
||||
/// <see cref="ScriptGlobalAttribute"/> on your derived class to specify the name exposed in Lua. It is recommended
|
||||
/// to apply <see cref="DescAttribute"/> against each method or property to provide a description of what it does.
|
||||
///
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// Any parameters to your method that are <see cref="LuaValue"/>s will be disposed automatically when your method
|
||||
/// completes. If you need to return any of these values, or need them to live longer than your method, you must
|
||||
/// use <see cref="LuaValue.CopyReference"/> to get your own copy of the value. Any copied values you return will
|
||||
/// be disposed automatically, but you assume responsibility for disposing any other copies.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
public abstract class ScriptGlobal : ScriptObjectWrapper
|
||||
{
|
||||
|
||||
@@ -632,17 +632,20 @@ namespace OpenRA.Mods.Common.Pathfinder
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// <para>
|
||||
/// <see cref="BlockedByActor.Immovable"/> defines immovability based on the mobile trait. The blocking rules
|
||||
/// in <see cref="Locomotor.CanMoveFreelyInto(Actor, CPos, SubCell, BlockedByActor, Actor, bool)"/> allow units
|
||||
/// to pass these immovable actors if they are temporary blockers (e.g. gates) or crushable by the locomotor.
|
||||
/// Since our abstract graph must work for any actor, we have to be conservative and can only consider a subset
|
||||
/// of the immovable actors in the graph - ones we know cannot be passed by some actors due to these rules.
|
||||
/// Both this and <see cref="ActorCellIsBlocking"/> must be true for a cell to be blocked.
|
||||
///
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// This method is dependant on the logic in
|
||||
/// <see cref="Locomotor.CanMoveFreelyInto(Actor, CPos, SubCell, BlockedByActor, Actor, bool)"/> and
|
||||
/// <see cref="Locomotor.UpdateCellBlocking"/>. This method must be kept in sync with changes in the locomotor
|
||||
/// rules.
|
||||
/// </para>
|
||||
/// </summary>
|
||||
bool ActorIsBlocking(Actor actor)
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user