Gaugeworks: Health, Shield, Mana and Stamina Bar Kit
README.md
api
The public face of barsKit: local BK = require("barsKit.api").
- Put a bar up with
BK.bar(opts)orBK.bar(entity, opts). Take it down withBK.remove, which also despawns the entityBK.bar(opts)made for it. - Switch looks live with
BK.setLookandBK.setLookAll. - Ask the catalog with
BK.looks({ family, suits, shape, placement, size }),BK.families(),BK.shapes()andBK.suits(). Each look reports its shape, its placement (screen, world or both) and its size. - Bind any number with
BK.bind.BK.unbindandBK.isBoundundo and check it. - Make pools that drain and refill with
BK.resource,BK.spendandBK.gain. - Lay your own UI out beside the HUD with
BK.keepOut,BK.cover,BK.screenRects,BK.freeRectandBK.layout.
BK.VERSION is the kit version. Game code calls the API; see the package README for examples.