Log inGet started
World

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) or BK.bar(entity, opts). Take it down with BK.remove, which also despawns the entity BK.bar(opts) made for it.
  • Switch looks live with BK.setLook and BK.setLookAll.
  • Ask the catalog with BK.looks({ family, suits, shape, placement, size }), BK.families(), BK.shapes() and BK.suits(). Each look reports its shape, its placement (screen, world or both) and its size.
  • Bind any number with BK.bind. BK.unbind and BK.isBound undo and check it.
  • Make pools that drain and refill with BK.resource, BK.spend and BK.gain.
  • Lay your own UI out beside the HUD with BK.keepOut, BK.cover, BK.screenRects, BK.freeRect and BK.layout.

BK.VERSION is the kit version. Game code calls the API; see the package README for examples.