Struct Eval<TOption>

Indicates wether a path to a target is possible.

Namespace: AnyPath.Managed.Results
Assembly: AnyPath.dll
Syntax
public struct Eval<TOption>
Type Parameters
Name Description
TOption

The type of target

Constructors

Eval(AStarEvalOptionResult, TOption)

Constructs an Eval result from a native result.

Declaration
public Eval(AStarEvalOptionResult aStarEvalPathResult, TOption target)
Parameters
Type Name Description
AStarEvalOptionResult aStarEvalPathResult

The native result
TOption target

The target object that was associated with the result

Fields

NoPath

Declaration
public static readonly Eval<TOption> NoPath
Field Value
Type Description
Eval<TOption>

Properties

Cost

The total cost of the path

Declaration
public readonly float Cost { get; }
Property Value
Type Description
float

HasPath

Indicates wether a path was found

Declaration
public readonly bool HasPath { get; }
Property Value
Type Description
bool

Option

The target to which a path was found. If no path was found, this will be null or default.

Declaration
public readonly TOption Option { get; }
Property Value
Type Description
TOption

Methods

CreateResultOption<TJob>(ref TJob, InOptions<TOption, TJob>, out bool)

Declaration
public static Eval<TOption> CreateResultOption<TJob>(ref TJob job, InOptions<TOption, TJob> inOptions, out bool resultCreated) where TJob : struct, IJobOption, IJobOptionEvalResult
Parameters
Type Name Description
TJob job
InOptions<TOption, TJob> inOptions
bool resultCreated
Returns
Type Description
Eval<TOption>
Type Parameters
Name Description
TJob

Extension Methods