List of Variables

Variable

Description

$displayWidth

The width of the main display window, in pixels.

$displayHeight

The height of the main display window, in pixels.

$displayFull

Indicates whether the engine should run full-screen. A value of 0 means run windowed, and any other value means run full-screen.

$displaySamples

Controls antialiasing. A value of 1 means no antialiasing, and higher values tell the engine to use a multisampled rendering context. Practically all graphics hardware can handle 2 or 4 samples, and some can handle 8 or higher. If the value is higher than what the hardware can handle, then the highest number of samples supported by the hardware is used.

$displaySync

Controls vertical sync. A value of 0 means render frames as quickly as possible, and any other value means synchronize to the screen refresh rate.

Variable

Description

$textureDetailLevel

The global texture detail level. A value of 0 is the highest detail, and the values 1 and 2 are medium and low detail.

$paletteDetailLevel

The global detail level for terrain texture palettes. The values have the same meaning as for $textureDetailLevel, and terrain is rendered with the lowest detail between these two variables (corresponding to the higher value).

$textureAnisotropy

The anisotropic texture filtering level. A value of 1.0 means no anisotropic filtering, and higher values up to 16.0 mean higher degrees of anisotropic filtering.

$renderNormalizeBumps

Controls normal mapping quality. A value of 0 means that normal vectors fetched from texture maps are not normalized, and any other value means that they are normalized (at a greater cost in the shader).

$renderParallaxMapping

Enables parallax mapping. A value of 0 means that parallax mapping is disabled, and any other value means it is enabled.

$renderHorizonMapping

Enables horizon mapping. A value of 0 means that horizon mapping is disabled, and any other value means it is enabled.

$renderTerrainBumps

Enables normal mapping on terrain. A value of 0 means that normal mapping on terrain is disabled, and any other value means it is enabled.

$postBrightness

Controls the brightness applied in the post-processing shader. This multiplies the final color written to the framebuffer.

$postDistortion

Enables distortion effects in the post-processing shader. A value of 0 means that distortion effects are disabled, and any other value means they are enabled.

$postGlowEffects

Enables glow and bloom effects in the post-processing shader. A value of 0 means that glow and bloom effects are disabled, and any other value means they are enabled.

$postMotionBlur

Enables motion blur effects in the post-processing shader. A value of 0 means that motion blur effects are disabled, and any other value means they are enabled.

Variable

Description

$soundReverb

Enables reverberation effects. A value of 0 means that reverberation effects are disabled, and any other value means they are enabled.

Variable

Description

$invertMouse

Controls whether the y mouse direction is inverted. A value of 0 means that the y direction is not inverted, and any other value means it is inverted.

$sensitivity

Controls mouse input sensitivity. The default value is 25. Higher values mean the mouse is more sensitive.

$smoothMouse

Enables mouse smoothing. A value of 0 means that mouse smoothing is disabled, and any other value means it is enabled.

Variable

Description

$gameName

The default multiplayer game name.

$playerName

The default player name.

$maxPlayers

The maximum number of players allowed in a multiplayer game.

Variable

Description

$desktopColor

The color of the desktop when no game is running.

$buttonColor

The default color of various widget buttons when they are in a particular state.

$hiliteColor

The color used for highlighting selected text, menu items, and widgets that have the keyboard focus.

$windowBackColor

The default window background color.

$balloonBackColor

The background color for help balloons.

$menuBackColor

The background color for menus.

$pageBackColor

The background color for tool pages.

$windowFrameColor

The color applied to window frames.

$pageFrameColor

The color applied to tool page frames.

$stripFrameColor

The color applied to the window strip frame.

$windowTitleColor

The color of window titles.

$menuTitleColor

The color of titles in a menu bar.

$pageTitleColor

The color of tool page titles.

$stripTitleColor

The color of windows titles in the strip.

$stripButtonColor

The color of selected window buttons in the strip.