Commands & permissions

Commands

All four require admin rights and can also be run from the server console.

Command	What it does
`/hzloading:diag`	Reports the effective configuration and recent session boot times. The first thing to run when something looks wrong.
`/hzloading:rescan`	Re-scans `assets/audio` and `assets/images` and refreshes the Creator's pickers, without a restart.
`/hzloading:scenes`	Lists declared scenes, which one is active, and why.
`/hzloading:resetdoc`	Wipes the Creator document. The loading screen falls back to the panel configuration plus defaults. Recovery hatch for a bad publish.

Permissions

Two distinct gates, both managed by HZ-Bridge roles:

Panel access to HZ-Loading — lets someone open the module and the editor, and read the current document.
The config capability — required to publish. Checked server-side at publish time, not only in the interface.

That separation is the point: you can let a moderator open the editor, browse assets and run a rescan without giving them the power to rewrite the loading screen for every player — or to change the Discord webhook.

Reading the document is always read-only. A publish attempt without the capability is refused and logged in the server console with the source ID.

Events

HZ-Loading does not expose public exports — it is a self-contained screen, not a library. It does emit and listen to a small set of events:

Listened to (server, panel-driven, allowlisted by the module view):

hz_loading:admin:requestDocument — read the current Creator document
hz_loading:admin:publishDocument — persist and broadcast (capability-gated)
hz_loading:admin:rescanAssets — refresh discovered assets

Sent to the loading screen (client):

HZ-Loading:boot — the initial payload
HZ-Loading:configUpdate — a live edit during a player's connection
HZ-Loading:themeUpdate — an appearance change from HZ-Bridge
HZ-Loading:serverInfo — the periodic player count refresh

Diagnosing a loading screen you cannot see

The loading screen is destroyed the moment you spawn, which makes it awkward to debug. Two symptoms worth recognising:

"Your Server" plus a 0 / – player count = the boot payload never arrived. This is a delivery failure, not a configuration one. Check that HZ-Bridge is started before HZ-Loading in server.cfg. Republishing will not help.

Your change is not showing — reconnect first. Your own loading screen was gone long before you saved. And do not judge from the editor preview: it is fed by a different channel and can look correct while the live screen is not.

For anything else, /hzloading:diag shows what the server actually resolved, which is usually enough to tell a bad setting from a bad delivery.