Type Alias GridMeasurePathCostFunction3D<SegmentData>

GridMeasurePathCostFunction3D: (
    from: Readonly<GridOffset3D>,
    to: Readonly<GridOffset3D>,
    distance: number,
    segment: DeepReadonly<SegmentData>,
) => number

A function that returns the cost for a given move between grid spaces in 3D. In square and hexagonal grids the grid spaces are always adjacent unless teleported. The function is never called with the same offsets.

Type Parameters

SegmentData = {}

Type declaration

- (
      from: Readonly<GridOffset3D>,
      to: Readonly<GridOffset3D>,
      distance: number,
      segment: DeepReadonly<SegmentData>,
  ): number
- Parameters
  - from: Readonly<GridOffset3D>
    The offset that is moved from
  - to: Readonly<GridOffset3D>
    The offset that is moved to
  - distance: number
    The distance between the grid spaces
  - segment: DeepReadonly<SegmentData>
    The properties of the segment
  Returns number

Type Alias GridMeasurePathCostFunction3D<SegmentData>

Type Parameters

Type declaration

Parameters

Returns number

Settings