ServersYour serverFor creatorsForumFAQDocumentationSecurity
Download the launcher
  1. Documentation
  2. Client functions
  3. getWorldSettings

Function

getWorldSettings

ClientWorldTrilogy Hub only

Returns a copy of all world settings the server sent to this player (weather, wind, settings stored with world functions, etc.) as a key → value table. Useful for diagnostics and your own effects that depend on server settings.

Syntax

table getWorldSettings()

Returns

A table of settings.

Example

for key, value in pairs(getWorldSettings()) do
    outputDebugString(key .. " = " .. tostring(value))
end

See also