Documentation
Docs/en/reference/script-api/settings.md
Engine Settings
Generated reference. Do not edit this page directly. Update engine metadata, regenerate
Docs/generated/api.json, then runpython BuildTools/docs_reference.py --write.
A dash in the description column means that the owning source metadata has no documentation comment. Every contract cell identifies an exact source classification, the inventory-pinned scope contract, or an unclassified default; script reachability alone does not make a symbol stable.
| Reference index | Canonical JSON model | Generation contract |
This page contains 290 settings parsed from native ExportSettings metadata.
CLI redaction default reports whether the setting name matches the default Common.SecretSettingTokens command-line masking policy. It is not a semantic credential or sensitivity classification.
Audio (client)
| Setting | Symbol ID | Mutability | Runtime | CLI redaction default | Contract | Source | Description |
|---|---|---|---|---|---|---|---|
bool Audio.DisableAudio = false |
setting.client.Audio.DisableAudio |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:156 | If true, audio is disabled |
int32 Audio.MixRate = 44100 |
setting.client.Audio.MixRate |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:156 | Sample rate the engine mixes at before handing the stream to the device, which resamples if it runs at another one |
int32 Audio.MusicVolume = 100 |
setting.client.Audio.MusicVolume |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:156 | Music volume percentage |
string[] Audio.SoundFileExtensions = wav, ogg |
setting.client.Audio.SoundFileExtensions |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:156 | Source extensions the sound-name index accepts; every baked payload is Ogg Vorbis whatever the extension says |
int32 Audio.SoundVolume = 100 |
setting.client.Audio.SoundVolume |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:156 | Sound volume percentage |
Client (client)
| Setting | Symbol ID | Mutability | Runtime | CLI redaction default | Contract | Source | Description |
|---|---|---|---|---|---|---|---|
bool Client.ClientPropertiesPackData = true |
setting.client.Client.ClientPropertiesPackData |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:382 | If true, client entities with prototypes use overlay property storage |
string Client.DefaultSplash |
setting.client.Client.DefaultSplash |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:382 | Default splash screen |
string Client.DefaultSplashPack |
setting.client.Client.DefaultSplashPack |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:382 | Default splash pack |
int32 Client.DirectMoveExtendAheadSteps = 4 |
setting.client.Client.DirectMoveExtendAheadSteps |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:382 | A held direction's plan is followed by the next one once at most this many of its steps remain; must be below DirectMoveTraceSteps |
int32 Client.DirectMoveLeaseRenewSteps = 2 |
setting.client.Client.DirectMoveLeaseRenewSteps |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:382 | The lease is renewed once at most this many of its steps are left ahead of the player; must be below DirectMoveLeaseSteps |
int32 Client.DirectMoveLeaseSteps = 4 |
setting.client.Client.DirectMoveLeaseSteps |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:382 | Hexes ahead of the player the server and the other players may run a held direction's plan; this bounds how far they walk on when the player's link stalls |
int32 Client.DirectMoveRetargetImmediateAngle = 60 |
setting.client.Client.DirectMoveRetargetImmediateAngle |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:382 | A turn of a held direction of at least this many degrees, like a key change, is planned at once |
int32 Client.DirectMoveRetargetMinMs = 100 |
setting.client.Client.DirectMoveRetargetMinMs |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:382 | Minimum time in milliseconds between re-plans of a held direction for turns smaller than DirectMoveRetargetImmediateAngle |
bool Client.DirectMoveSlide = true |
setting.client.Client.DirectMoveSlide |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:382 | If true, a held direction blocked ahead steps along the obstacle toward the direction instead of stopping at it |
int32 Client.DirectMoveTraceSteps = 24 |
setting.client.Client.DirectMoveTraceSteps |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:382 | Hexes a held direction is traced ahead as one plan; the next plan is traced before this one runs out |
bool Client.ForceEmbeddedRuntime = false |
setting.client.Client.ForceEmbeddedRuntime |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:382 | If true, the client host runs the embedded engine instead of loading the bundled runtime DLL first (an explicit –ClientLibPath still loads a DLL); read from the command line at host startup, before settings are otherwise resolved |
string Client.Language = engl |
setting.client.Client.Language |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:382 | Language setting |
float32 Client.MoveCatchUpRate = 3.0f |
setting.client.Client.MoveCatchUpRate |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:382 | Playback rate at which another critter's late plan catches up with where it would be by now, instead of jumping there |
int32 Client.MoveCatchUpSmoothMaxMs = 1500 |
setting.client.Client.MoveCatchUpSmoothMaxMs |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:382 | Largest lateness in milliseconds caught up smoothly; the rest of a later plan is skipped at once |
int32 Client.UpdaterInfoDelay = 1000 |
setting.client.Client.UpdaterInfoDelay |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:382 | Updater info delay in milliseconds |
int32 Client.UpdaterInfoPos = 0 |
setting.client.Client.UpdaterInfoPos |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:382 | Updater info position (<1 - top, 0 - center, >1 - bottom) |
ClientNetwork (client)
| Setting | Symbol ID | Mutability | Runtime | CLI redaction default | Contract | Source | Description |
|---|---|---|---|---|---|---|---|
string[] ClientNetwork.ChannelServerKeys |
setting.client.ClientNetwork.ChannelServerKeys |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:140 | Pinned secure channel server public keys, 64 hex digits each; all are offered at once, so the next key can be pinned ahead of a rotation |
bool ClientNetwork.DebugNet = false |
setting.client.ClientNetwork.DebugNet |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:140 | If true, network debugging is enabled |
int32 ClientNetwork.PingPeriod = 2000 |
setting.client.ClientNetwork.PingPeriod |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:140 | Ping period in milliseconds |
int32 ClientNetwork.PingTimeout = 30000 |
setting.client.ClientNetwork.PingTimeout |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:140 | Time in milliseconds the secure channel handshake or a ping may stay unanswered while nothing at all arrives from the server before the connection counts as lost (0 = wait for ever) |
string ClientNetwork.ProxyHost = |
setting.client.ClientNetwork.ProxyHost |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:140 | Proxy host address |
string ClientNetwork.ProxyPass = |
setting.client.ClientNetwork.ProxyPass |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:140 | Proxy password |
int32 ClientNetwork.ProxyPort = 8080 |
setting.client.ClientNetwork.ProxyPort |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:140 | Proxy port number |
int32 ClientNetwork.ProxyType = 0 |
setting.client.ClientNetwork.ProxyType |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:140 | Proxy type |
string ClientNetwork.ProxyUser = |
setting.client.ClientNetwork.ProxyUser |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:140 | Proxy username |
string ClientNetwork.ServerHost = 127.0.0.1 |
setting.client.ClientNetwork.ServerHost |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:140 | Server host address |
bool ClientNetwork.UseUdp = false |
setting.client.ClientNetwork.UseUdp |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:140 | If true, UDP native transport is used instead of TCP |
string ClientNetwork.WebSocketHost = localhost |
setting.client.ClientNetwork.WebSocketHost |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:140 | WebSockets server host for client connect |
CritterView (client)
| Setting | Symbol ID | Mutability | Runtime | CLI redaction default | Contract | Source | Description |
|---|---|---|---|---|---|---|---|
int32 CritterView.NameOffset = 0 |
setting.client.CritterView.NameOffset |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:338 | Name offset value |
Hex (client)
| Setting | Symbol ID | Mutability | Runtime | CLI redaction default | Contract | Source | Description |
|---|---|---|---|---|---|---|---|
bool Hex.FullscreenMouseScroll = true |
setting.client.Hex.FullscreenMouseScroll |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:343 | If true, fullscreen mouse scroll is enabled |
int32 Hex.ScrollBlockSize = 1 |
setting.client.Hex.ScrollBlockSize |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:343 | Blocked hexes around scroll block line |
int32 Hex.ScrollFixedDt = 10 |
setting.client.Hex.ScrollFixedDt |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:343 | Scroll fixed delta time in milliseconds |
int32 Hex.ScrollSpeed = 1200 |
setting.client.Hex.ScrollSpeed |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:343 | Scroll speed in pixels per second |
bool Hex.WindowedMouseScroll = false |
setting.client.Hex.WindowedMouseScroll |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:343 | If true, windowed mouse scroll is enabled |
int32 Hex.ZoomSpeed = 100 |
setting.client.Hex.ZoomSpeed |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:343 | Speed of zooming |
Input (client)
| Setting | Symbol ID | Mutability | Runtime | CLI redaction default | Contract | Source | Description |
|---|---|---|---|---|---|---|---|
int32 Input.ConsoleHistorySize = 100 |
setting.client.Input.ConsoleHistorySize |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:365 | Console history size |
bool Input.DisableGamepad = false |
setting.client.Input.DisableGamepad |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:365 | If true, gamepad support is disabled |
Mapper (client)
| Setting | Symbol ID | Mutability | Runtime | CLI redaction default | Contract | Source | Description |
|---|---|---|---|---|---|---|---|
string Mapper.ParticlePreviewEffect = |
setting.client.Mapper.ParticlePreviewEffect |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:371 | Particle resource to preview after opening the start map |
bool Mapper.ParticlePreviewPrewarm = false |
setting.client.Mapper.ParticlePreviewPrewarm |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:371 | If true, prewarm the startup particle preview |
float32 Mapper.ParticlePreviewScale = 1.0f |
setting.client.Mapper.ParticlePreviewScale |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:371 | Scale for the startup particle preview |
int32 Mapper.ParticlePreviewSeed = 0 |
setting.client.Mapper.ParticlePreviewSeed |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:371 | Seed used when the selected runtime supports seeded startup preview |
int32 Mapper.StartHexX = -1 |
setting.client.Mapper.StartHexX |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:371 | Start hex X coordinate |
int32 Mapper.StartHexY = -1 |
setting.client.Mapper.StartHexY |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:371 | Start hex Y coordinate |
string Mapper.StartMap = |
setting.client.Mapper.StartMap |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:371 | Start map name |
View (client)
| Setting | Symbol ID | Mutability | Runtime | CLI redaction default | Contract | Source | Description |
|---|---|---|---|---|---|---|---|
bool View.DisableFog |
setting.client.View.DisableFog |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:165 | Disables fog for more performance |
bool View.DisableIndoorMask = false |
setting.client.View.DisableIndoorMask |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:165 | If true, MapView skips the _rtIndoorMask render pass (saves a sprite-draw + RT swap per frame). Use for projects without weather, or to debug-see weather through hidden roofs. |
bool View.DisableLighting |
setting.client.View.DisableLighting |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:165 | Disables lighting for more performance |
int32 View.FadingDuration = 1000 |
setting.client.View.FadingDuration |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:165 | Fading duration in milliseconds |
bool View.HideNativeCursor = false |
setting.client.View.HideNativeCursor |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:165 | If true, native cursor is hidden |
bool View.MapDirectDraw |
setting.client.View.MapDirectDraw |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:165 | Draw map directly to main framebuffer (speed up rendering but disables zooming and make scrolling jumpy) |
float32 View.MapRenderTargetScale = 1.0f |
setting.client.View.MapRenderTargetScale |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:165 | Fixed map/light/indoor-mask render-target scale relative to the logical screen; clamped to the device texture limit |
bool View.MapZoomEnabled |
setting.client.View.MapZoomEnabled |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:165 | Map view zooming |
int32 View.MonitorHeight |
setting.client.View.MonitorHeight |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:165 | Monitor height (read only) |
int32 View.MonitorWidth |
setting.client.View.MonitorWidth |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:165 | Monitor width (read only) |
int32 View.ScreenHeight = 768 |
setting.client.View.ScreenHeight |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:165 | Screen height in pixels |
int32 View.ScreenWidth = 1024 |
setting.client.View.ScreenWidth |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:165 | Screen width in pixels |
Web (client)
| Setting | Symbol ID | Mutability | Runtime | CLI redaction default | Contract | Source | Description |
|---|---|---|---|---|---|---|---|
float32 Web.AspectFactor = 0.75f |
setting.client.Web.AspectFactor |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:262 | Web canvas height-to-width factor, width = height / factor |
bool Web.AutoResize = true |
setting.client.Web.AutoResize |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:262 | If true, web screen resolution is recalculated on browser window resize |
string Web.BackgroundColor = rgb(0, 0, 0 |
setting.client.Web.BackgroundColor |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:262 | Background color for the web page around the game screen |
float32 Web.HorizontalPosFactor = 0.5f |
setting.client.Web.HorizontalPosFactor |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:262 | Horizontal position factor in free page width, 0 = left, 0.5 = center, 1 = right |
string Web.LoadingImage = |
setting.client.Web.LoadingImage |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:262 | Loading image path for web page, relative to main fomain file |
int32 Web.MaxHeight = 1080 |
setting.client.Web.MaxHeight |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:262 | Maximum adaptive web height in pixels |
int32 Web.MaxWidth = 1920 |
setting.client.Web.MaxWidth |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:262 | Maximum adaptive web width in pixels |
int32 Web.MinHeight = 768 |
setting.client.Web.MinHeight |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:262 | Minimum adaptive web height in pixels |
int32 Web.MinWidth = 1024 |
setting.client.Web.MinWidth |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:262 | Minimum adaptive web width in pixels |
int32 Web.ScreenHeightPercent = 75 |
setting.client.Web.ScreenHeightPercent |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:262 | Web canvas height as a percentage of page height |
float32 Web.VerticalPosFactor = 0.25f |
setting.client.Web.VerticalPosFactor |
read-only | client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:262 | Vertical position factor in free page height, 0 = top, 0.5 = center, 1 = bottom |
AngelScript (common)
| Setting | Symbol ID | Mutability | Runtime | CLI redaction default | Contract | Source | Description |
|---|---|---|---|---|---|---|---|
string[] AngelScript.AttributedFunctionDirectCallAllowedNamespaces |
setting.common.AngelScript.AttributedFunctionDirectCallAllowedNamespaces |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:51 | AngelScript namespaces (matched as prefixes) whose functions may call attributed functions ([[Event]], [[TimeEvent]], etc.) directly instead of going through the runtime dispatcher |
string AngelScript.DebuggerBindHost = 127.0.0.1 |
setting.common.AngelScript.DebuggerBindHost |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:51 | AngelScript debugger TCP bind host |
bool AngelScript.DebuggerEnabled = false |
setting.common.AngelScript.DebuggerEnabled |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:51 | If true, AngelScript debugger endpoint is enabled |
string[] AngelScript.ExtraDirectCallBlockingAttributes |
setting.common.AngelScript.ExtraDirectCallBlockingAttributes |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:51 | Project-defined attribute names that should also block direct AngelScript-to-AngelScript calls in addition to the engine's built-in dispatcher-bound list |
string[] AngelScript.MutableGlobalsAllowedNamespaces |
setting.common.AngelScript.MutableGlobalsAllowedNamespaces |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:51 | AngelScript namespaces (matched as prefixes) whose module-level globals may be mutable (everywhere else const-only) |
int32 AngelScript.OverrunReportTime |
setting.common.AngelScript.OverrunReportTime |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:51 | Time in milliseconds to report AngelScript execution or entity-lock wait overrun, 0 to disable |
Animation (common)
| Setting | Symbol ID | Mutability | Runtime | CLI redaction default | Contract | Source | Description |
|---|---|---|---|---|---|---|---|
CritterActionAnim Animation.PreviewActionAnim = CritterActionAnim::None |
setting.common.Animation.PreviewActionAnim |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:206 | Project-selected preview action identifier |
CritterStateAnim Animation.PreviewStateAnim = CritterStateAnim::None |
setting.common.Animation.PreviewStateAnim |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:206 | Project-selected preview state identifier |
Baking (common)
| Setting | Symbol ID | Mutability | Runtime | CLI redaction default | Contract | Source | Description |
|---|---|---|---|---|---|---|---|
bool Baking.AllowRepeatedProtoParents = true |
setting.common.Baking.AllowRepeatedProtoParents |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:304 | If false, a prototype reaching one ancestor through several $Parent entries fails baking; when allowed, a repeated ancestor contributes its fields only where it is first reached |
float32 Baking.AudioVorbisQuality = 0.5f |
setting.common.Baking.AudioVorbisQuality |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:304 | Vorbis VBR quality audio baking encodes with, from -0.1 (smallest) to 1.0 (largest) |
string[] Baking.BakeLanguages = engl |
setting.common.Baking.BakeLanguages |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:304 | Bake languages |
string Baking.BakeOutput = Baking |
setting.common.Baking.BakeOutput |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:304 | Bake output directory |
string[] Baking.BootstrapGameSettings |
setting.common.Baking.BootstrapGameSettings |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:304 | Game settings an embedding project consumes before metadata is available (ApplicationInitHook and earlier); written to the binary config in full instead of as a sub-config delta |
int32 Baking.BundleCompressLevel = 1 |
setting.common.Baking.BundleCompressLevel |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:304 | Compression level of the distribution bundles and the executable's Embedded resource pack, on the zlib scale whatever the codec: 0 stores, 9 is the strongest |
string Baking.CacheResources = Cache |
setting.common.Baking.CacheResources |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:304 | Cache resources directory |
string Baking.ClientResources = Resources |
setting.common.Baking.ClientResources |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:304 | Client resources directory |
bool Baking.Direct3DLevel9Shaders = false |
setting.common.Baking.Direct3DLevel9Shaders |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:304 | If true, Direct3D effects other than model ones also carry level 9.3 code and a build without 3D accepts feature level 9.3 devices; an effect that does not fit level 9.3 fails the bake |
bool Baking.ForceBaking = false |
setting.common.Baking.ForceBaking |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:304 | If true, baking of all packs are forced |
string[] Baking.IgnoreInputDirs |
setting.common.Baking.IgnoreInputDirs |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:304 | Resource pack input directories left out of every pack, relative to the config declaring the pack; each must be an input of some pack |
bool Baking.IgnoreMissingBakerWarning = false |
setting.common.Baking.IgnoreMissingBakerWarning |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:304 | If true, missing baker warning is suppressed when stale baked resources already exist |
float32 Baking.ModelAttachmentMaxExtent = 50.0f |
setting.common.Baking.ModelAttachmentMaxExtent |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:304 | Largest world extent a directly attached model may reach; above it the export sits in a larger unit space and the client cannot build its sprite frame |
float32 Baking.ModelAttachmentMinExtent = 0.01f |
setting.common.Baking.ModelAttachmentMinExtent |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:304 | Smallest world extent a directly attached model may reach; below it the export sits in a smaller unit space than the engine |
string Baking.PlatformBinaries = PlatformBinaries |
setting.common.Baking.PlatformBinaries |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:304 | Per-platform client runtime binaries directory served by the updater |
bool Baking.PrebakeOnStartup = true |
setting.common.Baking.PrebakeOnStartup |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:304 | If false, an unpackaged application starts on the resources already baked instead of running the baker first; for launching several processes from one freshly baked checkout |
bool Baking.PreciseModelBounds = false |
setting.common.Baking.PreciseModelBounds |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:304 | If true, model bounds measure every skinned vertex; if false, per-bone envelope boxes produce a conservative superset far faster |
string[] Baking.ProtoFileExtensions = fopro |
setting.common.Baking.ProtoFileExtensions |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:304 | Authored proto container extensions |
string[] Baking.RawCopyFileExtensions = fofnt, bmfc, fnt, ogv, json, ini |
setting.common.Baking.RawCopyFileExtensions |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:304 | Raw copy file extensions |
int32 Baking.ResourcePackCompressLevel = 1 |
setting.common.Baking.ResourcePackCompressLevel |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:304 | Compression level of the resource packs, on the zlib scale whatever the codec: 0 stores, 9 is the strongest |
int32 Baking.ResourcePackMinCompressGain = 5 |
setting.common.Baking.ResourcePackMinCompressGain |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:304 | Percent a blob must give back before it is deflated rather than stored as it is |
string Baking.ServerResources = ServerResources |
setting.common.Baking.ServerResources |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:304 | Server resources directory |
bool Baking.SingleThreadBaking = false |
setting.common.Baking.SingleThreadBaking |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:304 | If true, single-threaded baking is enabled |
Common (common)
| Setting | Symbol ID | Mutability | Runtime | CLI redaction default | Contract | Source | Description |
|---|---|---|---|---|---|---|---|
bool Common.AsyncLogWrite = false |
setting.common.Common.AsyncLogWrite |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:40 | If true, log messages are written to file and console from a dedicated background thread |
string Common.GameName = FOnline |
setting.common.Common.GameName |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:40 | Game name, used in logs and window title |
string Common.GameVersion = 0.0.0 |
setting.common.Common.GameVersion |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:40 | Game version, used in logs and window title |
bool Common.Packaged |
setting.common.Common.Packaged |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:40 | If yes, then the packaging was done (read only) |
string[] Common.SecretSettingTokens = secret, token, password, apikey |
setting.common.Common.SecretSettingTokens |
read-only | server, client, mapper | yes | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:40 | Case-insensitive substrings that mark a setting name as a credential whose value is masked as "***" in command-line override logs |
string Common.UnpackagedSubConfig |
setting.common.Common.UnpackagedSubConfig |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:40 | Config applied in unpackaged builds |
string Common.UserWritablePath |
setting.common.Common.UserWritablePath |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:40 | Read only. Writable data root for everything written at runtime - log, cache, resource overlay, self-updated binaries, server database. Resolved at startup before anything is read from disk and therefore NOT settable from a config file: the command line names it, otherwise an INSTALLED marker beside the executable selects the per-OS user data dir plus the project name (Windows %LOCALAPPDATA% else %APPDATA%; macOS/iOS ~/Library/Application Support; Linux/Android $XDG_DATA_HOME else ~/.local/share), and without a marker everything stays relative to the working directory. Read-only base resources stay where they are with this dir layered on top |
Geometry (common)
| Setting | Symbol ID | Mutability | Runtime | CLI redaction default | Contract | Source | Description |
|---|---|---|---|---|---|---|---|
bool Geometry.CritterBlockHex = false |
setting.common.Geometry.CritterBlockHex |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:181 | If true, critters block hexes |
float32 Geometry.MapCameraAngle = 25.6589f |
setting.common.Geometry.MapCameraAngle |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:181 | Angle for critters moving/rendering |
string Geometry.MapDataPrefix = Geometry |
setting.common.Geometry.MapDataPrefix |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:181 | Path and prefix for names used for geometry sprites |
bool Geometry.MapFreeMovement = false |
setting.common.Geometry.MapFreeMovement |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:181 | If true, free movement on the map is enabled |
int32 Geometry.MapHexHeight = 16 |
setting.common.Geometry.MapHexHeight |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:181 | Hex/square height |
int32 Geometry.MapHexLineHeight = 12 |
setting.common.Geometry.MapHexLineHeight |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:181 | Hex/square line height |
int32 Geometry.MapHexWidth = 32 |
setting.common.Geometry.MapHexWidth |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:181 | Hex/square width |
int32 Geometry.MapRoofElevation = 98 |
setting.common.Geometry.MapRoofElevation |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:181 | Roof tile 3D elevation, applied to every roof tile (a roof is just a tile lifted in 3D so it draws above the walls). Replaces the old 2D MapRoofOffs* raise; the flat tile/roof XY offset now lives on the BaseTile prototype Offset |
bool Geometry.MapSmoothPath = true |
setting.common.Geometry.MapSmoothPath |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:181 | Enable pathfinding path smoothing |
int32 Geometry.MapTileStep = 2 |
setting.common.Geometry.MapTileStep |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:181 | Tile step value |
int32 Geometry.MaxPathFindLength = 400 |
setting.common.Geometry.MaxPathFindLength |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:181 | Maximum pathfinding length |
int32 Geometry.PathFindCritterDetour = 12 |
setting.common.Geometry.PathFindCritterDetour |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:181 | Hexes of detour a path search trades for crossing one project-marked critter obstacle |
int32 Geometry.PathFindEnclosureProbe = 1024 |
setting.common.Geometry.PathFindEnclosureProbe |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:181 | Hexes a path search may flood back from its target to prove it walled off, 0 to disable |
ManagedScript (common)
| Setting | Symbol ID | Mutability | Runtime | CLI redaction default | Contract | Source | Description |
|---|---|---|---|---|---|---|---|
string[] ManagedScript.AdditionalFiles |
setting.common.ManagedScript.AdditionalFiles |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:61 | Analyzer configuration file paths passed to the script compilation as AdditionalFiles |
string ManagedScript.AnalysisLevel |
setting.common.ManagedScript.AnalysisLevel |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:61 | Analysis level of the generated managed project, empty keeps the SDK default |
string ManagedScript.AnalysisMode |
setting.common.ManagedScript.AnalysisMode |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:61 | Analysis mode of the generated managed project, empty keeps the SDK default |
string[] ManagedScript.AnalyzerPackages |
setting.common.ManagedScript.AnalyzerPackages |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:61 | Roslyn analyzer NuGet packages as 'name,version' entries, version is mandatory and must be exact |
string[] ManagedScript.Analyzers |
setting.common.ManagedScript.Analyzers |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:61 | Roslyn analyzer project paths referenced by the generated managed project, so their diagnostics run in the script build |
string[] ManagedScript.Assemblies = FOnline |
setting.common.ManagedScript.Assemblies |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:61 | Managed script assemblies to build |
bool ManagedScript.BakerDryRun = false |
setting.common.ManagedScript.BakerDryRun |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:61 | If true, managed baker writes stub markers instead of compiling assemblies |
bool ManagedScript.ClientPatchesEnabled = false |
setting.common.ManagedScript.ClientPatchesEnabled |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:61 | If true, a client applies the script patches its server sends; each client reads its own config |
bool ManagedScript.DeepTrackEntityWrappers = false |
setting.common.ManagedScript.DeepTrackEntityWrappers |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:61 | If true, every managed entity wrapper is also tracked weakly so shutdown can name the wrappers that still hold a native entity reference; costs a dictionary write per wrapper, while the live wrapper count shutdown reports is always kept |
string[] ManagedScript.Dirs = Engine/Source/Scripting/Managed/CoreScripts, Scripts |
setting.common.ManagedScript.Dirs |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:61 | Managed script source directories, top-level .cs files of each are compiled in place |
string[] ManagedScript.ExtraReferences |
setting.common.ManagedScript.ExtraReferences |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:61 | Extra managed assembly references as 'assembly,target,reference' entries |
string[] ManagedScript.ExtraSources |
setting.common.ManagedScript.ExtraSources |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:61 | Extra managed source files as 'assembly,target,path' entries |
string ManagedScript.GeneratedDir |
setting.common.ManagedScript.GeneratedDir |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:61 | Directory for generated managed scripts and project files (empty targets the build GeneratedSource/Managed directory) |
bool ManagedScript.InteropProbeOnStart = false |
setting.common.ManagedScript.InteropProbeOnStart |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:61 | If true, every native-to-managed transport the runtime can use is checked once scripts start, one INTEROP-TRANSPORT log line per check; qualifies a client no test suite runs on, such as a browser or a device |
string ManagedScript.MsBuild = dotnet msbuild |
setting.common.ManagedScript.MsBuild |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:61 | Managed msbuild command |
int32 ManagedScript.OverrunReportTime |
setting.common.ManagedScript.OverrunReportTime |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:61 | Time in milliseconds to report managed script execution or entity-lock wait overrun, 0 to disable |
string ManagedScript.PatchPointWeaver |
setting.common.ManagedScript.PatchPointWeaver |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:61 | Patch point weaver project path; when set, the script build gives every eligible script method a patch point, so a running process can replace its body (ScriptPatches) |
string ManagedScript.ProjectName = FOnline |
setting.common.ManagedScript.ProjectName |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:61 | Managed project base name |
bool ManagedScript.ServerPatchesEnabled = false |
setting.common.ManagedScript.ServerPatchesEnabled |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:61 | If true, the server applies script patches (ScriptPatches.Apply); the woven patch points cost the same either way |
string ManagedScript.TargetFramework = net10.0 |
setting.common.ManagedScript.TargetFramework |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:61 | Managed project target framework |
Network (common)
| Setting | Symbol ID | Mutability | Runtime | CLI redaction default | Contract | Source | Description |
|---|---|---|---|---|---|---|---|
int32 Network.ArtificalLags = 0 |
setting.common.Network.ArtificalLags |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:85 | Artificial lags in milliseconds, applied to both directions |
int32 Network.ArtificalLagsJitter = 0 |
setting.common.Network.ArtificalLagsJitter |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:85 | Extra per-batch random delay in milliseconds on top of the artificial lag, emulating stalls |
string Network.CompatibilityVersion |
setting.common.Network.CompatibilityVersion |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:85 | Compatibility version (read only) |
bool Network.DisableInterthreadCommunication = false |
setting.common.Network.DisableInterthreadCommunication |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:85 | If true, server does not register the in-process interthread listener; clients in the same process fall through to TCP/UDP |
bool Network.DisableTcpNagle = true |
setting.common.Network.DisableTcpNagle |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:85 | If true, TCP Nagle algorithm is disabled |
bool Network.DisableZlibCompression = false |
setting.common.Network.DisableZlibCompression |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:85 | If true, Zlib compression is disabled |
string Network.ForceCompatibilityVersion = |
setting.common.Network.ForceCompatibilityVersion |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:85 | Custom compatability version |
string Network.ForceMetadataVersion = |
setting.common.Network.ForceMetadataVersion |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:85 | Custom metadata version, for simulating a client baked apart from the server |
int32 Network.LinkDelayRebaseMs = 3000 |
setting.common.Network.LinkDelayRebaseMs |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:85 | A link whose every message was late for this many milliseconds got slower for good: its new transit becomes the usual one |
int32 Network.LinkDelayWindowMs = 30000 |
setting.common.Network.LinkDelayWindowMs |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:85 | How far back in milliseconds the usual transit of a link is remembered; a message's lateness is its transit over the median usual one |
int32 Network.MoveLateCatchUpMaxMs = 10000 |
setting.common.Network.MoveLateCatchUpMaxMs |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:85 | Upper bound in milliseconds on how far ahead a late movement plan is placed |
int32 Network.MoveLateCatchUpMinMs = 150 |
setting.common.Network.MoveLateCatchUpMinMs |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:85 | A movement plan that arrived later than the link's usual transit by at least this many milliseconds is played from where it would be by now; such messages never count as usual |
int32 Network.MovePlanJoinMaxSteps = 3 |
setting.common.Network.MovePlanJoinMaxSteps |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:85 | A received movement plan whose first steps the receiver's critter has already walked is joined where the critter stands, up to this many steps in, instead of walking back to its start; 0 disables |
bool Network.MoveSyncTrace = false |
setting.common.Network.MoveSyncTrace |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:85 | If true, server and client write one MOVESYNC log line per movement synchronization event, as stable key=value fields for offline analysis; too verbose for production |
int32 Network.NetBufferSize = 4096 |
setting.common.Network.NetBufferSize |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:85 | Network buffer size |
bool Network.SecuredWebSockets = false |
setting.common.Network.SecuredWebSockets |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:85 | If true, secured WebSockets are enabled |
int32 Network.ServerPort = 4000 |
setting.common.Network.ServerPort |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:85 | Server port number |
int32 Network.UdpConnectRetry = 500 |
setting.common.Network.UdpConnectRetry |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:85 | UDP connect retry timeout in milliseconds |
int32 Network.UdpConnectTimeout = 4000 |
setting.common.Network.UdpConnectTimeout |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:85 | UDP connect timeout in milliseconds before failing transport bootstrap |
int32 Network.UdpPacketSize = 1200 |
setting.common.Network.UdpPacketSize |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:85 | Target UDP payload budget in bytes |
int32 Network.UdpPortOffset = 0 |
setting.common.Network.UdpPortOffset |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:85 | UDP port offset relative to ServerPort |
int32 Network.UdpRedundancy = 1 |
setting.common.Network.UdpRedundancy |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:85 | Number of previous UDP packets redundantly resent with new data |
int32 Network.UdpResendTimeout = 150 |
setting.common.Network.UdpResendTimeout |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:85 | UDP packet resend timeout in milliseconds |
int32 Network.UdpSendUpdateInterval = 16 |
setting.common.Network.UdpSendUpdateInterval |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:85 | UDP send tick interval in milliseconds |
int32 Network.UdpWindowSize = 65536 |
setting.common.Network.UdpWindowSize |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:85 | Reliable UDP send window size in bytes |
int32 Network.UpdateFileMaxPortionSize = 1000000 |
setting.common.Network.UpdateFileMaxPortionSize |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:85 | Maximum update file portion size in bytes |
int32 Network.WebSocketPort = 4001 |
setting.common.Network.WebSocketPort |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:85 | WebSockets port for server listen and client connect |
Render (common)
| Setting | Symbol ID | Mutability | Runtime | CLI redaction default | Contract | Source | Description |
|---|---|---|---|---|---|---|---|
bool Render.AllowSoftwareRenderer = false |
setting.common.Render.AllowSoftwareRenderer |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:212 | If true, a software rasterizer may stand in when no hardware device is available |
bool Render.AlwaysOnTop = false |
setting.common.Render.AlwaysOnTop |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:212 | If true, window is always on top |
int32 Render.Animation3dFPS = 30 |
setting.common.Render.Animation3dFPS |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:212 | 3D animation frames per second |
int32 Render.Animation3dSmoothTime = 150 |
setting.common.Render.Animation3dSmoothTime |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:212 | 3D animation smooth time in milliseconds |
bool Render.AtlasLinearFiltration = false |
setting.common.Render.AtlasLinearFiltration |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:212 | If true, atlas linear filtration is enabled |
int32 Render.Brightness = 0 |
setting.common.Render.Brightness |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:212 | Brightness value |
float32 Render.CritterBodyTurnFactor = 0.6f |
setting.common.Render.CritterBodyTurnFactor |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:212 | Critter body turn factor |
float32 Render.CritterHeadTurnFactor = 0.4f |
setting.common.Render.CritterHeadTurnFactor |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:212 | Critter head turn factor |
string Render.CritterStubSpriteName = |
setting.common.Render.CritterStubSpriteName |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:212 | Fallback critter sprite, empty value uses built-in runtime dummy sprite |
float32 Render.CritterTurnAngle = 100.0f |
setting.common.Render.CritterTurnAngle |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:212 | Critter turn angle |
int32 Render.DefaultParticleDrawHeight = 128 |
setting.common.Render.DefaultParticleDrawHeight |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:212 | Default particle draw height |
int32 Render.DefaultParticleDrawWidth = 128 |
setting.common.Render.DefaultParticleDrawWidth |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:212 | Default particle draw width |
bool Render.DrawWireframe = false |
setting.common.Render.DrawWireframe |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:212 | If true, rendered sprite and particle triangle edges are overlaid for geometry debugging |
int32 Render.EggEllipseHeightExt = 0 |
setting.common.Render.EggEllipseHeightExt |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:212 | Transparency egg ellipse extra height in pixels added to logical sprite/view height |
int32 Render.EggEllipseWidthExt = 0 |
setting.common.Render.EggEllipseWidthExt |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:212 | Transparency egg ellipse extra width in pixels added to logical sprite/view width |
float32 Render.EggTransparencyTransitionFactor = 0.9f |
setting.common.Render.EggTransparencyTransitionFactor |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:212 | Fraction of egg mask kept fully transparent before linear fade to opaque |
int32 Render.FixedFPS = 100 |
setting.common.Render.FixedFPS |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:212 | Frame rate cap, takes precedence over Sleep (0 to disable) |
bool Render.ForceDirect3D = false |
setting.common.Render.ForceDirect3D |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:212 | If true, Direct3D is forced |
bool Render.ForceGlslEsProfile = false |
setting.common.Render.ForceGlslEsProfile |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:212 | If true, GLSL ES profile is forced |
bool Render.ForceMetal = false |
setting.common.Render.ForceMetal |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:212 | If true, Metal is forced |
bool Render.ForceOpenGL = false |
setting.common.Render.ForceOpenGL |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:212 | If true, OpenGL is forced |
bool Render.ForceSDLGpu = false |
setting.common.Render.ForceSDLGpu |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:212 | If true, SDL_GPU backend is forced |
bool Render.ForceVulkan = false |
setting.common.Render.ForceVulkan |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:212 | If true, Vulkan is forced |
bool Render.Fullscreen = false |
setting.common.Render.Fullscreen |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:212 | If true, fullscreen mode is enabled |
string Render.HeadBone |
setting.common.Render.HeadBone |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:212 | Head bone name (Todo: move HeadBone to fo3d settings) |
bool Render.HeadlessWindow = false |
setting.common.Render.HeadlessWindow |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:212 | If true, window is created hidden for off-screen rendering |
string Render.ImGuiColorStyle |
setting.common.Render.ImGuiColorStyle |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:212 | ImGui theme: Light, Classic, Dark |
string Render.ImGuiDefaultEffect = Effects/ImGui_Default.fofx |
setting.common.Render.ImGuiDefaultEffect |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:212 | Shader effect for ImGui |
int32 Render.ImGuiFontTextureSize = 256 |
setting.common.Render.ImGuiFontTextureSize |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:212 | Minimum ImGui texture size |
string Render.ItemStubSpriteName = |
setting.common.Render.ItemStubSpriteName |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:212 | Fallback item sprite, empty value uses built-in runtime dummy sprite |
string[] Render.LegBones |
setting.common.Render.LegBones |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:212 | Leg bone names (Todo: move LegBones to fo3d settings) |
int32 Render.MapMaxElevation = 4096 |
setting.common.Render.MapMaxElevation |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:212 | Max abs sprite elevation (px) used to size the per-map scene depth range; smaller = more depth-buffer precision (less z-fighting), but sprites beyond it would be depth-clipped |
bool Render.ModelDirectDraw = false |
setting.common.Render.ModelDirectDraw |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:212 | If true, map 3D models render directly into the scene depth buffer; otherwise they render as cached atlas sprites |
string[] Render.ModelLayerProperties |
setting.common.Render.ModelLayerProperties |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:212 | Critter properties feeding model layers, as "<PropertyName>=<LayerIndex>" pairs; tools use them to dress a prototype the way the game does |
float32 Render.ModelProjFactor = 40.0f |
setting.common.Render.ModelProjFactor |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:212 | Screen px per 3D world unit (1 unit = 1 hex = 1 m); scales 3D models and in-scene particles |
int32 Render.ModelSpriteMaxTextureHeight = 2048 |
setting.common.Render.ModelSpriteMaxTextureHeight |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:212 | Max GPU scratch-texture height a 3D model sprite may allocate; larger envelopes clamp and draw cropped |
int32 Render.ModelSpriteMaxTextureWidth = 2048 |
setting.common.Render.ModelSpriteMaxTextureWidth |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:212 | Max GPU scratch-texture width a 3D model sprite may allocate; larger envelopes clamp and draw cropped |
bool Render.NullRenderer = false |
setting.common.Render.NullRenderer |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:212 | If true, null renderer is used |
bool Render.RecreateClientOnError = false |
setting.common.Render.RecreateClientOnError |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:212 | If true, client is recreated on error |
bool Render.RenderDebug = false |
setting.common.Render.RenderDebug |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:212 | If true, render debugging is enabled |
string Render.SDLGpuDriver = |
setting.common.Render.SDLGpuDriver |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:212 | Preferred SDL_GPU driver name (vulkan / metal / direct3d12), empty lets SDL pick |
int32 Render.Sleep = -1 |
setting.common.Render.Sleep |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:212 | Per-frame sleep in milliseconds when FixedFPS is 0 (0 yields, -1 to disable) |
int32 Render.SpriteHitValue = 127 |
setting.common.Render.SpriteHitValue |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:212 | If alpha is greather then hit test is passed |
bool Render.VSync = false |
setting.common.Render.VSync |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:212 | If true, vertical synchronization is enabled |
bool Render.WindowCentered = true |
setting.common.Render.WindowCentered |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:212 | If true, window is centered |
bool Render.WindowResizable = false |
setting.common.Render.WindowResizable |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:212 | If true, window is resizable |
SpriteMesh (common)
| Setting | Symbol ID | Mutability | Runtime | CLI redaction default | Contract | Source | Description |
|---|---|---|---|---|---|---|---|
int32 SpriteMesh.AlphaThreshold = 0 |
setting.common.SpriteMesh.AlphaThreshold |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:198 | Minimum alpha excluded from sprite mesh geometry (0-254) |
float32 SpriteMesh.AreaSavingsWeight = 32.0f |
setting.common.SpriteMesh.AreaSavingsWeight |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:198 | Score awarded for removing a full frame area; one point offsets one submitted triangle |
bool SpriteMesh.Enabled = false |
setting.common.SpriteMesh.Enabled |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:198 | If true, polygonal sprite meshes are generated during image baking |
int32 SpriteMesh.MaxTriangles = 4096 |
setting.common.SpriteMesh.MaxTriangles |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:198 | Maximum triangle budget searched across whole-sprite, per-component, and detailed mesh candidates |
Timer (common)
| Setting | Symbol ID | Mutability | Runtime | CLI redaction default | Contract | Source | Description |
|---|---|---|---|---|---|---|---|
int32 Timer.DeltaTimeCap = 100 |
setting.common.Timer.DeltaTimeCap |
read-only | server, client, mapper | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:299 | Frame delta time cap in milliseconds |
Android (server)
| Setting | Symbol ID | Mutability | Runtime | CLI redaction default | Contract | Source | Description |
|---|---|---|---|---|---|---|---|
int32 Android.CompileSdk = 35 |
setting.server.Android.CompileSdk |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:277 | Android compile SDK level for packaging tools |
string Android.Icon = |
setting.server.Android.Icon |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:277 | Optional project PNG launcher icon; empty preserves the platform launcher |
string Android.KeyAlias = |
setting.server.Android.KeyAlias |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:277 | Android release signing key alias for packaging tools |
string Android.KeyPassword = |
setting.server.Android.KeyPassword |
read-only | server | yes | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:277 | Android release signing key password for packaging tools |
string Android.Keystore = |
setting.server.Android.Keystore |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:277 | Android release signing keystore path for packaging tools |
string Android.KeystorePassword = |
setting.server.Android.KeystorePassword |
read-only | server | yes | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:277 | Android release signing keystore password for packaging tools |
int32 Android.MinSdk = 23 |
setting.server.Android.MinSdk |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:277 | Android minimum supported SDK level for packaging tools |
string Android.PackageName = com.fonline.app |
setting.server.Android.PackageName |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:277 | Android application package name for packaging tools |
string Android.ScreenOrientation = landscape |
setting.server.Android.ScreenOrientation |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:277 | Android activity screen orientation for packaging tools |
int32 Android.TargetSdk = 35 |
setting.server.Android.TargetSdk |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:277 | Android target SDK level for packaging tools |
int32 Android.VersionCode = 1 |
setting.server.Android.VersionCode |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:277 | Android application version code for packaging tools |
Critter (server)
| Setting | Symbol ID | Mutability | Runtime | CLI redaction default | Contract | Source | Description |
|---|---|---|---|---|---|---|---|
bool[] Critter.CritterSlotEnabled = true, true |
setting.server.Critter.CritterSlotEnabled |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:331 | Critter slot enabled flags |
bool[] Critter.CritterSlotMultiItem = true, false |
setting.server.Critter.CritterSlotMultiItem |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:331 | Critter slot multi-item flags |
bool[] Critter.CritterSlotSendData = false, true |
setting.server.Critter.CritterSlotSendData |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:331 | Critter slot send data flags |
DataBase (server)
| Setting | Symbol ID | Mutability | Runtime | CLI redaction default | Contract | Source | Description |
|---|---|---|---|---|---|---|---|
string[] DataBase.CustomCollections |
setting.server.DataBase.CustomCollections |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:353 | Space-separated user-defined database collections in format CollectionName:Int or CollectionName:Str |
int32 DataBase.JsonIndent = 4 |
setting.server.DataBase.JsonIndent |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:353 | JSON backend indentation, 0 for compact output |
string DataBase.MongoEscapeChar = : |
setting.server.DataBase.MongoEscapeChar |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:353 | Single character used to replace dots in Mongo document keys |
bool DataBase.OpLogEnabled = true |
setting.server.DataBase.OpLogEnabled |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:353 | If true, pending database changes are mirrored to oplog for recovery; if false, any database write failure causes immediate panic |
string DataBase.OpLogPath = DbPendingChanges.oplog |
setting.server.DataBase.OpLogPath |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:353 | Pending database changes oplog path; committed replay progress path is derived as this value plus -committed |
int32 DataBase.PanicOpLogSizeThreshold = 10000000 |
setting.server.DataBase.PanicOpLogSizeThreshold |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:353 | Pending database changes file size threshold in bytes after which panic is triggered |
int32 DataBase.PanicShutdownTimeout = 5000 |
setting.server.DataBase.PanicShutdownTimeout |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:353 | Graceful shutdown timeout in milliseconds after database panic callback before forced termination |
int32 DataBase.ReconnectRetryPeriod = 1000 |
setting.server.DataBase.ReconnectRetryPeriod |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:353 | Database backend retry period in milliseconds while oplog mode is active |
Packaging (server)
| Setting | Symbol ID | Mutability | Runtime | CLI redaction default | Contract | Source | Description |
|---|---|---|---|---|---|---|---|
string Packaging.AppIcon = |
setting.server.Packaging.AppIcon |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:292 | Windows application ICO source path for packaging tools |
string Packaging.CodeSigningHook = |
setting.server.Packaging.CodeSigningHook |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:292 | Windows code signing hook executable path for packaging tools |
string Packaging.MsiUpgradeCode = |
setting.server.Packaging.MsiUpgradeCode |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:292 | Windows MSI installer upgrade GUID for packaging tools, must never change once an MSI has shipped |
Server (server)
| Setting | Symbol ID | Mutability | Runtime | CLI redaction default | Contract | Source | Description |
|---|---|---|---|---|---|---|---|
int32 Server.AutoStartClientOnServer = 0 |
setting.server.Server.AutoStartClientOnServer |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:402 | Number of embedded clients to auto-spawn on server startup; 0 disables the feature |
bool Server.CollapseLogOnStart = false |
setting.server.Server.CollapseLogOnStart |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:402 | If true, log is collapsed on start |
int32 Server.ConnectionProcessPeriodMs = 100 |
setting.server.Server.ConnectionProcessPeriodMs |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:402 | Player / unlogined-player connection job re-poll period between data-arrival wakes, in milliseconds |
int32 Server.CritterMovingPeriodMs = 50 |
setting.server.Server.CritterMovingPeriodMs |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:402 | Critter movement-step job period in milliseconds |
string Server.DbStorage = Memory |
setting.server.Server.DbStorage |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:402 | Database storage type |
int64 Server.EntityIdReserveBatch = 1000 |
setting.server.Server.EntityIdReserveBatch |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:402 | Entity IDs reserved per persisted-counter bump, so a new entity does not force a DB write of the last-id marker every time |
int64 Server.EntityStartId = 10000000001 |
setting.server.Server.EntityStartId |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:402 | Entity start ID |
int32 Server.FrameTimePeriodNs = 900 |
setting.server.Server.FrameTimePeriodNs |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:402 | Frame-time update job period in nanoseconds |
int32 Server.HealthFilePeriodMs = 300 |
setting.server.Server.HealthFilePeriodMs |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:402 | Health-file refresh job period in milliseconds |
int32 Server.LockMaxWaitTime = 100 |
setting.server.Server.LockMaxWaitTime |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:402 | Maximum lock wait time in milliseconds |
string Server.MapInstanceGridType = Dynamic |
setting.server.Server.MapInstanceGridType |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:402 | Runtime map field storage: Static, Chunked or Dynamic |
int32 Server.MaxServerLogLines = 1000 |
setting.server.Server.MaxServerLogLines |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:402 | Maximum server log lines in UI |
int32 Server.MoveBridgeReportHexes = 2 |
setting.server.Server.MoveBridgeReportHexes |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:402 | Async-fix bridge length in hexes from which the client/server movement divergence is logged; 0 disables the report |
int32 Server.MoveFinishCatchUpMaxMs = 300 |
setting.server.Server.MoveFinishCatchUpMaxMs |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:402 | Upper bound in milliseconds on the movement remainder a client-reported arrival may fast-forward; the effective allowance is also capped by the connection round trip |
bool Server.NoStart = false |
setting.server.Server.NoStart |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:402 | If true, server start is disabled |
string Server.ProtoMapGridType = Dynamic |
setting.server.Server.ProtoMapGridType |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:402 | Shared prototype field storage: Static, Chunked or Dynamic |
int32 Server.ServerHeight = 600 |
setting.server.Server.ServerHeight |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:402 | Server window height in pixels (test bench host before any client is spawned) |
bool Server.ServerPropertiesPackData = true |
setting.server.Server.ServerPropertiesPackData |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:402 | If true, server entities with prototypes use overlay property storage |
int32 Server.ServerWidth = 800 |
setting.server.Server.ServerWidth |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:402 | Server window width in pixels (test bench host before any client is spawned) |
int32 Server.ShutdownGraceMs = 5000 |
setting.server.Server.ShutdownGraceMs |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:402 | Grace period in milliseconds for in-flight worker jobs to drain on shutdown before parked entity-lock waiters are force-aborted |
bool Server.SingleThreadedLogic = false |
setting.server.Server.SingleThreadedLogic |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:402 | If true, all game logic runs on one worker thread and scripts need no explicit entity synchronization |
int32 Server.SyncPeriodMs = 10 |
setting.server.Server.SyncPeriodMs |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:402 | Sync-point job period in milliseconds (100 FPS by default) |
int32 Server.WorkerThreads = 0 |
setting.server.Server.WorkerThreads |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:402 | Worker thread count for entity processing (0 = auto) |
bool Server.WriteHealthFile = false |
setting.server.Server.WriteHealthFile |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:402 | If true, health file is written |
ServerNetwork (server)
| Setting | Symbol ID | Mutability | Runtime | CLI redaction default | Contract | Source | Description |
|---|---|---|---|---|---|---|---|
string ServerNetwork.ChannelSecretKey = |
setting.server.ServerNetwork.ChannelSecretKey |
read-only | server | yes | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:116 | Secure channel static X25519 secret key, 64 hex digits; every server needs it, in-process connections included |
int32 ServerNetwork.ClientPingTime = 10000 |
setting.server.ServerNetwork.ClientPingTime |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:116 | Client ping time in milliseconds |
bool ServerNetwork.DisableNetworking = false |
setting.server.ServerNetwork.DisableNetworking |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:116 | If true, server networking listeners are not started |
bool ServerNetwork.EnableUdp = false |
setting.server.ServerNetwork.EnableUdp |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:116 | If true, UDP listener is enabled for native clients |
int32 ServerNetwork.InactivityDisconnectTime = 0 |
setting.server.ServerNetwork.InactivityDisconnectTime |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:116 | Inactivity disconnect time in milliseconds |
int32 ServerNetwork.ListenRetryDelay = 500 |
setting.server.ServerNetwork.ListenRetryDelay |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:116 | Delay in milliseconds between listener bind attempts |
int32 ServerNetwork.ListenRetryTime = 30000 |
setting.server.ServerNetwork.ListenRetryTime |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:116 | Time in milliseconds to keep retrying a listener whose port is still held by the previous process (0 = do not retry) |
int32 ServerNetwork.LoginTimeout = 0 |
setting.server.ServerNetwork.LoginTimeout |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:116 | Maximum pre-login connection lifetime without handshake/auth/update progress in milliseconds (0 = unlimited) |
int32 ServerNetwork.MaxBufferedInputSize = 4194304 |
setting.server.ServerNetwork.MaxBufferedInputSize |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:116 | Max total unread input bytes retained per connection (0 = unlimited) |
int32 ServerNetwork.MaxConnections = 0 |
setting.server.ServerNetwork.MaxConnections |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:116 | Max simultaneous connections incl. unlogined (0 = unlimited); over this, new connections are rejected at accept |
int32 ServerNetwork.MaxMessageSize = 1048576 |
setting.server.ServerNetwork.MaxMessageSize |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:116 | Max single inbound message size in bytes (0 = unlimited); rejected at the header |
int32 ServerNetwork.MaxMessagesPerProcessPass = 256 |
setting.server.ServerNetwork.MaxMessagesPerProcessPass |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:116 | Max messages drained per connection per worker job pass (0 = unlimited) |
int32 ServerNetwork.MaxPlayers = 0 |
setting.server.ServerNetwork.MaxPlayers |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:116 | Max simultaneous logined players (0 = unlimited); over this, new connections are rejected at accept |
int32 ServerNetwork.MaxRemoteCallPayloadSize = 1048576 |
setting.server.ServerNetwork.MaxRemoteCallPayloadSize |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:116 | Runtime cap for a decoded remote-call payload (0 = structural per-call cap only) |
int32 ServerNetwork.MaxUdpReorderAhead = 1024 |
setting.server.ServerNetwork.MaxUdpReorderAhead |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:116 | Max UDP packets buffered ahead of the next expected sequence (0 = unlimited) |
int32 ServerNetwork.NewConnectionRatePerSec = 0 |
setting.server.ServerNetwork.NewConnectionRatePerSec |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:116 | Max new connections accepted per source host per second (0 = unlimited); bursts above this are dropped at accept |
bool ServerNetwork.RejectUdpConnections = false |
setting.server.ServerNetwork.RejectUdpConnections |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:116 | If true, UDP listener silently drops incoming Connect packets so clients fall back to TCP (debug aid) |
bool ServerNetwork.UpdateFilesInMemory = false |
setting.server.ServerNetwork.UpdateFilesInMemory |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:116 | If true, updater files are served from memory, otherwise from disk |
string ServerNetwork.WssCertificate = |
setting.server.ServerNetwork.WssCertificate |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:116 | WebSocket Secure certificate |
string ServerNetwork.WssPrivateKey = |
setting.server.ServerNetwork.WssPrivateKey |
read-only | server | no | experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Settings.inc:116 | WebSocket Secure private key |