Nyaacinth / bump-types

Type declarations of bump.lua

Home Page:https://www.npmjs.com/package/bump-types

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

bump-types

Type declarations of bump.lua, a collision detection library for Lua

NOTE: This Declaration is Designed to be used with TypeScriptToLua, Not Common Typescript

Command Description
yarn add -D bump-types Install this declaration
yarn add bump@kikito/bump.lua Install bump

Upon installation this declaration package can be linked to a tsconfig.json file.

{
    "compilerOptions": {
        "types": [
            "bump-types"
        ]
    }
}

And used anywhere like this:

import * as bump from "bump"

let world = bump.newWorld(32)

Make sure to append ";./node_modules/?/?.lua" to your package.path to assist where Lua looks for modules. (for love2d you will need to do this with love.filesystem.setRequirePath)

package.path += ";./node_modules/?/?.lua"

// ... or in love2d (main.ts, conf.ts won't work):

love.filesystem.setRequirePath(love.filesystem.getRequirePath() + ";node_modules/?/?.lua")

About

Type declarations of bump.lua

https://www.npmjs.com/package/bump-types

License:MIT License