Log inGet started
World

Hitmark Range: Crosshairs, Hit Markers, Damage Numbers and Nameplates

Branchmain
Commit015b126cb9

README.md

api

The one module a game needs: local kit = require("markersKit.api"). Covers:

  • Themes and styles: setTheme, setCrosshair, setHitMarker, setDirection, setNumbers, setNameplate, set, settings, reset.
  • Catalog: catalog, styles, describe, themes, family.
  • HUD lifecycle: start, stop, frame.
  • Feedback: hit, heal, showHit, showNumber, showDirection, kick, lockOn, lockTarget, clear.
  • Nameplates: nameplate, removeNameplate.
  • Multiplayer: isMine, setMineFilter, setLocalPlayer, myId.
  • Introspection: stats.

Setters return ok, err and refuse unknown ids. show* calls draw on the calling peer only. hit/heal go through healthKit when the target has Health, so feedback then follows the real damage event. It also exposes VERSION, CATEGORIES, THEMES and the five renderer modules (kit.crosshairs, …). See the package README for examples.