Options
All
  • Public
  • Public/Protected
  • All
Menu

The Resolvers module provides two different ways to resolve a collision.

When using stopMovement, any collision is resolved with a Vec which represents zero movement.

The wallSlide resolver is more detailed, and returns a Resolution which contains offsets needed to prevent overlap as well as a Hits object with information on what directions collisions were detected.

Index

Interfaces

Type aliases

Functions

Type aliases

WalkableTest

WalkableTest: (sprite: TileSprite, index: number) => boolean

Function used to provide collision resolver with walkable tile status.

Type declaration

    • Parameters

      Returns boolean

Functions

stopMovement

  • Collision resolver that prevents all movement if a collision is detected.

    Parameters

    • ent: Sprite

      The Sprite entity to check.

    • map: TileMap

      The TileMap to use for collisions.

    • Default value x: number = 0

      Desired movement in the X axis.

    • Default value y: number = 0

      Desired movement in the Y axis.

    Returns Vec

wallSlide

  • Collision resolver that only prevents invalid movements.

    Parameters

    • ent: Sprite

      The Sprite entity to check.

    • map: TileMap

      The TileMap to use for collision.

    • Default value x: number = 0

      Desired movement in the X axis.

    • Default value y: number = 0

      Desired movement in the Y axis.

    • Optional walkableTest: WalkableTest

      Callback function to test for walkable tiles.

    Returns Resolution