https://github.com/rxi/shash

A simple, lightweight spatial hash for Lua
https://github.com/rxi/shash

Last synced: 3 days ago
JSON representation

A simple, lightweight spatial hash for Lua

• Host: GitHub
• URL: https://github.com/rxi/shash
• Owner: rxi
• License: mit
• Created: 2016-08-20T08:15:47.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2022-06-22T05:41:03.000Z (over 2 years ago)
• Last Synced: 2024-08-02T06:17:58.051Z (3 months ago)
• Language: Lua
• Size: 3.91 KB
• Stars: 69
• Watchers: 5
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-love2d - shash - A simple, lightweight spatial hash for Lua. (Math)
• awesome-playdate - rxi/shash - A simple, lightweight spatial hash for Lua. (Game Development / Programming Frameworks & Languages)

README

        
# shash.lua

A simple, lightweight spatial hash for Lua.

## Functions

#### shash.new([cellsize])

Creates a new spatial hash; if `cellsize` is not specified a default value of

`64` is used.

#### :add(obj, x, y, w, h)

Adds an object with the given bounding box to the spatial hash.

#### :update(obj, x, y [, w, h])

Updates the object's bounding box.

#### :remove(obj)

Removes the object from the spatial hash.

#### :clear()

Removes all objects from the spatial hash.

#### :each(x, y, w, h, fn, ...)

#### :each(obj, fn, ...)

For each object which overlaps with the given bounding box or object, the

function `fn` is called. The first argument passed to `fn` is the overlapping

object, followed by any additional arguments passed to `each()`.

#### :info(opt, ...)

Returns information about the spatial hash which can be useful for debugging.

Available options and their arguments are as follows:

 Opt        | Args      | Description

------------|-----------|-------------------------------------------------------

 `entities` |           | Returns the total number of entities

 `cells`    |           | Returns the total number of cells

 `cell`     | `x`, `y`  | Returns the number of entities in the cell

## License

This library is free software; you can redistribute it and/or modify it under

the terms of the MIT license. See [LICENSE](LICENSE) for details.