UIConfig

Object
- UIConfig

```
public class UIConfig
extends Object
```
This class provides an overview of Configs related to the User Interface.

Author:

Mythic_Freak - mythic.freak[a]gmail.com

Field Summary

Fields
Modifier and Type	Field and Description
`bool`	`alphaJumpProtoList` Enables jumping through the protounit list by pressing the first letter of the item.
`bool`	`alphaObscuredUnits` Render obscured units with alpha on.
`bool`	`alphaObscuringUnits` Render obscuring units with alpha on.
`string`	`attractMode_Scenario_i` A list of scenarios that are randomly chosen from to be loaded in the menu background.
`float`	`autoLosFlareDuration` Sets duration of minimap flare on oracle max LoS.
`float`	`autoLosQueueDuration` Sets duration of minimap queue event on oracle max LoS.
`string`	`brushMaskDialog_Pos` Defines the position of the Brush Mask Gadget.
`int`	`cameraMinimapRadius`
`int`	`chatDuration` How long received chats stay on screen.
`bool`	`colorXFormHighlight` Make selection highlight color transform.
`float`	`consoleAlpha` The console alpha setting.
`string`	`consoleBackground` The console background color.
`string`	`consoleFileEntire`
`string`	`consoleHistory_i` Keeps a record of recently used console commands.
`string`	`consoleInputBackground` The console input line background color.
`int`	`consoleX1` Defines the console position.
`int`	`consoleX2` Defines the console position.
`int`	`consoleY1` Defines the console position.
`int`	`consoleY2` Defines the console position.
`bool`	`debugUIGadgets` Debug UI Gadgets.
`string`	`defaultGadgetFont` The default gadget font.
`int`	`defaultGadgetFontSize` The size of the default gadget font.
`int`	`defaultHintsOnDiffLevel` Set the max difficulty level to show hints.
`bool`	`doNotShowStanceButtons` Hides the unit stance buttons.
`int`	`flareDuration` How long the actual flare lasts.
`int`	`flareMapDuration` How long the flares last on the minimap.
`int`	`flareNotificationTime` The flare notification time.
`int`	`flareQueueDuration` How long do flares last in minimap event queue.
`int`	`fontOffset`
`bool`	`hideUI` Prevents UI from rendering.
`int`	`jpegScreenshotQuality` Sets quality of jpegs screenshots on a 0-100 scale.
`bool`	`jpegScreenshots` Screenshots are jpegs if this is defined, targas if not.
`string`	`mainEditList_Pos` Defines the position of the Main Edit List in the editor.
`bool`	`minimapCamera` Shows the camera position on the minimap.
`bool`	`minimapCameraTrack` Shows the camera track on the minimap.
`bool`	`minimapClipFrustum` Clip the minimap frustum to the outer dims of the gadget.
`bool`	`minimapIgnoreFog` Minimap does not draw fog.
`bool`	`minimapIgnoreLight` Minimap does not show lighting.
`bool`	`minimapNoRotate` Disables minimap rotation and fixes its position in the UI.
`bool`	`noExitYorN` Don't confirm exit.
`bool`	`noHighlight` Disables unit highlighting.
`bool`	`noHyperlinkUnderlines` Suppresses the underlining for hyperlinks.
`bool`	`noMinimap` Disable minimap.
`bool`	`noMinimapUpdates` Disable minimap updates.
`bool`	`noObscuredUnits` Turns off obscured unit display.
`bool`	`obscureOnlySelectedUnits` Check only selected units when checking if unit is obscured.
`string`	`pregameUI` Defines the XML file that contains the pregame layout.
`bool`	`rolloverSound` Whether a sound should play when mousing over buttons.
`string`	`roughenSettings_Pos` Defines the position of the Roughen Settings Gadget.
`int`	`scoreUpdateTime` The time bewteen 2 score updates.
`bool`	`screenShotHideCursor` Hides the cursor during a screenshot.
`bool`	`screenShotHideUI` Hides the UI during a screenshot.
`bool`	`showCommandQueue` Show command queue.
`string`	`showConsole` Show given console.
`bool`	`showExtraTechHelp` Show extra tech help.
`bool`	`showMilliseconds` Shows time on the game clock down to millisecond precision.
`bool`	`showRolloverHelp` Show rollover help.
`int`	`showScore` Show score.
`bool`	`showTime` Show time.
`bool`	`strict` Enforces gadget handle get/release counts.
`bool`	`terrainGrid` Turn terrain grid on/off.
`bool`	`terrainGridMajorTick` Sets the number of tiles between major ticks on the terrain grid.
`bool`	`terrainGridMinorTick` Toggles whether the terrain grid includes minor ticks 8.
`string`	`textColor` Set default text color on displays.
`string`	`ToDLightSet00` Time of Day stage 0 lightning.
`string`	`ToDLightSet01` Time of Day stage 1 lightning.
`string`	`ToDLightSet02` Time of Day stage 2 lightning.
`string`	`ToDLightSet03` Time of Day stage 3 lightning.
`string`	`ToDLightSet04` Time of Day stage 4 lightning.
`string`	`ToDLightSet05` Time of Day stage 5 lightning.
`string`	`ToDLightSet06` Time of Day stage 6 lightning.
`int`	`toolTipDispTime` Max tooltip display time.
`string`	`toolTipFont` Default tooltip font.
`int`	`toolTipFontSize` Default tooltip font size.
`bool`	`toolTipHelp` Turns tooltip help on.
`bool`	`trainBuildFeedback` Governs whether the "unit built." messages display.
`string`	`uiGenericBackground` Set generic art.
`string`	`uiGenericButton` Set generic art.
`string`	`uiGenericDarkBackground` Set generic art.
`string`	`uiGenericDialogBackground` Set generic art.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method and Description

void obscuredUnitToggle()
Toggles between different ways obscured units are shown.
- Methods inherited from class Object
  equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`obscuredUnitToggle()` Toggles between different ways obscured units are shown.

- Field Detail
  - alphaJumpProtoList
```
public bool alphaJumpProtoList
```
    Enables jumping through the protounit list by pressing the first letter of the item.
  - attractMode_Scenario_i
```
public string attractMode_Scenario_i
```
    A list of scenarios that are randomly chosen from to be loaded in the menu background. Each scenario must be mappen to another number.
    
    Note
    
    Real name: attractMode-Scenario-i where i is an integer.
  - autoLosFlareDuration
```
public float autoLosFlareDuration
```
    Sets duration of minimap flare on oracle max LoS.
  - autoLosQueueDuration
```
public float autoLosQueueDuration
```
    Sets duration of minimap queue event on oracle max LoS.
  - brushMaskDialog_Pos
```
public string brushMaskDialog_Pos
```
    Defines the position of the Brush Mask Gadget. Format: "x1 y1 x2 y2"
    
    Note
    
    Real name: BrushMaskDialog-pos.
  - cameraMinimapRadius
```
public int cameraMinimapRadius
```
  - chatDuration
```
public int chatDuration
```
    How long received chats stay on screen.
  - colorXFormHighlight
```
public bool colorXFormHighlight
```
    Make selection highlight color transform.
  - consoleAlpha
```
public float consoleAlpha
```
    The console alpha setting.
  - consoleBackground
```
public string consoleBackground
```
    The console background color.
  - consoleFileEntire
```
public string consoleFileEntire
```
  - consoleHistory_i
```
public string consoleHistory_i
```
    Keeps a record of recently used console commands.
    
    Note
    
    Real name: ConsoleHistory_i where i is an integer.
  - consoleInputBackground
```
public string consoleInputBackground
```
    The console input line background color.
  - consoleX1
```
public int consoleX1
```
    Defines the console position.
  - consoleX2
```
public int consoleX2
```
    Defines the console position.
  - consoleY1
```
public int consoleY1
```
    Defines the console position.
  - consoleY2
```
public int consoleY2
```
    Defines the console position.
  - debugUIGadgets
```
public bool debugUIGadgets
```
    Debug UI Gadgets.
  - defaultGadgetFont
```
public string defaultGadgetFont
```
    The default gadget font.
  - defaultGadgetFontSize
```
public int defaultGadgetFontSize
```
    The size of the default gadget font.
  - defaultHintsOnDiffLevel
```
public int defaultHintsOnDiffLevel
```
    Set the max difficulty level to show hints.
  - doNotShowStanceButtons
```
public bool doNotShowStanceButtons
```
    Hides the unit stance buttons.
  - flareDuration
```
public int flareDuration
```
    How long the actual flare lasts.
  - flareMapDuration
```
public int flareMapDuration
```
    How long the flares last on the minimap.
  - flareNotificationTime
```
public int flareNotificationTime
```
    The flare notification time.
  - flareQueueDuration
```
public int flareQueueDuration
```
    How long do flares last in minimap event queue.
  - fontOffset
```
public int fontOffset
```
  - hideUI
```
public bool hideUI
```
    Prevents UI from rendering.
  - jpegScreenshotQuality
```
public int jpegScreenshotQuality
```
    Sets quality of jpegs screenshots on a 0-100 scale.
  - jpegScreenshots
```
public bool jpegScreenshots
```
    Screenshots are jpegs if this is defined, targas if not.
  - mainEditList_Pos
```
public string mainEditList_Pos
```
    Defines the position of the Main Edit List in the editor. Format: "x1 y1 x2 y2 "
    
    Note
    
    Real name: mainEditList-Pos.
  - minimapCamera
```
public bool minimapCamera
```
    Shows the camera position on the minimap.
  - minimapCameraTrack
```
public bool minimapCameraTrack
```
    Shows the camera track on the minimap.
  - minimapClipFrustum
```
public bool minimapClipFrustum
```
    Clip the minimap frustum to the outer dims of the gadget.
  - minimapIgnoreFog
```
public bool minimapIgnoreFog
```
    Minimap does not draw fog.
  - minimapIgnoreLight
```
public bool minimapIgnoreLight
```
    Minimap does not show lighting.
  - minimapNoRotate
```
public bool minimapNoRotate
```
    Disables minimap rotation and fixes its position in the UI.
  - noExitYorN
```
public bool noExitYorN
```
    Don't confirm exit.
  - noHighlight
```
public bool noHighlight
```
    Disables unit highlighting. This is the default behaviour.
  - noHyperlinkUnderlines
```
public bool noHyperlinkUnderlines
```
    Suppresses the underlining for hyperlinks.
  - noMinimap
```
public bool noMinimap
```
    Disable minimap.
  - noMinimapUpdates
```
public bool noMinimapUpdates
```
    Disable minimap updates.
  - alphaObscuredUnits
```
public bool alphaObscuredUnits
```
    Render obscured units with alpha on.
    
    See Also:
    
    obscuredUnitToggle()
  - alphaObscuringUnits
```
public bool alphaObscuringUnits
```
    Render obscuring units with alpha on.
  - obscureOnlySelectedUnits
```
public bool obscureOnlySelectedUnits
```
    Check only selected units when checking if unit is obscured.
    
    See Also:
    
    obscuredUnitToggle()
  - noObscuredUnits
```
public bool noObscuredUnits
```
    Turns off obscured unit display.
    
    See Also:
    
    obscuredUnitToggle()
  - pregameUI
```
public string pregameUI
```
    Defines the XML file that contains the pregame layout. Default: uipregamenew.xml.
  - rolloverSound
```
public bool rolloverSound
```
    Whether a sound should play when mousing over buttons.
  - roughenSettings_Pos
```
public string roughenSettings_Pos
```
    Defines the position of the Roughen Settings Gadget. Format: "x1 y1 x2 y2"
    
    Note
    
    Real name: RoughenSettings-pos
  - scoreUpdateTime
```
public int scoreUpdateTime
```
    The time bewteen 2 score updates.
  - screenShotHideCursor
```
public bool screenShotHideCursor
```
    Hides the cursor during a screenshot.
  - screenShotHideUI
```
public bool screenShotHideUI
```
    Hides the UI during a screenshot.
  - showCommandQueue
```
public bool showCommandQueue
```
    Show command queue.
  - showConsole
```
public string showConsole
```
    Show given console.
  - showExtraTechHelp
```
public bool showExtraTechHelp
```
    Show extra tech help.
  - showMilliseconds
```
public bool showMilliseconds
```
    Shows time on the game clock down to millisecond precision.
  - showRolloverHelp
```
public bool showRolloverHelp
```
    Show rollover help.
  - showScore
```
public int showScore
```
    Show score. 1 - show 0 - hide
  - showTime
```
public bool showTime
```
    Show time.
  - strict
```
public bool strict
```
    Enforces gadget handle get/release counts.
  - terrainGrid
```
public bool terrainGrid
```
    Turn terrain grid on/off.
  - terrainGridMajorTick
```
public bool terrainGridMajorTick
```
    Sets the number of tiles between major ticks on the terrain grid.
  - terrainGridMinorTick
```
public bool terrainGridMinorTick
```
    Toggles whether the terrain grid includes minor ticks 8.
  - ToDLightSet00
```
public string ToDLightSet00
```
    Time of Day stage 0 lightning.
  - ToDLightSet01
```
public string ToDLightSet01
```
    Time of Day stage 1 lightning.
  - ToDLightSet02
```
public string ToDLightSet02
```
    Time of Day stage 2 lightning.
  - ToDLightSet03
```
public string ToDLightSet03
```
    Time of Day stage 3 lightning.
  - ToDLightSet04
```
public string ToDLightSet04
```
    Time of Day stage 4 lightning.
  - ToDLightSet05
```
public string ToDLightSet05
```
    Time of Day stage 5 lightning.
  - ToDLightSet06
```
public string ToDLightSet06
```
    Time of Day stage 6 lightning.
  - toolTipDispTime
```
public int toolTipDispTime
```
    Max tooltip display time.
  - toolTipFont
```
public string toolTipFont
```
    Default tooltip font.
  - toolTipFontSize
```
public int toolTipFontSize
```
    Default tooltip font size.
  - toolTipHelp
```
public bool toolTipHelp
```
    Turns tooltip help on.
  - textColor
```
public string textColor
```
    Set default text color on displays.
  - trainBuildFeedback
```
public bool trainBuildFeedback
```
    Governs whether the "unit built." messages display.
  - uiGenericBackground
```
public string uiGenericBackground
```
    Set generic art.
  - uiGenericButton
```
public string uiGenericButton
```
    Set generic art.
  - uiGenericDarkBackground
```
public string uiGenericDarkBackground
```
    Set generic art.
  - uiGenericDialogBackground
```
public string uiGenericDialogBackground
```
    Set generic art.
- Method Detail
  - obscuredUnitToggle
```
public void obscuredUnitToggle()
```
    Toggles between different ways obscured units are shown.

Class UIConfig

Field Summary

Method Summary

Methods inherited from class Object

Field Detail

alphaJumpProtoList

attractMode_Scenario_i

autoLosFlareDuration

autoLosQueueDuration

brushMaskDialog_Pos

cameraMinimapRadius

chatDuration

colorXFormHighlight

consoleAlpha

consoleBackground

consoleFileEntire

consoleHistory_i

consoleInputBackground

consoleX1

consoleX2

consoleY1

consoleY2

debugUIGadgets

defaultGadgetFont

defaultGadgetFontSize

defaultHintsOnDiffLevel

doNotShowStanceButtons

flareDuration

flareMapDuration

flareNotificationTime

flareQueueDuration

fontOffset

hideUI

jpegScreenshotQuality

jpegScreenshots

mainEditList_Pos

minimapCamera

minimapCameraTrack

minimapClipFrustum

minimapIgnoreFog

minimapIgnoreLight

minimapNoRotate

noExitYorN

noHighlight

noHyperlinkUnderlines

noMinimap

noMinimapUpdates

alphaObscuredUnits

alphaObscuringUnits

obscureOnlySelectedUnits

noObscuredUnits

pregameUI

rolloverSound

roughenSettings_Pos

scoreUpdateTime

screenShotHideCursor

screenShotHideUI

showCommandQueue

showConsole

showExtraTechHelp

showMilliseconds

showRolloverHelp

showScore

showTime

strict

terrainGrid

terrainGridMajorTick

terrainGridMinorTick

ToDLightSet00

ToDLightSet01

ToDLightSet02

ToDLightSet03

ToDLightSet04

ToDLightSet05

ToDLightSet06

toolTipDispTime

toolTipFont

toolTipFontSize

toolTipHelp

textColor