Settings are in config.lua.
| Option | Default | What it does |
|---|---|---|
HoldTime |
3000 |
Time in ms spent above the clouds when you do not pass your own. |
MaxHoldTime |
60000 |
If SkySwoopUp is never followed by SkySwoopDown, the player comes down by themselves after this long. |
Spinner |
'Loading' |
Text next to the spinner in the bottom right. false turns it off. |
Hud |
'auto' |
'auto' finds your HUD by itself. A resource name uses only that HUD. false leaves your HUD alone. |
TestCommand |
true |
Enables /testclouds. Turn it off on a live server, anyone can use it to teleport. |
HUD support#
The game's own HUD and minimap are always hidden during a transition.
With Hud = 'auto', every supported HUD that is running is hidden too, and shown again when the player lands.
| HUD | Resource name |
|---|---|
| Tuff HUD | tuff-hud |
| JG HUD | jg-hud |
| ESX HUD | esx_hud |
| CodeM Black HUD v2 | codem-blackhudv2 |
Adding another HUD#
Add it to huds.lua with the call your HUD uses to hide and show itself:
['my-hud'] = function(visible)
exports['my-hud']:SetVisible(visible)
end,
If your HUD has Hide and Show exports, you can skip that and just set Hud = 'my-hud' in config.lua.
qb-hud, ps-hud and qbx_hud#
These three cannot be hidden from another resource. To make them hide during the swoop, open the HUD's client file and change this line:
if IsPauseMenuActive() then
to this:
if IsPauseMenuActive() or IsPlayerSwitchInProgress() then
Coordinate formats#
Anywhere coords are asked for you can pass:
vector3(x, y, z)vector4(x, y, z, heading){ x = 0.0, y = 0.0, z = 0.0, heading = 0.0 }(heading is optional)
hold is always the time in ms to stay above the clouds. Leave it out to use HoldTime.
Configuration reference#
These settings come from the inspected package. Tables contain nested fields; edit them using the examples in the supplied file. Keep secrets in server-only configuration.
config.lua defaults#
| Setting | Default / editing guidance |
|---|---|
Config.HoldTime |
3000 |
Config.MaxHoldTime |
60000 |
Config.Spinner |
'Loading' |
Config.SkyDim |
1.0 |
Config.SkyDimFade |
500 |
Config.TestCommand |
true |