Explain that CanEnterCell ignores 'subCell' if there is a free subcell

This commit is contained in:
abcdefg30
2019-10-24 19:59:13 +02:00
committed by teinarss
parent 25b7386f0d
commit 142f823e6f

View File

@@ -86,6 +86,9 @@ namespace OpenRA.Mods.Common.Traits
// initialized and used by CanEnterCell
Locomotor locomotor;
/// <summary>
/// Note: If the target <paramref name="cell"/> has any free subcell, the value of <paramref name="subCell"/> is ignored.
/// </summary>
public bool CanEnterCell(World world, Actor self, CPos cell, SubCell subCell = SubCell.FullCell, Actor ignoreActor = null, BlockedByActor check = BlockedByActor.All)
{
// PERF: Avoid repeated trait queries on the hot path