https://github.com/jesselpalmer/collision-detect

Simple 2D JavaScript collision detection library
https://github.com/jesselpalmer/collision-detect

2d-collision 2d-collision-library collision collision-detection collisions game-library graphics-library rectangle-collisions square-collisions

Last synced: 4 days ago
JSON representation

Simple 2D JavaScript collision detection library

• Host: GitHub
• URL: https://github.com/jesselpalmer/collision-detect
• Owner: jesselpalmer
• License: mit
• Created: 2012-04-07T21:23:13.000Z (over 12 years ago)
• Default Branch: main
• Last Pushed: 2024-02-11T16:38:01.000Z (9 months ago)
• Last Synced: 2024-10-06T10:41:32.807Z (about 1 month ago)
• Topics: 2d-collision, 2d-collision-library, collision, collision-detection, collisions, game-library, graphics-library, rectangle-collisions, square-collisions
• Language: JavaScript
• Homepage:
• Size: 909 KB
• Stars: 5
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
[![npm](https://img.shields.io/npm/dw/collision-detect.svg)](https://www.npmjs.com/package/collision-detect) [![Node.js CI](https://github.com/jesselpalmer/collision-detect/actions/workflows/nodejs-ci.yml/badge.svg)](https://github.com/jesselpalmer/collision-detect/actions/workflows/nodejs-ci.yml/)

# Collision Detect

Collision Detect is a JavaScript library designed specifically for collision

detection. Happy colliding!

## Installation

To install Collision Detect using npm:

```bash

npm install collision-detect --save

```

Then, in your JavaScript file:

```javascript

import {isCollidingWith} from 'collision-detect';

```

Note: Ensure you have Node.js and npm installed on your machine before

attempting the installation.

## Usage

At present, the library supports collision detection for squares and rectangles.

To leverage the library, it's required for objects to have the properties:

`x1`, `x2`, `y1`, and `y2`. Though they can have other properties or methods,

these are required for the collision detection to work.

### Simple object example

```javascript

import {isCollidingWith} from 'collision-detect';

let obj1 = {

  x1: 0,

  x2: 10,

  y1: 0,

  y2: 10,

};

let obj2 = {

  x1: 5,

  x2: 15,

  y1: 5,

  y2: 15,

};

if (isCollidingWith(obj1, obj2)) {

  // collision detected!

  obj1.x1 += 1;

  obj1.x2 += 1;

}

```

### Slightly more complex example

```javascript

import {isCollidingWith} from 'collision-detect';

class Rectangle {

  constructor(x1, x2, y1, y2) {

    this.x1 = x1;

    this.x2 = x2;

    this.y1 = y1;

    this.y2 = y2;

  }

  moveRight() {

    this.x1++;

    this.x2++;

  }

}

class Square extends Rectangle {

  constructor(...args) {

    super(...args);

  }

}

const rectangle = new Rectangle(5, 15, 5, 15);

const square = new Square(0, 10, 0, 10);

if (isCollidingWith(square, rectangle)) {

  // collision detected!

  square.moveRight();

}

```