Struct FlowFieldQueryOptions

Namespace

Trailblazer.Pathing

Assembly

Trailblazer.dll

Defines immutable options specific to destination-centric flow field queries.

public readonly struct FlowFieldQueryOptions : IEquatable<FlowFieldQueryOptions>

Implements

IEquatable<FlowFieldQueryOptions>

Inherited Members

ValueType.ToString()

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

FlowFieldQueryOptions(Fixed64)

Creates immutable flow field query options.

public FlowFieldQueryOptions(Fixed64 extraIntegrationCost)

Parameters

extraIntegrationCost Fixed64

Exceptions

ArgumentOutOfRangeException

Thrown when the extra integration cost is negative.

Properties

ExtraIntegrationCost

Gets the non-negative additional integration cost applied by the flow query.

public Fixed64 ExtraIntegrationCost { get; }

Property Value

Fixed64

Methods

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

Equals(FlowFieldQueryOptions)

public bool Equals(FlowFieldQueryOptions other)

Parameters

other FlowFieldQueryOptions

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

Operators

operator ==(FlowFieldQueryOptions, FlowFieldQueryOptions)

Returns whether two option values are exactly equal.

public static bool operator ==(FlowFieldQueryOptions left, FlowFieldQueryOptions right)

Parameters

left FlowFieldQueryOptions

right FlowFieldQueryOptions

Returns

bool

operator !=(FlowFieldQueryOptions, FlowFieldQueryOptions)

Returns whether two option values differ.

public static bool operator !=(FlowFieldQueryOptions left, FlowFieldQueryOptions right)

Parameters

left FlowFieldQueryOptions

right FlowFieldQueryOptions

Returns

bool