Documents more ConstructionSystem methods. (#7246)

This commit is contained in:
Vera Aguilera Puerto
2022-03-25 05:00:39 +01:00
committed by GitHub
parent b8ab62b2c6
commit 380bb89f83
4 changed files with 201 additions and 9 deletions

View File

@@ -102,6 +102,14 @@ namespace Content.Server.Construction
}
/// <summary>
/// Returns a <see cref="ConstructionGuide"/> for a given <see cref="ConstructionPrototype"/>,
/// generating and caching it as needed.
/// </summary>
/// <param name="construction">The construction prototype to generate the guide for. We must be able to pathfind
/// from its starting node to its ending node to be able to generate a guide for it.</param>
/// <returns>The guide for the given construction, or null if we can't pathfind from the start node to the
/// end node on that construction.</returns>
private ConstructionGuide? GetGuide(ConstructionPrototype construction)
{
// NOTE: This method might be allocate a fair bit, but do not worry!