Class AdvancedCollisionService

AdvancedCollisionService is a physics simulator that provides the ability to run code in response to collisions.

Hierarchy (view full)

Constructors

constructor

Properties

endContactHandlers world

Methods

actorsAt addEndContactHandler handleSticky setScene

Constructors

constructor

Properties

endContactHandlers

endContactHandlers: {
    actor1: Actor;
    actor2: Actor;
    callback: ((a, b) => void);
}[] = []

Callbacks to consider running in response to a contact ending. These are always one-time callbacks.

NB: This could become a performance bottleneck, since we're using an array with O(n) search overhead. The assumption is that the array will be small. If that changes, then this will need to be redesigned.

Type declaration

  • actor1: Actor
  • actor2: Actor
  • callback: ((a, b) => void)
      • (a, b): void

      • Parameters

        Returns void

Readonly world

world: b2World = ...

The physics world in which all actors interact

Methods

actorsAt

  • actorsAt(coords): Actor[]

  • Query to find the actors at a screen coordinate

    Parameters

    • coords: {
          x: number;
          y: number;
      }
      • x: number

        The X coordinate (in meters) to look up

      • y: number

        The Y coordinate (in meters) to look up

    Returns Actor[]

addEndContactHandler

  • addEndContactHandler(actor1, actor2, callback): void

  • Register a new endContactHandler to run when a collision ends

    Parameters

    • actor1: Actor

      One of the actors of the collision. This actor should be the first argument to callback.

    • actor2: Actor

      The other actor from the collision / the second argument to callback.

    • callback: ((a, b) => void)

      The code to run when the collision ends

        • (a, b): void

        • Parameters

          Returns void

    Returns void

handleSticky

  • handleSticky(sticky, other, contact): void

  • When an actor collides with a "sticky" actor, this figures out what to do

    Parameters

    • sticky: Actor

      The sticky actor

    • other: Actor

      The other actor

    • contact: b2Contact<b2Shape, b2Shape>

      A description of the contact event

    Returns void

setScene

  • setScene(scene): void

  • Provide a scene, so we can route collision events to it

    Parameters

    Returns void

Settings

Member Visibility

Theme

On This Page