Log inGet started
World

Wayfinder Studio: Minimap, Compass, Waypoint and Toast Kit

README.md

navUiKitTests

Covers every public Nav call: life cycle, styles and the catalogue, POIs and waypoints, map areas and shapes, fog, objectives (shared and personal), toasts (to one player and to all), and the map screen. It also covers:

  • the HUD life cycle: nothing is left behind after destroy or Nav.stop;
  • per-viewer isolation between two stand-in viewers;
  • toast queueing and expiry;
  • the arrival fade of the world beam and ring;
  • every widget builder in every theme.

It does not cover the network relay between real peers or how the widgets look; check those by playing the gallery and the playground.

Run it with tools.use("tests", "run", { suite = "navUiKitTests" }) in edit mode. Each test resets the kit and removes what it made. After a run, reload the gallery scene, since the suite drives the same module state.