PathResult

AUTO-GENERATED FILE – DO NOT EDIT MANUALLY

This page documents the supported public API surface only. Private, internal, benchmark, test, and implementation-detail types are intentionally omitted.

Declaration

1
public record PathResult

Summary

Represents the result of a pathfinding operation.

Metadata

Namespace: GridPlacement.Core.Services

Source File: cs/Core/Services/HPAPathfindingService.cs

Assembly: GridPlacement.Core

Type: record

Implements

  • IEquatable<PathResult>

Properties

Success

1
public bool Success { get; init; }

Gets a value indicating whether the pathfinding succeeded.


Path

1
public List<GridPosition> Path { get; init; }

Gets the path if successful.


ErrorMessage

1
public string ErrorMessage { get; init; }

Gets the error message if failed.


Methods

CreateSuccess

1
public static PathResult CreateSuccess(List<GridPosition> path)

CreateFailure

1
public static PathResult CreateFailure(string error)

Creates a failed path result.