Skip to content

Commit dccad1f

Browse files
committed
#477 fix typedocs
1 parent e0a9285 commit dccad1f

File tree

3 files changed

+22
-7
lines changed

3 files changed

+22
-7
lines changed

src/GridEngine.ts

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,14 @@ import {
7373
PathfindingOptions,
7474
} from "./Pathfinding/PathfindingOptions.js";
7575
import { CharLayer, LayerPosition, Position } from "./Position.js";
76+
import { Concrete } from "./Utils/TypeUtils.js";
77+
import { GridCharacterStatePhaser } from "./GridEnginePhaser/GridCharacterStatePhaser.js";
78+
import {
79+
RawTiledLayer,
80+
RawTiledTileset,
81+
RawTiledTilesetTile,
82+
RawTiledTilesetTileProp,
83+
} from "./GridTilemap/TiledTilemap/TiledMap.js";
7684

7785
export {
7886
ArrayTilemap,
@@ -84,14 +92,17 @@ export {
8492
CharLayer,
8593
CollisionConfig,
8694
CollisionStrategy,
95+
Concrete,
8796
Direction,
8897
Finished,
8998
FollowOptions,
9099
FrameRow,
91100
GridCharacterState,
101+
GridCharacterStatePhaser,
92102
GridEngineConfigHeadless,
93103
GridEngineHeadless,
94104
GridEngineState,
105+
GridEngineStatePhaser,
95106
IGridEngine,
96107
IsPositionAllowedFn,
97108
LayerPosition,
@@ -115,6 +126,10 @@ export {
115126
QueueMovementFinished,
116127
QueueMovementResult,
117128
QueuedPathBlockedStrategy,
129+
RawTiledLayer,
130+
RawTiledTileset,
131+
RawTiledTilesetTile,
132+
RawTiledTilesetTileProp,
118133
ShortestPathAlgorithmType,
119134
Tile,
120135
TiledProject,

src/Movement/TargetMovement/TargetMovement.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -46,15 +46,15 @@ export interface MoveToConfig {
4646
pathBlockedStrategy?: PathBlockedStrategy;
4747

4848
/**
49-
* Only relevant if {@link MoveToConfig.noPathFoundStrategy} is set to {@link NoPathFoundStrategy.RETRY}.
49+
* Only relevant if {@link noPathFoundStrategy} is set to {@link NoPathFoundStrategy.RETRY}.
5050
*
5151
* It sets the time in milliseconds that the pathfinding algorithm will wait
5252
* until the next retry.
5353
*/
5454
noPathFoundRetryBackoffMs?: number;
5555

5656
/**
57-
* Only relevant if {@link MoveToConfig.noPathFoundStrategy} is set to {@link NoPathFoundStrategy.RETRY}.
57+
* Only relevant if {@link noPathFoundStrategy} is set to {@link NoPathFoundStrategy.RETRY}.
5858
*
5959
* It sets the maximum amount of retries before giving up.
6060
*/
@@ -132,17 +132,17 @@ export interface MoveToConfig {
132132
considerCosts?: boolean;
133133

134134
/**
135-
* Only relevant if {@link MoveToConfig.pathBlockedStrategy} is set to {@link
136-
* PathBlockedStrategy.ALTERNATIVE_TARGETS}.
135+
* Only relevant if {@link MoveToConfig.noPathFoundStrategy} is set to {@link
136+
* NoPathFoundStrategy.ALTERNATIVE_TARGETS}.
137137
*
138138
* It provides a list of alternative targets that are considered if the main
139139
* target is not reachable. That list is processed in order.
140140
*/
141141
alternativeTargets?: LayerPosition[];
142142

143143
/**
144-
* Only relevant if {@link MoveToConfig.pathBlockedStrategy} is set to {@link
145-
* PathBlockedStrategy.ALTERNATIVE_TARGETS}.
144+
* Only relevant if {@link MoveToConfig.noPathFoundStrategy} is set to {@link
145+
* NoPathFoundStrategy.ALTERNATIVE_TARGETS}.
146146
*
147147
* In case all these targets are blocked this is the fallback strategy.
148148
*/

src/Pathfinding/NoPathFoundStrategy.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ export enum NoPathFoundStrategy {
2929
/**
3030
* Tries each of {@link MoveToConfig.alternativeTargets}. If there does not
3131
* exist a path to any of these targets, {@link
32-
* MoveToConfig.noPathFoundAlternativeTargetsStrategy} determines the fallback
32+
* MoveToConfig.noPathFoundAlternativeTargetsFallbackStrategy} determines the fallback
3333
* strategy.
3434
*/
3535
ALTERNATIVE_TARGETS = "ALTERNATIVE_TARGETS",

0 commit comments

Comments
 (0)