diff --git a/docs/public/api/classes/ArrayTilemap.html b/docs/public/api/classes/ArrayTilemap.html index 2c84cb00..f63eca9e 100644 --- a/docs/public/api/classes/ArrayTilemap.html +++ b/docs/public/api/classes/ArrayTilemap.html @@ -29,7 +29,7 @@

Implements

+
  • Defined in GridTilemap/ArrayTilemap/ArrayTilemap.ts:22
    • @@ -66,7 +66,7 @@
    orientation: collisionPropertyName: string = "ge_collide"

    Returns ArrayTilemap

    +
  • Defined in GridTilemap/ArrayTilemap/ArrayTilemap.ts:26

    • Methods

    @@ -77,7 +77,7 @@

    getHeightReturns number

    +
  • Defined in GridTilemap/ArrayTilemap/ArrayTilemap.ts:66

    • getLayers

    +
  • Defined in GridTilemap/ArrayTilemap/ArrayTilemap.ts:72

    • getOrientation

    +
  • Defined in GridTilemap/ArrayTilemap/ArrayTilemap.ts:69

    • getTileAt

    +
  • Defined in GridTilemap/ArrayTilemap/ArrayTilemap.ts:81

    • getWidth

    +
  • Defined in GridTilemap/ArrayTilemap/ArrayTilemap.ts:63

    • hasTileAt

    +
  • Defined in GridTilemap/ArrayTilemap/ArrayTilemap.ts:75
    • diff --git a/docs/public/api/classes/GridEngine.html b/docs/public/api/classes/GridEngine.html index d9b67025..389d7fe5 100644 --- a/docs/public/api/classes/GridEngine.html +++ b/docs/public/api/classes/GridEngine.html @@ -24,7 +24,7 @@

    Implements

    +
  • Defined in GridEngine.ts:235
    • @@ -146,7 +146,7 @@

    Returns void

    +
  • Defined in GridEngine.ts:326

    • steppedOn

    +
  • Defined in GridEngine.ts:828

    • stopMovement

      @@ -190,7 +190,7 @@

      Returns void

    +
  • Defined in GridEngine.ts:366

    • turnTowards

    +
  • Defined in GridEngine.ts:679

    • Character

    @@ -234,7 +234,7 @@

    Returns void

    +
  • Defined in GridEngine.ts:586

    • clearLabels

    +
  • Defined in GridEngine.ts:604

    • collidesWithTiles

    +
  • Defined in GridEngine.ts:453

    • directionChanged

    +
  • Defined in GridEngine.ts:872

    • getAllCharacters

    +
  • Defined in GridEngine.ts:568

    • getCharLayer

    +
  • Defined in GridEngine.ts:268

    • getCollisionGroups

    +
  • Defined in GridEngine.ts:758

    • getContainer

    +
  • Defined in GridEngine.ts:393

    • getFacingDirection

    +
  • Defined in GridEngine.ts:661

    • getFacingPosition

    +
  • Defined in GridEngine.ts:670

    • getIgnoreCollisionGroups

    +
  • Defined in GridEngine.ts:776

    • getLabels

    +
  • Defined in GridEngine.ts:577

    • getMovement

    +
  • Defined in GridEngine.ts:344

    • getMovementProgress

    +
  • Defined in GridEngine.ts:899

    • getOffsetX

    +
  • Defined in GridEngine.ts:405

    • getOffsetY

    +
  • Defined in GridEngine.ts:429

    • getPosition

    +
  • Defined in GridEngine.ts:317

    • getSpeed

    +
  • Defined in GridEngine.ts:384

    • getSprite

    +
  • Defined in GridEngine.ts:710

    • getWalkingAnimationMapping

    +
  • Defined in GridEngine.ts:463

    • isMoving

    +
  • Defined in GridEngine.ts:652

    • movementStarted

    +
  • Defined in GridEngine.ts:854

    • movementStopped

    +
  • Defined in GridEngine.ts:863

    • positionChangeFinished

    +
  • Defined in GridEngine.ts:890

    • positionChangeStarted

    +
  • Defined in GridEngine.ts:881

    • removeLabels

    +
  • Defined in GridEngine.ts:595

    • setCollisionGroups

    +
  • Defined in GridEngine.ts:767

    • setIgnoreCollisionGroups

    +
  • Defined in GridEngine.ts:785

    • setOffsetX

    +
  • Defined in GridEngine.ts:417

    • setOffsetY

    +
  • Defined in GridEngine.ts:441

    • setPosition

    +
  • Defined in GridEngine.ts:701

    • setSpeed

    +
  • Defined in GridEngine.ts:375

    • setSprite

    +
  • Defined in GridEngine.ts:722

    • setWalkingAnimationMapping

    +
  • Defined in GridEngine.ts:492

    • Grid Engine

    @@ -838,7 +838,7 @@
    charData: Returns void
    +
  • Defined in GridEngine.ts:519

    • create

    +
  • Defined in GridEngine.ts:296

    • hasCharacter

    +
  • Defined in GridEngine.ts:529

    • hasLayerOverlay

    +
  • Defined in GridEngine.ts:479

    • rebuildTileCollisionCache

    +
  • Defined in GridEngine.ts:908

    • removeAllCharacters

    +
  • Defined in GridEngine.ts:553

    • removeCharacter

    +
  • Defined in GridEngine.ts:538

    • GridEngine

    @@ -964,7 +964,7 @@

    Returns Observab

    +
  • Defined in GridEngine.ts:845

    • getState

    +
  • Defined in GridEngine.ts:967

    • setState

    +
  • Defined in GridEngine.ts:988

    • Other

    Static welcomeMessagePrinted

    welcomeMessagePrinted: boolean = false
    +
  • Defined in GridEngine.ts:236

    • Pathfinding

    @@ -1037,7 +1037,7 @@

    Returns

    +
  • Defined in GridEngine.ts:815

    • follow

  • @@ -1111,7 +1111,7 @@

    Deprecated

    Use follow(charId: string, charIdToFollow: string, options

    • +
  • Defined in GridEngine.ts:614

    • getTileCost

    +
  • Defined in GridEngine.ts:1006

    • moveTo

    +
  • Defined in GridEngine.ts:353

    • Queue Movement

    @@ -1198,7 +1198,7 @@

    Returns void

    +
  • Defined in GridEngine.ts:922

    • clearEnqueuedMovements

    +
  • Defined in GridEngine.ts:955

    • getEnqueuedMovements

    +
  • Defined in GridEngine.ts:935

    • queueMovementFinished

    +
  • Defined in GridEngine.ts:944

    • Random Movement

    @@ -1287,7 +1287,7 @@

    Returns void

    +
  • Defined in GridEngine.ts:335

    • Tilemap

    @@ -1311,7 +1311,7 @@

    Returns string

    +
  • Defined in GridEngine.ts:692

    • getTilePosInDirection

    +
  • Defined in GridEngine.ts:797

    • getTransition

    +
  • Defined in GridEngine.ts:277

    • isBlocked

    +
  • Defined in GridEngine.ts:736

    • isTileBlocked

    +
  • Defined in GridEngine.ts:749

    • setTransition

    +
  • Defined in GridEngine.ts:286
    • diff --git a/docs/public/api/classes/GridEngineHeadless.html b/docs/public/api/classes/GridEngineHeadless.html index a655097d..a71090a1 100644 --- a/docs/public/api/classes/GridEngineHeadless.html +++ b/docs/public/api/classes/GridEngineHeadless.html @@ -24,7 +24,7 @@

    Implements

    +
  • Defined in GridEngineHeadless.ts:281
    • @@ -137,7 +137,7 @@

    Returns void

    +
  • Defined in GridEngineHeadless.ts:413

    • steppedOn

    +
  • Defined in GridEngineHeadless.ts:1030

    • turnTowards

      @@ -182,7 +182,7 @@

      Returns void

    +
  • Defined in GridEngineHeadless.ts:843

    • Character

    @@ -205,7 +205,7 @@

    Returns void

    +
  • Defined in GridEngineHeadless.ts:710

    • clearLabels

    +
  • Defined in GridEngineHeadless.ts:734

    • collidesWithTiles

    +
  • Defined in GridEngineHeadless.ts:529

    • directionChanged

    +
  • Defined in GridEngineHeadless.ts:1102

    • getCharLayer

    +
  • Defined in GridEngineHeadless.ts:310

    • getCollisionGroups

    +
  • Defined in GridEngineHeadless.ts:916

    • getFacingDirection

    +
  • Defined in GridEngineHeadless.ts:818

    • getFacingPosition

    +
  • Defined in GridEngineHeadless.ts:830

    • getIgnoreCollisionGroups

    +
  • Defined in GridEngineHeadless.ts:940

    • getLabels

    +
  • Defined in GridEngineHeadless.ts:698

    • getMovement

    +
  • Defined in GridEngineHeadless.ts:435

    • getMovementProgress

    +
  • Defined in GridEngineHeadless.ts:1132

    • getPosition

    +
  • Defined in GridEngineHeadless.ts:401

    • getSpeed

    +
  • Defined in GridEngineHeadless.ts:517

    • isMoving

    +
  • Defined in GridEngineHeadless.ts:806

    • movementStarted

    +
  • Defined in GridEngineHeadless.ts:1082

    • movementStopped

    +
  • Defined in GridEngineHeadless.ts:1092

    • positionChangeFinished

    +
  • Defined in GridEngineHeadless.ts:1122

    • positionChangeStarted

    +
  • Defined in GridEngineHeadless.ts:1112

    • rebuildTileCollisionCache

    +
  • Defined in GridEngineHeadless.ts:1144

    • removeLabels

    +
  • Defined in GridEngineHeadless.ts:722

    • setCollisionGroups

    +
  • Defined in GridEngineHeadless.ts:928

    • setIgnoreCollisionGroups

    +
  • Defined in GridEngineHeadless.ts:952

    • setPosition

    +
  • Defined in GridEngineHeadless.ts:870

    • setSpeed

    +
  • Defined in GridEngineHeadless.ts:504

    • stopMovement

    +
  • Defined in GridEngineHeadless.ts:492

    • Grid Engine

    @@ -691,7 +691,7 @@
    charData: Returns void
    +
  • Defined in GridEngineHeadless.ts:553

    • create

    +
  • Defined in GridEngineHeadless.ts:347

    • getAllCharacters

    +
  • Defined in GridEngineHeadless.ts:683

    • hasCharacter

    +
  • Defined in GridEngineHeadless.ts:646

    • removeAllCharacters

    +
  • Defined in GridEngineHeadless.ts:670

    • removeCharacter

    +
  • Defined in GridEngineHeadless.ts:656

    • update

    +
  • Defined in GridEngineHeadless.ts:539

    • GridEngine

    @@ -810,7 +810,7 @@

    Returns Observab

    +
  • Defined in GridEngineHeadless.ts:1057

    • getState

    +
  • Defined in GridEngineHeadless.ts:1275

    • setState

    +
  • Defined in GridEngineHeadless.ts:1311

    • Other

    @@ -857,7 +857,7 @@

    Parameters

    printWelcomeMessage: boolean = true

    Returns GridEngineHeadless

    +
  • Defined in GridEngineHeadless.ts:299

    • Pathfinding

    @@ -891,7 +891,7 @@

    Returns

    +
  • Defined in GridEngineHeadless.ts:992

    • follow

  • @@ -965,7 +965,7 @@

    Deprecated

    Use follow(charId: string, charIdToFollow: string, options

    • +
  • Defined in GridEngineHeadless.ts:747

    • getTileCost

    +
  • Defined in GridEngineHeadless.ts:1253

    • moveTo

    +
  • Defined in GridEngineHeadless.ts:453

    • Queue Movement

    @@ -1052,7 +1052,7 @@

    Returns void

    +
  • Defined in GridEngineHeadless.ts:1158

    • clearEnqueuedMovements

    +
  • Defined in GridEngineHeadless.ts:1238

    • getEnqueuedMovements

    +
  • Defined in GridEngineHeadless.ts:1215

    • queueMovementFinished

    +
  • Defined in GridEngineHeadless.ts:1203

    • Random Movement

    @@ -1141,7 +1141,7 @@

    Returns void

    +
  • Defined in GridEngineHeadless.ts:422

    • Tilemap

    @@ -1165,7 +1165,7 @@

    Returns string

    +
  • Defined in GridEngineHeadless.ts:855

    • getTilePosInDirection

    +
  • Defined in GridEngineHeadless.ts:967

    • getTransition

    +
  • Defined in GridEngineHeadless.ts:322

    • isBlocked

    +
  • Defined in GridEngineHeadless.ts:888

    • isTileBlocked

    +
  • Defined in GridEngineHeadless.ts:906

    • setTransition

    +
  • Defined in GridEngineHeadless.ts:332
    • diff --git a/docs/public/api/classes/PhaserTile.html b/docs/public/api/classes/PhaserTile.html index 17e2231f..8e8504bb 100644 --- a/docs/public/api/classes/PhaserTile.html +++ b/docs/public/api/classes/PhaserTile.html @@ -24,7 +24,7 @@

    Implements

    +
  • Defined in GridTilemap/Phaser/PhaserTile.ts:5
    • @@ -55,7 +55,7 @@
    phaserTile: Optional tiledProject: TiledProject

    Returns PhaserTile

    +
  • Defined in GridTilemap/Phaser/PhaserTile.ts:6

    • Methods

    @@ -71,7 +71,7 @@
    name: Returns any
    +
  • Defined in GridTilemap/Phaser/PhaserTile.ts:11

    • hasProperty

    +
  • Defined in GridTilemap/Phaser/PhaserTile.ts:29
    • diff --git a/docs/public/api/classes/PhaserTileLayer.html b/docs/public/api/classes/PhaserTileLayer.html index 8a109e73..328e6fc7 100644 --- a/docs/public/api/classes/PhaserTileLayer.html +++ b/docs/public/api/classes/PhaserTileLayer.html @@ -24,7 +24,7 @@

    Implements

    +
  • Defined in GridTilemap/Phaser/PhaserTileLayer.ts:5
    • @@ -58,7 +58,7 @@
    phaserTilemapLayer: Optional tiledProject: TiledProject

    Returns PhaserTileLayer

    +
  • Defined in GridTilemap/Phaser/PhaserTileLayer.ts:6

    • Methods

    @@ -69,7 +69,7 @@

    getDataReturns Tile[][]

    +
  • Defined in GridTilemap/Phaser/PhaserTileLayer.ts:31

    • getName

    +
  • Defined in GridTilemap/Phaser/PhaserTileLayer.ts:11

    • getProperty

    +
  • Defined in GridTilemap/Phaser/PhaserTileLayer.ts:15

    • hasProperty

    +
  • Defined in GridTilemap/Phaser/PhaserTileLayer.ts:23

    • isCharLayer

    +
  • Defined in GridTilemap/Phaser/PhaserTileLayer.ts:27
    • diff --git a/docs/public/api/classes/PhaserTilemap.html b/docs/public/api/classes/PhaserTilemap.html index 20e2f547..757c3c8f 100644 --- a/docs/public/api/classes/PhaserTilemap.html +++ b/docs/public/api/classes/PhaserTilemap.html @@ -24,7 +24,7 @@

    Implements

    +
  • Defined in GridTilemap/Phaser/PhaserTilemap.ts:18
    • @@ -61,7 +61,7 @@
    phaserTilemap: Optional tiledProject: TiledProject

    Returns PhaserTilemap

    +
  • Defined in GridTilemap/Phaser/PhaserTilemap.ts:19

    • Methods

    @@ -72,7 +72,7 @@

    getHeightReturns number

    +
  • Defined in GridTilemap/Phaser/PhaserTilemap.ts:44

    • getLayers

    +
  • Defined in GridTilemap/Phaser/PhaserTilemap.ts:60

    • getOrientation

    +
  • Defined in GridTilemap/Phaser/PhaserTilemap.ts:48

    • getTileAt

    +
  • Defined in GridTilemap/Phaser/PhaserTilemap.ts:70

    • getTileHeight

    +
  • Defined in GridTilemap/Phaser/PhaserTilemap.ts:36

    • getTileWidth

    +
  • Defined in GridTilemap/Phaser/PhaserTilemap.ts:32

    • getWidth

    +
  • Defined in GridTilemap/Phaser/PhaserTilemap.ts:40

    • hasTileAt

    +
  • Defined in GridTilemap/Phaser/PhaserTilemap.ts:66
    • diff --git a/docs/public/api/classes/TiledLayer.html b/docs/public/api/classes/TiledLayer.html index 79b36bcb..c8df84c8 100644 --- a/docs/public/api/classes/TiledLayer.html +++ b/docs/public/api/classes/TiledLayer.html @@ -24,7 +24,7 @@

    Implements

    +
  • Defined in GridTilemap/TiledTilemap/TiledLayer.ts:5
    • @@ -58,7 +58,7 @@
    tilesets: layer: RawTiledLayer

    Returns TiledLayer

    +
  • Defined in GridTilemap/TiledTilemap/TiledLayer.ts:7

    • Methods

    @@ -69,7 +69,7 @@

    getDataReturns (undefined | Tile)[][]

    +
  • Defined in GridTilemap/TiledTilemap/TiledLayer.ts:36

    • getName

    +
  • Defined in GridTilemap/TiledTilemap/TiledLayer.ts:27

    • getProperty

    +
  • Defined in GridTilemap/TiledTilemap/TiledLayer.ts:30

    • hasProperty

    +
  • Defined in GridTilemap/TiledTilemap/TiledLayer.ts:33

    • isCharLayer

    +
  • Defined in GridTilemap/TiledTilemap/TiledLayer.ts:39
    • diff --git a/docs/public/api/classes/TiledTile.html b/docs/public/api/classes/TiledTile.html index e82c9276..a0a4226d 100644 --- a/docs/public/api/classes/TiledTile.html +++ b/docs/public/api/classes/TiledTile.html @@ -24,7 +24,7 @@

    Implements

    +
  • Defined in GridTilemap/TiledTilemap/TiledTile.ts:4
    • @@ -55,7 +55,7 @@
    tilesets: tileId: number

    Returns TiledTile

    +
  • Defined in GridTilemap/TiledTilemap/TiledTile.ts:6

    • Methods

    @@ -71,7 +71,7 @@
    name: Returns any
    +
  • Defined in GridTilemap/TiledTilemap/TiledTile.ts:31

    • hasProperty

    +
  • Defined in GridTilemap/TiledTilemap/TiledTile.ts:34
    • diff --git a/docs/public/api/classes/TiledTilemap.html b/docs/public/api/classes/TiledTilemap.html index 7823ed49..11bc99c0 100644 --- a/docs/public/api/classes/TiledTilemap.html +++ b/docs/public/api/classes/TiledTilemap.html @@ -31,7 +31,7 @@

    Implements

    +
  • Defined in GridTilemap/TiledTilemap/TiledTilemap.ts:13
    • @@ -64,7 +64,7 @@

    Parameters

    rawTilemap: any

    Returns TiledTilemap

    +
  • Defined in GridTilemap/TiledTilemap/TiledTilemap.ts:15

    • Methods

    @@ -75,7 +75,7 @@

    getHeightReturns number

    +
  • Defined in GridTilemap/TiledTilemap/TiledTilemap.ts:59

    • getLayers

    +
  • Defined in GridTilemap/TiledTilemap/TiledTilemap.ts:51

    • getOrientation

    +
  • Defined in GridTilemap/TiledTilemap/TiledTilemap.ts:47

    • getTileAt

    +
  • Defined in GridTilemap/TiledTilemap/TiledTilemap.ts:35

    • getWidth

    +
  • Defined in GridTilemap/TiledTilemap/TiledTilemap.ts:55

    • hasTileAt

    +
  • Defined in GridTilemap/TiledTilemap/TiledTilemap.ts:21
    • diff --git a/docs/public/api/enums/CharacterShiftAction.html b/docs/public/api/enums/CharacterShiftAction.html index db637335..6d9891aa 100644 --- a/docs/public/api/enums/CharacterShiftAction.html +++ b/docs/public/api/enums/CharacterShiftAction.html @@ -20,7 +20,7 @@

    Enumeration CharacterShiftAction

    +
  • Defined in IGridEngine.ts:126
    • @@ -40,7 +40,7 @@

    ADDED

    +
  • Defined in IGridEngine.ts:130

    • REMOVED

    REMOVED: "REMOVED"
    @@ -48,7 +48,7 @@

    REMOVED

    +
  • Defined in IGridEngine.ts:128
    • diff --git a/docs/public/api/enums/CollisionStrategy.html b/docs/public/api/enums/CollisionStrategy.html index f9f35b45..bf807855 100644 --- a/docs/public/api/enums/CollisionStrategy.html +++ b/docs/public/api/enums/CollisionStrategy.html @@ -16,7 +16,7 @@
  • CollisionStrategy

    • Enumeration CollisionStrategy

    +
  • Defined in Collisions/CollisionStrategy.ts:4
    • @@ -37,7 +37,7 @@

    BLOCK_ONE_TILE_AHEAD<

    +
  • Defined in Collisions/CollisionStrategy.ts:22

    • BLOCK_TWO_TILES

    BLOCK_TWO_TILES: "BLOCK_TWO_TILES"
    @@ -46,7 +46,7 @@

    BLOCK_TWO_TILES

    +
  • Defined in Collisions/CollisionStrategy.ts:16
    • diff --git a/docs/public/api/enums/Direction.html b/docs/public/api/enums/Direction.html index 4bdeb529..54a8721b 100644 --- a/docs/public/api/enums/Direction.html +++ b/docs/public/api/enums/Direction.html @@ -16,7 +16,7 @@
  • Direction

    • Enumeration Direction

    +
  • Defined in Direction/Direction.ts:3
    • @@ -40,47 +40,47 @@

    Enumeration Members

    DOWN

    DOWN: "down"
    +
  • Defined in Direction/Direction.ts:11

    • DOWN_LEFT

    DOWN_LEFT: "down-left"
    +
  • Defined in Direction/Direction.ts:12

    • DOWN_RIGHT

    DOWN_RIGHT: "down-right"
    +
  • Defined in Direction/Direction.ts:10

    • LEFT

    LEFT: "left"
    +
  • Defined in Direction/Direction.ts:5

    • NONE

    NONE: "none"
    +
  • Defined in Direction/Direction.ts:4

    • RIGHT

    RIGHT: "right"
    +
  • Defined in Direction/Direction.ts:9

    • UP

    UP: "up"
    +
  • Defined in Direction/Direction.ts:7

    • UP_LEFT

    UP_LEFT: "up-left"
    +
  • Defined in Direction/Direction.ts:6

    • UP_RIGHT

    UP_RIGHT: "up-right"
    +
  • Defined in Direction/Direction.ts:8
    • diff --git a/docs/public/api/enums/MoveToResult.html b/docs/public/api/enums/MoveToResult.html index be5469c0..8a567dc4 100644 --- a/docs/public/api/enums/MoveToResult.html +++ b/docs/public/api/enums/MoveToResult.html @@ -16,7 +16,7 @@
  • MoveToResult

    • Enumeration MoveToResult

    +
  • Defined in Movement/TargetMovement/TargetMovement.ts:136
    • @@ -39,42 +39,42 @@

    Enumeration Members

    MAX_PATH_LENGTH_REACHED

    MAX_PATH_LENGTH_REACHED: "MAX_PATH_LENGTH_REACHED"
    +
  • Defined in Movement/TargetMovement/TargetMovement.ts:144

    • MOVEMENT_TERMINATED

    MOVEMENT_TERMINATED: "MOVEMENT_TERMINATED"
    +
  • Defined in Movement/TargetMovement/TargetMovement.ts:143

    • NO_PATH_FOUND

    NO_PATH_FOUND: "NO_PATH_FOUND"
    +
  • Defined in Movement/TargetMovement/TargetMovement.ts:141

    • NO_PATH_FOUND_MAX_RETRIES_EXCEEDED

    NO_PATH_FOUND_MAX_RETRIES_EXCEEDED: "NO_PATH_FOUND_MAX_RETRIES_EXCEEDED"
    +
  • Defined in Movement/TargetMovement/TargetMovement.ts:138

    • PATH_BLOCKED

    PATH_BLOCKED: "PATH_BLOCKED"
    +
  • Defined in Movement/TargetMovement/TargetMovement.ts:140

    • PATH_BLOCKED_MAX_RETRIES_EXCEEDED

    PATH_BLOCKED_MAX_RETRIES_EXCEEDED: "PATH_BLOCKED_MAX_RETRIES_EXCEEDED"
    +
  • Defined in Movement/TargetMovement/TargetMovement.ts:139

    • PATH_BLOCKED_WAIT_TIMEOUT

    PATH_BLOCKED_WAIT_TIMEOUT: "PATH_BLOCKED_WAIT_TIMEOUT"
    +
  • Defined in Movement/TargetMovement/TargetMovement.ts:142

    • SUCCESS

    SUCCESS: "SUCCESS"
    +
  • Defined in Movement/TargetMovement/TargetMovement.ts:137
    • diff --git a/docs/public/api/enums/NoPathFoundStrategy.html b/docs/public/api/enums/NoPathFoundStrategy.html index d124702c..4e47120e 100644 --- a/docs/public/api/enums/NoPathFoundStrategy.html +++ b/docs/public/api/enums/NoPathFoundStrategy.html @@ -21,7 +21,7 @@

    Enumeration NoPathFoundStrategy

    +
  • Defined in Pathfinding/NoPathFoundStrategy.ts:7
    • @@ -43,7 +43,7 @@

    CLOSEST_REACHABLE

    +
  • Defined in Pathfinding/NoPathFoundStrategy.ts:17

    • RETRY

    RETRY: "RETRY"
    @@ -55,7 +55,7 @@

    RETRY

    +
  • Defined in Pathfinding/NoPathFoundStrategy.ts:26

    • STOP

    STOP: "STOP"
    @@ -63,7 +63,7 @@

    STOP

    +
  • Defined in Pathfinding/NoPathFoundStrategy.ts:11
    • diff --git a/docs/public/api/enums/NumberOfDirections.html b/docs/public/api/enums/NumberOfDirections.html index 53f8af4c..622da5aa 100644 --- a/docs/public/api/enums/NumberOfDirections.html +++ b/docs/public/api/enums/NumberOfDirections.html @@ -16,7 +16,7 @@
  • NumberOfDirections

    • Enumeration NumberOfDirections

    +
  • Defined in Direction/Direction.ts:140
    • @@ -33,12 +33,12 @@

    Enumeration Members

    EIGHT

    EIGHT: 8
    +
  • Defined in Direction/Direction.ts:142

    • FOUR

    FOUR: 4
    +
  • Defined in Direction/Direction.ts:141
    • diff --git a/docs/public/api/enums/PathBlockedStrategy.html b/docs/public/api/enums/PathBlockedStrategy.html index af9e3638..9887f9fe 100644 --- a/docs/public/api/enums/PathBlockedStrategy.html +++ b/docs/public/api/enums/PathBlockedStrategy.html @@ -22,7 +22,7 @@

    Enumeration PathBlockedStrategy

    +
  • Defined in Pathfinding/PathBlockedStrategy.ts:8
    • @@ -45,7 +45,7 @@

    RETRY

    +
  • Defined in Pathfinding/PathBlockedStrategy.ts:20

    • STOP

    STOP: "STOP"
    @@ -53,7 +53,7 @@

    STOP

    +
  • Defined in Pathfinding/PathBlockedStrategy.ts:25

    • WAIT

    WAIT: "WAIT"
    @@ -62,7 +62,7 @@

    WAIT

    +
  • Defined in Pathfinding/PathBlockedStrategy.ts:13
    • diff --git a/docs/public/api/enums/QueuedPathBlockedStrategy.html b/docs/public/api/enums/QueuedPathBlockedStrategy.html index 941772d0..790bb49f 100644 --- a/docs/public/api/enums/QueuedPathBlockedStrategy.html +++ b/docs/public/api/enums/QueuedPathBlockedStrategy.html @@ -20,7 +20,7 @@

    Enumeration QueuedPathBlockedStrategy

    +
  • Defined in Movement/QueueMovement/QueueMovement.ts:73
    • @@ -42,7 +42,7 @@

    SKIP

    +
  • Defined in Movement/QueueMovement/QueueMovement.ts:85

    • STOP

    STOP: "STOP"
    @@ -50,7 +50,7 @@

    STOP

    +
  • Defined in Movement/QueueMovement/QueueMovement.ts:90

    • WAIT

    WAIT: "WAIT"
    @@ -60,7 +60,7 @@

    WAIT

    +
  • Defined in Movement/QueueMovement/QueueMovement.ts:79
    • diff --git a/docs/public/api/functions/directionFromPos.html b/docs/public/api/functions/directionFromPos.html index 9241421a..a4898c6d 100644 --- a/docs/public/api/functions/directionFromPos.html +++ b/docs/public/api/functions/directionFromPos.html @@ -34,7 +34,7 @@
    dest: Returns Direction
    +
  • Defined in Direction/Direction.ts:123
    • diff --git a/docs/public/api/interfaces/ArrayTilemapInputLayer.html b/docs/public/api/interfaces/ArrayTilemapInputLayer.html index 95ba73e3..a0670842 100644 --- a/docs/public/api/interfaces/ArrayTilemapInputLayer.html +++ b/docs/public/api/interfaces/ArrayTilemapInputLayer.html @@ -24,7 +24,7 @@

    Hierarchy

    • ArrayTilemapInputLayer
    +
  • Defined in GridTilemap/ArrayTilemap/ArrayTilemap.ts:6
    • @@ -46,12 +46,12 @@

    data

    +
  • Defined in GridTilemap/ArrayTilemap/ArrayTilemap.ts:12

    • Optional isCharLayer

    isCharLayer?: boolean
    +
  • Defined in GridTilemap/ArrayTilemap/ArrayTilemap.ts:13
    • diff --git a/docs/public/api/interfaces/CharacterData.html b/docs/public/api/interfaces/CharacterData.html index a84de2b8..2794606f 100644 --- a/docs/public/api/interfaces/CharacterData.html +++ b/docs/public/api/interfaces/CharacterData.html @@ -26,7 +26,7 @@

    Hierarchy

    • CharacterData
    +
  • Defined in GridEngine.ts:182
    • @@ -64,7 +64,7 @@

    Optional

    +
  • Defined in GridEngineHeadless.ts:239

    • Optional collides

    collides?: boolean | CollisionConfig
    @@ -77,7 +77,7 @@

    Default Value

    true

    +
  • Defined in GridEngineHeadless.ts:228

    • Optional container

    container?: Container
    @@ -93,7 +93,7 @@

    Optional

    +
  • Defined in GridEngine.ts:215

    • Optional facingDirection

    facingDirection?: Direction
    @@ -104,7 +104,7 @@

    Default Value

    Inherited from CharacterDataHeadless.facingDirection

    +
  • Defined in GridEngineHeadless.ts:219

    • id

    id: string
    @@ -114,7 +114,7 @@

    id

    +
  • Defined in GridEngineHeadless.ts:198

    • Optional labels

    labels?: string[]
    @@ -126,7 +126,7 @@

    Default Value

    []

    +
  • Defined in GridEngineHeadless.ts:247

    • Optional numberOfDirections

    numberOfDirections?: NumberOfDirections
    @@ -137,7 +137,7 @@

    Optional

    +
  • Defined in GridEngineHeadless.ts:254

    • Optional offsetX

    offsetX?: number
    @@ -147,7 +147,7 @@

    OptionalDefault Value

    0

    +
  • Defined in GridEngine.ts:222

    • Optional offsetY

    offsetY?: number
    @@ -157,7 +157,7 @@

    OptionalDefault Value

    0

    +
  • Defined in GridEngine.ts:229

    • Optional speed

    speed?: number
    @@ -168,7 +168,7 @@

    Default Value

    4

    +
  • Defined in GridEngineHeadless.ts:205

    • Optional sprite

    sprite?: Sprite
    @@ -176,7 +176,7 @@

    Optional

    +
  • Defined in GridEngine.ts:184

    • Optional startPosition

    startPosition?: Position
    @@ -187,7 +187,7 @@

    Default Value

    {x: 0, y:0}

    +
  • Defined in GridEngineHeadless.ts:212

    • Optional tileHeight

    tileHeight?: number
    @@ -199,7 +199,7 @@

    Default Value

    1

    +
  • Defined in GridEngineHeadless.ts:270

    • Optional tileWidth

    tileWidth?: number
    @@ -211,7 +211,7 @@

    Default Value

    1

    +
  • Defined in GridEngineHeadless.ts:262

    • Optional walkingAnimationMapping

    walkingAnimationMapping?: number | WalkingAnimationMapping
    @@ -229,7 +229,7 @@

    Optional

    +
  • Defined in GridEngine.ts:200
    • diff --git a/docs/public/api/interfaces/CharacterDataHeadless.html b/docs/public/api/interfaces/CharacterDataHeadless.html index afd910d4..2425f31b 100644 --- a/docs/public/api/interfaces/CharacterDataHeadless.html +++ b/docs/public/api/interfaces/CharacterDataHeadless.html @@ -26,7 +26,7 @@

    Hierarchy

    +
  • Defined in GridEngineHeadless.ts:193
    • @@ -58,7 +58,7 @@

    Optional

    +
  • Defined in GridEngineHeadless.ts:239

    • Optional collides

    collides?: boolean | CollisionConfig
    @@ -70,7 +70,7 @@

    OptionalDefault Value

    true

    +
  • Defined in GridEngineHeadless.ts:228

    • Optional facingDirection

    facingDirection?: Direction
    @@ -80,7 +80,7 @@

    OptionalDefault Value

    DOWN

    +
  • Defined in GridEngineHeadless.ts:219

    • id

    id: string
    @@ -89,7 +89,7 @@

    id

    +
  • Defined in GridEngineHeadless.ts:198

    • Optional labels

    labels?: string[]
    @@ -100,7 +100,7 @@

    OptionalDefault Value

    []

    +
  • Defined in GridEngineHeadless.ts:247

    • Optional numberOfDirections

    numberOfDirections?: NumberOfDirections
    @@ -110,7 +110,7 @@

    Optional

    +
  • Defined in GridEngineHeadless.ts:254

    • Optional speed

    speed?: number
    @@ -120,7 +120,7 @@

    OptionalDefault Value

    4

    +
  • Defined in GridEngineHeadless.ts:205

    • Optional startPosition

    startPosition?: Position
    @@ -130,7 +130,7 @@

    OptionalDefault Value

    {x: 0, y:0}

    +
  • Defined in GridEngineHeadless.ts:212

    • Optional tileHeight

    tileHeight?: number
    @@ -141,7 +141,7 @@

    OptionalDefault Value

    1

    +
  • Defined in GridEngineHeadless.ts:270

    • Optional tileWidth

    tileWidth?: number
    @@ -152,7 +152,7 @@

    OptionalDefault Value

    1

    +
  • Defined in GridEngineHeadless.ts:262
    • diff --git a/docs/public/api/interfaces/CharacterFilteringOptions.html b/docs/public/api/interfaces/CharacterFilteringOptions.html index e798e8bd..5f2cd933 100644 --- a/docs/public/api/interfaces/CharacterFilteringOptions.html +++ b/docs/public/api/interfaces/CharacterFilteringOptions.html @@ -24,7 +24,7 @@

    Hierarchy

    • CharacterFilteringOptions
    +
  • Defined in GridCharacter/CharacterFilter/CharacterFilter.ts:6
    • @@ -85,7 +85,7 @@
    Optional
    +
  • Defined in GridCharacter/CharacterFilter/CharacterFilter.ts:7
    • diff --git a/docs/public/api/interfaces/CharacterShift.html b/docs/public/api/interfaces/CharacterShift.html index eaecb36a..c0d6571c 100644 --- a/docs/public/api/interfaces/CharacterShift.html +++ b/docs/public/api/interfaces/CharacterShift.html @@ -24,7 +24,7 @@

    Hierarchy

    • CharacterShift
    +
  • Defined in IGridEngine.ts:116
    • @@ -44,7 +44,7 @@

    action

    +
  • Defined in IGridEngine.ts:120

    • charId

    charId: string
    @@ -52,7 +52,7 @@

    charId

    +
  • Defined in IGridEngine.ts:118
    • diff --git a/docs/public/api/interfaces/CollisionConfig.html b/docs/public/api/interfaces/CollisionConfig.html index b13ef0d8..db2f4560 100644 --- a/docs/public/api/interfaces/CollisionConfig.html +++ b/docs/public/api/interfaces/CollisionConfig.html @@ -20,7 +20,7 @@

    Hierarchy

    • CollisionConfig
    +
  • Defined in GridEngineHeadless.ts:148
    • @@ -44,7 +44,7 @@

    OptionalDefault Value

    true

    +
  • Defined in GridEngineHeadless.ts:154

    • Optional collisionGroups

    collisionGroups?: string[]
    @@ -58,7 +58,7 @@

    OptionalDefault Value

    ['geDefault']

    +
  • Defined in GridEngineHeadless.ts:174

    • Optional ignoreCollisionGroups

    ignoreCollisionGroups?: string[]
    @@ -72,7 +72,7 @@

    OptionalDefault Value

    []

    +
  • Defined in GridEngineHeadless.ts:185

    • Optional ignoreMissingTiles

    ignoreMissingTiles?: boolean
    @@ -84,7 +84,7 @@

    OptionalDefault Value

    false

    +
  • Defined in GridEngineHeadless.ts:163
    • diff --git a/docs/public/api/interfaces/Finished.html b/docs/public/api/interfaces/Finished.html index 65ec7fc4..4618e436 100644 --- a/docs/public/api/interfaces/Finished.html +++ b/docs/public/api/interfaces/Finished.html @@ -20,7 +20,7 @@

    Hierarchy

    • Finished
    +
  • Defined in Movement/TargetMovement/TargetMovement.ts:150
    • @@ -39,22 +39,22 @@

    Properties

    Optional description

    description?: string
    +
  • Defined in Movement/TargetMovement/TargetMovement.ts:153

    • layer

    layer: CharLayer
    +
  • Defined in Movement/TargetMovement/TargetMovement.ts:154

    • position

    position: Position
    +
  • Defined in Movement/TargetMovement/TargetMovement.ts:151

    • Optional result

    result?: MoveToResult
    +
  • Defined in Movement/TargetMovement/TargetMovement.ts:152
    • diff --git a/docs/public/api/interfaces/FollowOptions.html b/docs/public/api/interfaces/FollowOptions.html index 77a2b635..e83082be 100644 --- a/docs/public/api/interfaces/FollowOptions.html +++ b/docs/public/api/interfaces/FollowOptions.html @@ -20,7 +20,7 @@

    Hierarchy

    • FollowOptions
    +
  • Defined in IGridEngine.ts:70
    • @@ -43,7 +43,7 @@

    Optional

    +
  • Defined in IGridEngine.ts:101

    • Optional closestPointIfBlocked

    closestPointIfBlocked?: boolean
    @@ -57,7 +57,7 @@

    Optional

    +
  • Defined in IGridEngine.ts:89

    • Optional distance

    distance?: number
    @@ -69,7 +69,7 @@

    Optional

    +
  • Defined in IGridEngine.ts:78

    • Optional ignoreLayers

    ignoreLayers?: boolean
    @@ -82,7 +82,7 @@

    Default

    false
    +
  • Defined in IGridEngine.ts:110

    • Optional maxPathLength

    maxPathLength?: number
    @@ -92,7 +92,7 @@

    Optional

    +
  • Defined in IGridEngine.ts:96
    • diff --git a/docs/public/api/interfaces/FrameRow.html b/docs/public/api/interfaces/FrameRow.html index ab97e925..2c4e1507 100644 --- a/docs/public/api/interfaces/FrameRow.html +++ b/docs/public/api/interfaces/FrameRow.html @@ -24,7 +24,7 @@

    Hierarchy

    • FrameRow
    +
  • Defined in GridCharacter/CharacterAnimation/CharacterAnimation.ts:8
    • @@ -45,7 +45,7 @@

    leftFoot

    +
  • Defined in GridCharacter/CharacterAnimation/CharacterAnimation.ts:10

    • rightFoot

    rightFoot: number
    @@ -53,7 +53,7 @@

    rightFoot

    +
  • Defined in GridCharacter/CharacterAnimation/CharacterAnimation.ts:16

    • standing

    standing: number
    @@ -61,7 +61,7 @@

    standing

    +
  • Defined in GridCharacter/CharacterAnimation/CharacterAnimation.ts:13
    • diff --git a/docs/public/api/interfaces/GridCharacterState.html b/docs/public/api/interfaces/GridCharacterState.html index f152d1e4..095b963d 100644 --- a/docs/public/api/interfaces/GridCharacterState.html +++ b/docs/public/api/interfaces/GridCharacterState.html @@ -20,7 +20,7 @@

    Hierarchy

    • GridCharacterState
    +
  • Defined in GridCharacter/GridCharacterState.ts:6
    • @@ -42,37 +42,37 @@

    Properties

    collisionConfig

    collisionConfig: CollisionConfig
    +
  • Defined in GridCharacter/GridCharacterState.ts:12

    • facingDirection

    facingDirection: Direction
    +
  • Defined in GridCharacter/GridCharacterState.ts:9

    • id

    id: string
    +
  • Defined in GridCharacter/GridCharacterState.ts:7

    • labels

    labels: string[]
    +
  • Defined in GridCharacter/GridCharacterState.ts:13

    • movementProgress

    movementProgress: number
    +
  • Defined in GridCharacter/GridCharacterState.ts:11

    • position

    position: LayerPosition
    +
  • Defined in GridCharacter/GridCharacterState.ts:8

    • speed

    speed: number
    +
  • Defined in GridCharacter/GridCharacterState.ts:10
    • diff --git a/docs/public/api/interfaces/GridEngineConfig.html b/docs/public/api/interfaces/GridEngineConfig.html index c93852c8..0e985aaa 100644 --- a/docs/public/api/interfaces/GridEngineConfig.html +++ b/docs/public/api/interfaces/GridEngineConfig.html @@ -26,7 +26,7 @@

    Hierarchy

    • GridEngineConfig
    +
  • Defined in GridEngine.ts:137
    • @@ -60,7 +60,7 @@

    Default Value

    false

    +
  • Defined in GridEngineHeadless.ts:127

    • Optional characterCollisionStrategy

    characterCollisionStrategy?: CollisionStrategy
    @@ -71,7 +71,7 @@

    Default Value

    Inherited from GridEngineConfigHeadless.characterCollisionStrategy

    +
  • Defined in GridEngineHeadless.ts:115

    • characters

    characters: CharacterData[]
    @@ -80,7 +80,7 @@

    characters

    +
  • Defined in GridEngine.ts:139

    • Optional collisionGroupRelation

    collisionGroupRelation?: Record<string, string[]>
    @@ -97,7 +97,7 @@

    Optional

    +
  • Defined in GridEngineHeadless.ts:142

    • Optional collisionTilePropertyName

    collisionTilePropertyName?: string
    @@ -110,7 +110,7 @@

    Default Value

    'ge_collide'

    +
  • Defined in GridEngineHeadless.ts:99

    • Optional Beta layerOverlay

    layerOverlay?: boolean
    @@ -121,7 +121,7 @@

    OptionalDefault Value

    false

    +
  • Defined in GridEngine.ts:149

    • Optional numberOfDirections

    numberOfDirections?: NumberOfDirections
    @@ -134,7 +134,7 @@

    Default Value

    Inherited from GridEngineConfigHeadless.numberOfDirections

    +
  • Defined in GridEngineHeadless.ts:108

    • Optional tiledProject

    tiledProject?: TiledProject
    @@ -143,7 +143,7 @@

    Optional

    +
  • Defined in GridEngine.ts:155
    • diff --git a/docs/public/api/interfaces/GridEngineConfigHeadless.html b/docs/public/api/interfaces/GridEngineConfigHeadless.html index 1cb4d327..1bef03cb 100644 --- a/docs/public/api/interfaces/GridEngineConfigHeadless.html +++ b/docs/public/api/interfaces/GridEngineConfigHeadless.html @@ -26,7 +26,7 @@

    Hierarchy

    +
  • Defined in GridEngineHeadless.ts:88
    • @@ -57,7 +57,7 @@

    OptionalDefault Value

    false

    +
  • Defined in GridEngineHeadless.ts:127

    • Optional characterCollisionStrategy

    characterCollisionStrategy?: CollisionStrategy
    @@ -67,7 +67,7 @@

    OptionalDefault Value

    BLOCK_TWO_TILES

    +
  • Defined in GridEngineHeadless.ts:115

    • characters

    characters: CharacterDataHeadless[]
    @@ -75,7 +75,7 @@

    characters

    +
  • Defined in GridEngineHeadless.ts:90

    • Optional collisionGroupRelation

    collisionGroupRelation?: Record<string, string[]>
    @@ -91,7 +91,7 @@

    Optional

    +
  • Defined in GridEngineHeadless.ts:142

    • Optional collisionTilePropertyName

    collisionTilePropertyName?: string
    @@ -103,7 +103,7 @@

    OptionalDefault Value

    'ge_collide'

    +
  • Defined in GridEngineHeadless.ts:99

    • Optional numberOfDirections

    numberOfDirections?: NumberOfDirections
    @@ -115,7 +115,7 @@

    OptionalDefault Value

    FOUR

    +
  • Defined in GridEngineHeadless.ts:108
    • diff --git a/docs/public/api/interfaces/GridEngineState.html b/docs/public/api/interfaces/GridEngineState.html index ead116ae..4b268d4b 100644 --- a/docs/public/api/interfaces/GridEngineState.html +++ b/docs/public/api/interfaces/GridEngineState.html @@ -20,7 +20,7 @@

    Hierarchy

    • GridEngineState
    +
  • Defined in GridEngineState.ts:3
    • @@ -36,7 +36,7 @@

    Properties

    characters

    characters: GridCharacterState[]
    +
  • Defined in GridEngineState.ts:4
    • diff --git a/docs/public/api/interfaces/IGridEngine.html b/docs/public/api/interfaces/IGridEngine.html index 824791d4..4a8963ef 100644 --- a/docs/public/api/interfaces/IGridEngine.html +++ b/docs/public/api/interfaces/IGridEngine.html @@ -25,7 +25,7 @@

    Implemented by

  • GridEngine
  • GridEngineHeadless
    • +
  • Defined in IGridEngine.ts:133
    • @@ -130,7 +130,7 @@
    direction: Returns void
    +
  • Defined in IGridEngine.ts:183

    • steppedOn

    +
  • Defined in IGridEngine.ts:516

    • turnTowards

    +
  • Defined in IGridEngine.ts:396

    • Character

    @@ -188,7 +188,7 @@
    labels: Returns void
    +
  • Defined in IGridEngine.ts:309

    • clearLabels

    +
  • Defined in IGridEngine.ts:323

    • collidesWithTiles

      @@ -221,7 +221,7 @@

      Returns boolean

    +
  • Defined in IGridEngine.ts:259

    • directionChanged

    +
  • Defined in IGridEngine.ts:563

    • getCharLayer

    +
  • Defined in IGridEngine.ts:141

    • getCollisionGroups

      @@ -275,7 +275,7 @@

      Returns string

    +
  • Defined in IGridEngine.ts:451

    • getFacingDirection

      @@ -291,7 +291,7 @@

      Returns

    +
  • Defined in IGridEngine.ts:382

    • getFacingPosition

    +
  • Defined in IGridEngine.ts:389

    • getIgnoreCollisionGroups

    +
  • Defined in IGridEngine.ts:477

    • getLabels

    +
  • Defined in IGridEngine.ts:302

    • getMovement

    +
  • Defined in IGridEngine.ts:211

    • getMovementProgress

    +
  • Defined in IGridEngine.ts:588

    • getPosition

    +
  • Defined in IGridEngine.ts:174

    • getSpeed

    +
  • Defined in IGridEngine.ts:250

    • movementStarted

    +
  • Defined in IGridEngine.ts:539

    • movementStopped

    +
  • Defined in IGridEngine.ts:547

    • positionChangeFinished

    +
  • Defined in IGridEngine.ts:579

    • positionChangeStarted

    +
  • Defined in IGridEngine.ts:571

    • removeLabels

    +
  • Defined in IGridEngine.ts:316

    • setCollisionGroups

    +
  • Defined in IGridEngine.ts:459

    • setIgnoreCollisionGroups

    +
  • Defined in IGridEngine.ts:467

    • setPosition

    +
  • Defined in IGridEngine.ts:415

    • setSpeed

    +
  • Defined in IGridEngine.ts:243

    • stopMovement

    +
  • Defined in IGridEngine.ts:236

    • Chatacter State

    @@ -578,7 +578,7 @@

    Returns boolean

    +
  • Defined in IGridEngine.ts:375

    • Grid Engine

    @@ -590,7 +590,7 @@

    Returns Observab

    +
  • Defined in IGridEngine.ts:531

    • hasCharacter

    +
  • Defined in IGridEngine.ts:271

    • rebuildTileCollisionCache

    +
  • Defined in IGridEngine.ts:600

    • removeAllCharacters

    +
  • Defined in IGridEngine.ts:289

    • removeCharacter

    +
  • Defined in IGridEngine.ts:280

    • update

    +
  • Defined in IGridEngine.ts:264

    • Other

    @@ -697,7 +697,7 @@

    Returns string

    +
  • Defined in IGridEngine.ts:295

    • Pathfinding

    @@ -730,7 +730,7 @@

    Returns

    +
  • Defined in IGridEngine.ts:504

    • follow

  • @@ -801,7 +801,7 @@

    Deprecated

    Use follow(charId: string, charIdToFollow: string, options shortest path until it reaches the specified distance.

    • +
  • Defined in IGridEngine.ts:358
  • @@ -817,7 +817,7 @@
    Optional Optional closestPointIfBlocked: boolean

    • Returns void

    +
  • Defined in IGridEngine.ts:364

    • getTileCost

    +
  • Defined in IGridEngine.ts:654

    • moveTo

    +
  • Defined in IGridEngine.ts:224

    • Queue Movement

    @@ -895,7 +895,7 @@
    Optional Returns any
    +
  • Defined in IGridEngine.ts:617

    • clearEnqueuedMovements

    +
  • Defined in IGridEngine.ts:636

    • getEnqueuedMovements

    +
  • Defined in IGridEngine.ts:628

    • queueMovementFinished

    +
  • Defined in IGridEngine.ts:644

    • Random Movement

    @@ -975,7 +975,7 @@
    radius: Returns void
    +
  • Defined in IGridEngine.ts:203

    • Tilemap

    @@ -996,7 +996,7 @@

    Returns string

    +
  • Defined in IGridEngine.ts:404

    • getTilePosInDirection

    +
  • Defined in IGridEngine.ts:485

    • getTransition

    +
  • Defined in IGridEngine.ts:151

    • isBlocked

    +
  • Defined in IGridEngine.ts:427

    • isTileBlocked

    +
  • Defined in IGridEngine.ts:441

    • setTransition

    +
  • Defined in IGridEngine.ts:167
    • diff --git a/docs/public/api/interfaces/LayerPosition.html b/docs/public/api/interfaces/LayerPosition.html index 603c16d4..08ee053d 100644 --- a/docs/public/api/interfaces/LayerPosition.html +++ b/docs/public/api/interfaces/LayerPosition.html @@ -24,7 +24,7 @@

    Hierarchy

    • LayerPosition
    +
  • Defined in IGridEngine.ts:23
    • @@ -41,12 +41,12 @@

    Properties

    charLayer

    charLayer: CharLayer
    +
  • Defined in IGridEngine.ts:25

    • position

    position: Position
    +
  • Defined in IGridEngine.ts:24
    • diff --git a/docs/public/api/interfaces/MoveToConfig.html b/docs/public/api/interfaces/MoveToConfig.html index 64030f04..0e53347c 100644 --- a/docs/public/api/interfaces/MoveToConfig.html +++ b/docs/public/api/interfaces/MoveToConfig.html @@ -20,7 +20,7 @@

    Hierarchy

    • MoveToConfig
    +
  • Defined in Movement/TargetMovement/TargetMovement.ts:30
    • @@ -51,7 +51,7 @@

    Optional

    +
  • Defined in Movement/TargetMovement/TargetMovement.ts:105

    • Optional considerCosts

    considerCosts?: boolean
    @@ -64,7 +64,7 @@

    Default

    false
    +
  • Defined in Movement/TargetMovement/TargetMovement.ts:130

    • Optional ignoreLayers

    ignoreLayers?: boolean
    @@ -77,7 +77,7 @@

    Default

    false
    +
  • Defined in Movement/TargetMovement/TargetMovement.ts:121

    • Optional isPositionAllowedFn

    isPositionAllowedFn?: IsPositionAllowedFn
    @@ -90,7 +90,7 @@

    Optional

    +
  • Defined in Movement/TargetMovement/TargetMovement.ts:100

    • Optional maxPathLength

    maxPathLength?: number
    @@ -100,7 +100,7 @@

    Optional

    +
  • Defined in Movement/TargetMovement/TargetMovement.ts:112

    • Optional noPathFoundMaxRetries

    noPathFoundMaxRetries?: number
    @@ -109,7 +109,7 @@

    Optional

    +
  • Defined in Movement/TargetMovement/TargetMovement.ts:59

    • Optional noPathFoundRetryBackoffMs

    noPathFoundRetryBackoffMs?: number
    @@ -119,7 +119,7 @@

    Optional

    +
  • Defined in Movement/TargetMovement/TargetMovement.ts:52

    • Optional noPathFoundStrategy

    noPathFoundStrategy?: NoPathFoundStrategy
    @@ -128,7 +128,7 @@

    Optional

    +
  • Defined in Movement/TargetMovement/TargetMovement.ts:35

    • Optional pathBlockedMaxRetries

    pathBlockedMaxRetries?: number
    @@ -137,7 +137,7 @@

    Optional

    +
  • Defined in Movement/TargetMovement/TargetMovement.ts:66

    • Optional pathBlockedRetryBackoffMs

    pathBlockedRetryBackoffMs?: number
    @@ -147,7 +147,7 @@

    Optional

    +
  • Defined in Movement/TargetMovement/TargetMovement.ts:74

    • Optional pathBlockedStrategy

    pathBlockedStrategy?: PathBlockedStrategy
    @@ -158,7 +158,7 @@

    Optional

    +
  • Defined in Movement/TargetMovement/TargetMovement.ts:44

    • Optional pathBlockedWaitTimeoutMs

    pathBlockedWaitTimeoutMs?: number
    @@ -168,7 +168,7 @@

    Optional

    +
  • Defined in Movement/TargetMovement/TargetMovement.ts:82

    • Optional targetLayer

    targetLayer?: string
    @@ -177,7 +177,7 @@

    Optional

    +
  • Defined in Movement/TargetMovement/TargetMovement.ts:88
    • diff --git a/docs/public/api/interfaces/MoveToInfo.html b/docs/public/api/interfaces/MoveToInfo.html index 440d374d..7bd0860a 100644 --- a/docs/public/api/interfaces/MoveToInfo.html +++ b/docs/public/api/interfaces/MoveToInfo.html @@ -26,7 +26,7 @@

    Hierarchy

    • MoveToInfo
    +
  • Defined in Movement/TargetMovement/TargetMovement.ts:163
    • @@ -68,7 +68,7 @@
    targetPos
    +
  • Defined in Movement/TargetMovement/TargetMovement.ts:167

    • state

    state: {
        pathAhead: LayerPosition[];
    }
    @@ -83,7 +83,7 @@
    pathAhead
    +
  • Defined in Movement/TargetMovement/TargetMovement.ts:164

    • type

    type: string
    @@ -92,7 +92,7 @@

    type

    +
  • Defined in Movement/Movement.ts:9
    • diff --git a/docs/public/api/interfaces/MovementInfo.html b/docs/public/api/interfaces/MovementInfo.html index 4af687aa..8ff18396 100644 --- a/docs/public/api/interfaces/MovementInfo.html +++ b/docs/public/api/interfaces/MovementInfo.html @@ -26,7 +26,7 @@

    Hierarchy

    +
  • Defined in Movement/Movement.ts:7
    • @@ -48,7 +48,7 @@

    Optional

    +
  • Defined in Movement/Movement.ts:14

    • Optional state

    state?: Record<string, any>
    @@ -57,7 +57,7 @@

    Optional

    +
  • Defined in Movement/Movement.ts:19

    • type

    type: string
    @@ -65,7 +65,7 @@

    type

    +
  • Defined in Movement/Movement.ts:9
    • diff --git a/docs/public/api/interfaces/PathfindingOptions.html b/docs/public/api/interfaces/PathfindingOptions.html index fd30235a..446cf64d 100644 --- a/docs/public/api/interfaces/PathfindingOptions.html +++ b/docs/public/api/interfaces/PathfindingOptions.html @@ -24,7 +24,7 @@

    Hierarchy

    • PathfindingOptions
    +
  • Defined in Pathfinding/Pathfinding.ts:22
    • @@ -63,7 +63,7 @@

    Default

    true
    +
  • Defined in Pathfinding/Pathfinding.ts:118

    • Optional collisionGroups

    collisionGroups?: string[]
    @@ -71,7 +71,7 @@

    Optional

    +
  • Defined in Pathfinding/Pathfinding.ts:58

    • Optional considerCosts

    considerCosts?: boolean
    @@ -84,7 +84,7 @@

    Default

    false
    +
  • Defined in Pathfinding/Pathfinding.ts:107

    • Optional ignoreBlockedTarget

    ignoreBlockedTarget?: boolean
    @@ -94,7 +94,7 @@

    Optional

    +
  • Defined in Pathfinding/Pathfinding.ts:82

    • Optional ignoreLayers

    ignoreLayers?: boolean
    @@ -107,7 +107,7 @@

    Default

    false
    +
  • Defined in Pathfinding/Pathfinding.ts:98

    • Optional ignoreMapBounds

    ignoreMapBounds?: boolean
    @@ -117,7 +117,7 @@

    Optional

    +
  • Defined in Pathfinding/Pathfinding.ts:75

    • Optional ignoreTiles

    ignoreTiles?: boolean
    @@ -125,7 +125,7 @@

    Optional

    +
  • Defined in Pathfinding/Pathfinding.ts:68

    • Optional ignoredChars

    ignoredChars?: string[]
    @@ -133,7 +133,7 @@

    Optional

    +
  • Defined in Pathfinding/Pathfinding.ts:63

    • Optional isPositionAllowed

    isPositionAllowed?: IsPositionAllowedFn
    @@ -146,7 +146,7 @@

    Optional

    +
  • Defined in Pathfinding/Pathfinding.ts:53

    • Optional maxPathLength

    maxPathLength?: number
    @@ -156,7 +156,7 @@

    Optional

    +
  • Defined in Pathfinding/Pathfinding.ts:89

    • Optional numberOfDirections

    numberOfDirections?: NumberOfDirections
    @@ -164,7 +164,7 @@

    Optional

    +
  • Defined in Pathfinding/Pathfinding.ts:41

    • Optional pathHeight

    pathHeight?: number
    @@ -173,7 +173,7 @@

    Optional

    +
  • Defined in Pathfinding/Pathfinding.ts:36

    • Optional pathWidth

    pathWidth?: number
    @@ -182,7 +182,7 @@

    Optional

    +
  • Defined in Pathfinding/Pathfinding.ts:31

    • Optional shortestPathAlgorithm

    shortestPathAlgorithm?: ShortestPathAlgorithmType
    @@ -190,7 +190,7 @@

    Optional

    +
  • Defined in Pathfinding/Pathfinding.ts:24
    • diff --git a/docs/public/api/interfaces/PathfindingResult.html b/docs/public/api/interfaces/PathfindingResult.html index 021abd88..007c4a5b 100644 --- a/docs/public/api/interfaces/PathfindingResult.html +++ b/docs/public/api/interfaces/PathfindingResult.html @@ -24,7 +24,7 @@

    Hierarchy

    • PathfindingResult
    +
  • Defined in IGridEngine.ts:38
    • @@ -54,7 +54,7 @@

    Optional

    +
  • Defined in IGridEngine.ts:57

    • path

    path: LayerPosition[]
    @@ -63,7 +63,7 @@

    path

    +
  • Defined in IGridEngine.ts:44

    • reachedMaxPathLength

    reachedMaxPathLength: boolean
    @@ -73,12 +73,12 @@

    reachedMaxPathLength<

    +
  • Defined in IGridEngine.ts:64

    • steps

    steps: number
    +
  • Defined in IGridEngine.ts:39
    • diff --git a/docs/public/api/interfaces/Position.html b/docs/public/api/interfaces/Position.html index b35395cf..b28ac4bf 100644 --- a/docs/public/api/interfaces/Position.html +++ b/docs/public/api/interfaces/Position.html @@ -20,7 +20,7 @@

    Hierarchy

    • Position
    +
  • Defined in IGridEngine.ts:28
    • @@ -37,12 +37,12 @@

    Properties

    x

    x: number
    +
  • Defined in IGridEngine.ts:29

    • y

    y: number
    +
  • Defined in IGridEngine.ts:30
    • diff --git a/docs/public/api/interfaces/PositionChange.html b/docs/public/api/interfaces/PositionChange.html index e42039a5..0b2aa83f 100644 --- a/docs/public/api/interfaces/PositionChange.html +++ b/docs/public/api/interfaces/PositionChange.html @@ -20,7 +20,7 @@

    Hierarchy

    • PositionChange
    +
  • Defined in GridCharacter/GridCharacter.ts:24
    • @@ -39,22 +39,22 @@

    Properties

    enterLayer

    enterLayer: CharLayer
    +
  • Defined in GridCharacter/GridCharacter.ts:28

    • enterTile

    enterTile: Position
    +
  • Defined in GridCharacter/GridCharacter.ts:26

    • exitLayer

    exitLayer: CharLayer
    +
  • Defined in GridCharacter/GridCharacter.ts:27

    • exitTile

    exitTile: Position
    +
  • Defined in GridCharacter/GridCharacter.ts:25
    • diff --git a/docs/public/api/interfaces/QueueMovementConfig.html b/docs/public/api/interfaces/QueueMovementConfig.html index c6aa5f69..fa6684b7 100644 --- a/docs/public/api/interfaces/QueueMovementConfig.html +++ b/docs/public/api/interfaces/QueueMovementConfig.html @@ -20,7 +20,7 @@

    Hierarchy

    • QueueMovementConfig
    +
  • Defined in Movement/QueueMovement/QueueMovement.ts:22
    • @@ -49,7 +49,7 @@

    OptionalDefault

    false

    +
  • Defined in Movement/QueueMovement/QueueMovement.ts:51

    • Optional pathBlockedStrategy

    pathBlockedStrategy?: QueuedPathBlockedStrategy
    @@ -61,7 +61,7 @@

    Default

    QueuePathBlock
    +
  • Defined in Movement/QueueMovement/QueueMovement.ts:28

    • Optional pathBlockedWaitTimeoutMs

    pathBlockedWaitTimeoutMs?: number
    @@ -74,7 +74,7 @@

    OptionalDefault

    -1

    +
  • Defined in Movement/QueueMovement/QueueMovement.ts:39

    • Optional skipInvalidPositions

    skipInvalidPositions?: boolean
    @@ -90,7 +90,7 @@

    OptionalDefault

    false

    +
  • Defined in Movement/QueueMovement/QueueMovement.ts:65
    • diff --git a/docs/public/api/interfaces/QueueMovementEntry.html b/docs/public/api/interfaces/QueueMovementEntry.html index 38daf7b7..cc554f1a 100644 --- a/docs/public/api/interfaces/QueueMovementEntry.html +++ b/docs/public/api/interfaces/QueueMovementEntry.html @@ -20,7 +20,7 @@

    Hierarchy

    • QueueMovementEntry
    +
  • Defined in Movement/QueueMovement/QueueMovement.ts:121
    • @@ -37,12 +37,12 @@

    Properties

    command

    command: Direction | LayerPosition
    +
  • Defined in Movement/QueueMovement/QueueMovement.ts:122

    • config

    config: Concrete<QueueMovementConfig>
    +
  • Defined in Movement/QueueMovement/QueueMovement.ts:123
    • diff --git a/docs/public/api/interfaces/QueueMovementFinished.html b/docs/public/api/interfaces/QueueMovementFinished.html index 4a809f22..2b885bf8 100644 --- a/docs/public/api/interfaces/QueueMovementFinished.html +++ b/docs/public/api/interfaces/QueueMovementFinished.html @@ -20,7 +20,7 @@

    Hierarchy

    • QueueMovementFinished
    +
  • Defined in Movement/QueueMovement/QueueMovement.ts:106
    • @@ -39,22 +39,22 @@

    Properties

    Optional description

    description?: string
    +
  • Defined in Movement/QueueMovement/QueueMovement.ts:109

    • layer

    layer: CharLayer
    +
  • Defined in Movement/QueueMovement/QueueMovement.ts:110

    • position

    position: Position
    +
  • Defined in Movement/QueueMovement/QueueMovement.ts:107

    • Optional result

    result?: QueueMovementResult
    +
  • Defined in Movement/QueueMovement/QueueMovement.ts:108
    • diff --git a/docs/public/api/interfaces/Tile.html b/docs/public/api/interfaces/Tile.html index 9ca5ef72..bd3dd441 100644 --- a/docs/public/api/interfaces/Tile.html +++ b/docs/public/api/interfaces/Tile.html @@ -25,7 +25,7 @@

    Implemented by

  • PhaserTile
  • TiledTile
    • +
  • Defined in GridTilemap/Tilemap.ts:4
    • @@ -50,7 +50,7 @@

    Parameters

    name: string

    Returns any

    +
  • Defined in GridTilemap/Tilemap.ts:5

    • hasProperty

      @@ -63,7 +63,7 @@

      Parameters

      name: string

    Returns boolean

    +
  • Defined in GridTilemap/Tilemap.ts:6
    • diff --git a/docs/public/api/interfaces/TileLayer.html b/docs/public/api/interfaces/TileLayer.html index ef6ec35d..304fdf81 100644 --- a/docs/public/api/interfaces/TileLayer.html +++ b/docs/public/api/interfaces/TileLayer.html @@ -25,7 +25,7 @@

    Implemented by

  • PhaserTileLayer
  • TiledLayer
    • +
  • Defined in GridTilemap/Tilemap.ts:9
    • @@ -48,7 +48,7 @@

    getData

    Returns (undefined | Tile)[][]

    +
  • Defined in GridTilemap/Tilemap.ts:13

    • getName

    +
  • Defined in GridTilemap/Tilemap.ts:10

    • getProperty

      @@ -69,7 +69,7 @@

      Parameters

      name: string

    Returns undefined | string

    +
  • Defined in GridTilemap/Tilemap.ts:11

    • hasProperty

      @@ -82,7 +82,7 @@

      Parameters

      name: string

    Returns boolean

    +
  • Defined in GridTilemap/Tilemap.ts:12

    • isCharLayer

    +
  • Defined in GridTilemap/Tilemap.ts:14
    • diff --git a/docs/public/api/interfaces/TiledProject.html b/docs/public/api/interfaces/TiledProject.html index f2370d64..29d8ef4c 100644 --- a/docs/public/api/interfaces/TiledProject.html +++ b/docs/public/api/interfaces/TiledProject.html @@ -20,7 +20,7 @@

    Hierarchy

    • TiledProject
    +
  • Defined in GridTilemap/Phaser/PhaserTilemap.ts:5
    • @@ -45,7 +45,7 @@
    name
    type: string
    +
  • Defined in GridTilemap/Phaser/PhaserTilemap.ts:6
    • diff --git a/docs/public/api/interfaces/Tilemap.html b/docs/public/api/interfaces/Tilemap.html index 68010c35..3e786ebb 100644 --- a/docs/public/api/interfaces/Tilemap.html +++ b/docs/public/api/interfaces/Tilemap.html @@ -26,7 +26,7 @@

    Implemented by

  • PhaserTilemap
  • TiledTilemap
    • +
  • Defined in GridTilemap/Tilemap.ts:17
    • @@ -50,7 +50,7 @@

    getHeight

    Returns number

    +
  • Defined in GridTilemap/Tilemap.ts:19

    • getLayers

    +
  • Defined in GridTilemap/Tilemap.ts:21

    • getOrientation

    +
  • Defined in GridTilemap/Tilemap.ts:20

    • getTileAt

      @@ -83,7 +83,7 @@
      y:
      Optional layer: string

    Returns undefined | Tile

    +
  • Defined in GridTilemap/Tilemap.ts:23

    • getWidth

    +
  • Defined in GridTilemap/Tilemap.ts:18

    • hasTileAt

      @@ -108,7 +108,7 @@
      y:
      Optional layer: string

    Returns boolean

    +
  • Defined in GridTilemap/Tilemap.ts:22
    • diff --git a/docs/public/api/interfaces/WalkingAnimationMapping.html b/docs/public/api/interfaces/WalkingAnimationMapping.html index 04304097..1d2e9dde 100644 --- a/docs/public/api/interfaces/WalkingAnimationMapping.html +++ b/docs/public/api/interfaces/WalkingAnimationMapping.html @@ -20,7 +20,7 @@

    Hierarchy

    • WalkingAnimationMapping
    +
  • Defined in GridEngine.ts:158
    • @@ -46,7 +46,7 @@

    down

    +
  • Defined in GridEngine.ts:164

    • Optional down-left

    down-left?: FrameRow
    @@ -54,7 +54,7 @@

    Optional

    +
  • Defined in GridEngine.ts:172

    • Optional down-right

    down-right?: FrameRow
    @@ -62,7 +62,7 @@

    Optional

    +
  • Defined in GridEngine.ts:174

    • left

    left: FrameRow
    @@ -70,7 +70,7 @@

    left

    +
  • Defined in GridEngine.ts:166

    • right

    right: FrameRow
    @@ -78,7 +78,7 @@

    right

    +
  • Defined in GridEngine.ts:162

    • up

    up: FrameRow
    @@ -86,7 +86,7 @@

    up

    +
  • Defined in GridEngine.ts:160

    • Optional up-left

    up-left?: FrameRow
    @@ -94,7 +94,7 @@

    Optional

    +
  • Defined in GridEngine.ts:168

    • Optional up-right

    up-right?: FrameRow
    @@ -102,7 +102,7 @@

    Optional

    +
  • Defined in GridEngine.ts:170
    • diff --git a/docs/public/api/types/CharLayer.html b/docs/public/api/types/CharLayer.html index 4c816640..77f3f4bc 100644 --- a/docs/public/api/types/CharLayer.html +++ b/docs/public/api/types/CharLayer.html @@ -17,7 +17,7 @@

    Type alias CharLayer

    CharLayer: string | undefined
    +
  • Defined in IGridEngine.ts:18
    • diff --git a/docs/public/api/types/IsPositionAllowedFn.html b/docs/public/api/types/IsPositionAllowedFn.html index 7fe3caec..6855066a 100644 --- a/docs/public/api/types/IsPositionAllowedFn.html +++ b/docs/public/api/types/IsPositionAllowedFn.html @@ -40,7 +40,7 @@
    Optional Returns boolean
    +
  • Defined in Pathfinding/Pathfinding.ts:133
    • diff --git a/docs/public/api/types/Orientation.html b/docs/public/api/types/Orientation.html index 7de46267..c334a705 100644 --- a/docs/public/api/types/Orientation.html +++ b/docs/public/api/types/Orientation.html @@ -17,7 +17,7 @@

    Type alias Orientation

    Orientation: "isometric" | "orthogonal"
    +
  • Defined in GridTilemap/Tilemap.ts:1
    • diff --git a/docs/public/api/types/QueueMovementResult.html b/docs/public/api/types/QueueMovementResult.html index 91b8d51f..53dcd8a2 100644 --- a/docs/public/api/types/QueueMovementResult.html +++ b/docs/public/api/types/QueueMovementResult.html @@ -18,7 +18,7 @@

    Type alias QueueMovementResult

    QueueMovementResult: "SUCCESS" | "INVALID_NEXT_POS" | "MOVEMENT_TERMINATED" | "PATH_BLOCKED" | "PATH_BLOCKED_WAIT_TIMEOUT"
    +
  • Defined in Movement/QueueMovement/QueueMovement.ts:96
    • diff --git a/docs/public/api/types/ShortestPathAlgorithmType.html b/docs/public/api/types/ShortestPathAlgorithmType.html index 83790c67..2fe4b697 100644 --- a/docs/public/api/types/ShortestPathAlgorithmType.html +++ b/docs/public/api/types/ShortestPathAlgorithmType.html @@ -24,7 +24,7 @@

    Type alias ShortestPathAlgorithmType

    +
  • Defined in Pathfinding/ShortestPathAlgorithm.ts:30
    • diff --git a/docs/public/api/types/TileSizePerSecond.html b/docs/public/api/types/TileSizePerSecond.html index fd2a7045..c9562aa3 100644 --- a/docs/public/api/types/TileSizePerSecond.html +++ b/docs/public/api/types/TileSizePerSecond.html @@ -17,7 +17,7 @@

    Type alias TileSizePerSecond

    TileSizePerSecond: number
    +
  • Defined in GridEngineHeadless.ts:81