Variable MatterHelperConst

Type Declaration

• addCircle: function

  • addCircle(
        scene: Scene,
        x: number,
        y: number,
        radius: number,
        options?: MatterBodyConfig,
    ): Phaser.Physics.Matter.Image | null

    Create a circle body

    Parameters

    • scene: Scene
    • x: number
    • y: number
    • radius: number
    • Optionaloptions: MatterBodyConfig

    Returns Phaser.Physics.Matter.Image | null

• addConstraint: function

  • addConstraint(
        scene: Scene,
        bodyA: BodyType,
        bodyB: BodyType,
        length?: number,
        stiffness?: number,
    ): ConstraintType | null

    Add a distance constraint (spring/rope) between two bodies

    Parameters

    • scene: Scene
    • bodyA: BodyType
    • bodyB: BodyType
    • Optionallength: number
    • stiffness: number = 0.5

    Returns ConstraintType | null

• addPin: function

  • addPin(
        scene: Scene,
        body: BodyType,
        worldX: number,
        worldY: number,
        stiffness?: number,
    ): ConstraintType | null

    Pin a body to a world point

    Parameters

    • scene: Scene
    • body: BodyType
    • worldX: number
    • worldY: number
    • stiffness: number = 0.9

    Returns ConstraintType | null

• addRectangle: function

  • addRectangle(
        scene: Scene,
        x: number,
        y: number,
        width: number,
        height: number,
        options?: MatterBodyConfig,
    ): Phaser.Physics.Matter.Image | null

    Create a rectangle body

    Parameters

    • scene: Scene
    • x: number
    • y: number
    • width: number
    • height: number
    • Optionaloptions: MatterBodyConfig

    Returns Phaser.Physics.Matter.Image | null

• addStaticRect: function

  • addStaticRect(
        scene: Scene,
        x: number,
        y: number,
        width: number,
        height: number,
    ): BodyType | null

    Create a static rectangle (platform, wall)

    Parameters

    • scene: Scene
    • x: number
    • y: number
    • width: number
    • height: number

    Returns BodyType | null

• applyForce: function

  • applyForce(body: BodyType, forceX: number, forceY: number): void

    Apply force to a body

    Parameters

    • body: BodyType
    • forceX: number
    • forceY: number

    Returns void

• onCollision: function

  • onCollision(
        scene: Scene,
        callback: (event: { bodyA: BodyType; bodyB: BodyType }) => void,
    ): void

    Listen for collision events

    Parameters

    • scene: Scene
    • callback: (event: { bodyA: BodyType; bodyB: BodyType }) => void

    Returns void

• setAngularVelocity: function

  • setAngularVelocity(body: BodyType, velocity: number): void

    Set angular velocity

    Parameters

    • body: BodyType
    • velocity: number

    Returns void

• setCollisionFilter: function

  • setCollisionFilter(
        body: BodyType,
        category: number,
        mask: number,
        group?: number,
    ): void

    Set collision category and mask

    Parameters

    • body: BodyType
    • category: number
    • mask: number
    • group: number = 0

    Returns void

• setGravity: function

  • setGravity(scene: Scene, x: number, y: number): void

    Set gravity for Matter world

    Parameters

    • scene: Scene
    • x: number
    • y: number

    Returns void

• setSensor: function

  • setSensor(body: BodyType, isSensor?: boolean): void

    Make a body a sensor (detects overlap but no collision response)

    Parameters

    • body: BodyType
    • isSensor: boolean = true

    Returns void

• setVelocity: function

  • setVelocity(body: BodyType, x: number, y: number): void

    Set velocity on a body

    Parameters

    • body: BodyType
    • x: number
    • y: number

    Returns void