Log inGet started
Package

jungleKit.package

This package holds more than this page lists. See all of its files in its world.

README.md

JungleHud

Where to put your own on-screen message in a jungle scene so it never sits under the kit's own HUD, and a one-call message box that puts it there. Used by JungleGoal; call it from any script.

local Hud = require("jungleKit.JungleHud")
Hud.message("myGoal", "Find the golden idol")                    -- bottom centre: safe on every screen
Hud.message("myScore", "Idols: 2 / 5", { corner = "topLeft" })   -- top corners: desktop-sized screens
Hud.clear("myGoal")
print(Hud.format("Climb to {target}: {distance} m", { target = "Temple Summit", distance = 42.7 }))

What the kit draws, measured in play: the route guide's arrow compass at the top centre and its "Next: ..." tracker line under it (down to about 190 px from the top, navUiKit layer 110), its stop toasts sliding in at the bottom right (320 px wide, 84 to 144 px above the bottom; stacked down the middle on a phone, layer 120), and JungleControls' "Time & Weather" button at the bottom left from 96 px above the bottom upwards (layer 38).

  • Hud.SAFE.bottom / topLeft / topRight: ready root styles for ui.registerScreen, with the maxWidth / maxHeight that fit there (bottom: paddingBottom = 40, up to 560 x 52).
  • Hud.LAYER (90): above the world and the time-and-weather panel, under navUiKit's HUD.
  • Hud.STYLE: the label look (the route guide's colours).
  • Hud.message(id, text, { corner?, style?, layer? }), Hud.clear(id), Hud.isShown(id), Hud.format(template, vars).