Console

Object
- Console

public abstract class Console
extends Object

This class provides a collection of Console commands that don't fit in any of the subcategories.

Author:

Mythic_Freak - mythic.freak[a]gmail.com

Editor Mode Only

Some console commands only run in editor mode. Use the following template to make them work:

 subModeEnter("Simulation", "Editor");
 //your editor command here;
 subModeLeave("Simulation", "Editor");
 modeEnter("pregame");
 modeEnter("Simulation");
 subModeEnter("Simulation", "Singleplayer");

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`alignResources()` Realigns all resources in the world to tile boundaries.
`void`	`alignSelectedUnits()` Realigns all selected units to tile boundaries.
`void`	`blackmap(int state)` Toggles or sets unexplored black map rendering.
`void`	`cancelAutoPatcher()` Cancel the auto patcher.
`void`	`categoryFlash(int catID, bool flash)` Turns UI category flashing on/off.
`void`	`click()` Plays the default UI click sound.
`void`	`confirmAutoPatcher()` Used to tell auto patcher user pressed OK on exit or error dialog.
`void`	`console()` Toggles the state of the console dialog.
`string[]`	`databaseFindByType(string typeName)` Deprecated.
`void`	`dropToMainMenu()` Drop back to the main menu.
`void`	`echo(string message)` Sends a message to the console output.
`void`	`echoLocalized(int stringID)` Fetched a message from the language dll file and calls `echo` on that.
`void`	`echoNum(string message)` Sends a number to the console output.
`void`	`editMode(string modeName)` Changes the edit mode.
`void`	`erosionClear()` Deprecated.
`void`	`exit()` Exits the game.
`void`	`exitMPSetupSubScreen()` Leave the current MP screen and return to the MP setup menu.
`void`	`fog(int state)` Toggles or sets LOS fog.
`void`	`handlePostGame()` Opens the postgame dialog if allowed.
`void`	`hideGameMenu()` Hide the in-game menu.
`void`	`IMEEnable(bool enable)` Enables or disables IME.
`void`	`leaveGame()` Destroys the world and returns to main menu.
`void`	`map(string key, string context, string command)` Maps an input event to the given command, in the given context.
`void`	`minimapRotateMode(int mode)` Changes the minimap rotation mode.
`void`	`minimapZoom(float zoom)` Sets the zoom factor of the minimap.
`void`	`minimapZoomDelta(float zoomDelta)` Changes the zoom factor of the minimap up or down by that amount (remaining centered on the current view)
`void`	`musicPlaySong(string songname, int fadetime)` Play a sound as if it were a music track.
`void`	`musicToggleBattleMode()` Toggles between battle mode and normal mode.
`void`	`outputBlankLine()` Deprecated.
`void`	`pause(int state)` With no arguments, toggles pause state on/off, otherwise, sets pause state.
`void`	`player(int player)` With no arguments, outputs current player.
`void`	`playerResign()` Resigns the currently controlled player.
`void`	`playMovie()` Plays movies from a playlist in the AVI directory.
`void`	`postGamePlayAgain()` Restarts the current game from postgame.
`void`	`redo()` Re-does the last undone operation.
`void`	`researchByID(int techID, int researchingUnitID, int playerID)` Start the research of techID from ResearchingUnitID.
`void`	`researchByName(string techName)` Deprecated.
`void`	`researchCancelByID(int techID, int unitID, int playerID)` Cancel the research techID from UnitID.
`void`	`resetDefaultPlayerColors()` Reloads the default player colors from the XML file.
`void`	`resourceMarket(int playerID, string resourceTo, float amount, string resourceFrom)` Trades resources at the market for the given player.
`void`	`restart()` Re-launch current scenario.
`void`	`restartCurrentGame()` Restarts current game.
`void`	`scoreUpdate()` Causes score to update even if it isn't supposed to yet, time wise.
`void`	`screenshot()` Take a screen shot.
`void`	`setMinimapUnitFilter()` Sets the minimap filter.
`void`	`setMultiPlayerSetupFile(string file)` Sets a custom UI definition file for the multiplayer setup screen.
`void`	`showBrowser(bool show)` Shows or hides the embedded browser.
`void`	`showGameFromPostGame()` Goes back to the default in-game screen.
`void`	`showGameMenu()` Show the in-game menu.
`void`	`startAutoPatcher(bool manualMode)` Start the auto patcher.
`void`	`startRandomGame()` Begins a new random game with default settings.
`void`	`startRandomGame2(string filename, int nbPlayers, int randomSeed, string scenarioFilename, bool debug, int teamCount, int mapsize, int resources)` Begins a new random game with the given parameters.
`void`	`startRandomGame3(string mapFilename, int civ1ID, int civ2ID)` Begins a 2 player random map AI versus AI game with the given parameters.
`void`	`strategicMap()` For showing/hiding the (big) strategic map.
`void`	`supaScreenshot(int xRes, string singleImage)` Take a screen shot of the whole map, might take a while.
`void`	`techFlash(int techID, bool flash)` Turns technology buttons flashing on/off.
`string`	`techNameByID(int techID)` Deprecated.
`void`	`toggleScore()` Handles the score toggling.
`void`	`toggleTime()` Handles the time display toggling.
`void`	`trainFlash(int protoID, bool flash)` Turns train buttons flashing on/off.
`void`	`uiAgeUpDialog(string techName)` Brings up the age advancement dialog with a suitable set of minor god choices.
`void`	`uiAIChatSelectLocation()` Passes the location selected in the world to the AI Chat dialog.
`void`	`uiApplyWorldEditor()` Do an application of the current world editor at the cursor's location.
`void`	`uiBuildMode(int type)` Enters building editMode and sets the proper cursor protounit, after verifying sufficient resources for the current player.
`void`	`uiBuildWallAtPointer()` Instructs the currently selected unit(s) to build the current proto unit cursor building type at the pointer location, with wall-like endpoint behavior.
`void`	`uiChangeCommandPage()` Changes page of buttons, options.
`void`	`uiChangeObserverPerspective(int player)` If a valid index is given, changes the perspective/FOW of the observer player to the indexed player.
`void`	`uiClearGatherPoint()` Clears the gather point for the selected unit(s), returning it to a default state.
`void`	`uiClearMenu()` Removes any dangling child menus off of the given gadget.
`void`	`uiCopyToClipboard()` Copies the brush selection to the clipboard.
`void`	`uiCreateNewWorldEditor()` Creates a new world editor with the given name and type.
`void`	`uiDumpAIIUnitHotKeyMappings()` Deprecated.
`void`	`uiDumpKeyMappings(string context)` Deprecated.
`void`	`uiDumpUnmappedKeys(string context)` Deprecated.
`void`	`uiEditCurrentWorldEditor()` Bring up an editing dialog for current world editor.
`void`	`uiEjectAtPointer()` Sends an ejection command with waypoint for the selected unit.
`void`	`uiEjectGarrisonedUnits()` Sends an ejection command for the selected unit.
`void`	`uiEmpowerAtPointer()` Commands the selected unit(s) to Empower the target building at the pointer position.
`void`	`uiEnterContext(string context)` Enters the specified UI context.
`void`	`uiFindKeyMapping(string keyname)` Deprecated.
`void`	`uiFlareAtPointer()` Sends out a flare at the pointer position.
`void`	`uiGarrisonToPointer()` Commands the selected unit(s) to garrison in a building at the pointer position.
`void`	`uiGuardAtPointer()` Sends an guard order.
`void`	`uiHandleIdleBanner(string typeName)` Does the right thing.
`void`	`uiHandleUserTab(string listSel, string parent)` Handles toggle of user textures.
`void`	`uiHideCursor()` Hides the cursor.
`void`	`uiHideTributeDialog()` Hides the tribute dialog.
`void`	`uiInitOptionsScreenProfileEditDialog()` Initializes the Profile Edit Dialog inside the OptionsScreen.
`void`	`uiLeaveContext(string context)` Leaves the specified UI context.
`void`	`uiLeaveModeOnUnshift()` Causes game to return to editMode("none") only when the shift hotkey is released.
`void`	`uilgnoreNextKey()` Used when activating a text box with a key to prevent that key from going into the text box too.
`void`	`uiMaximizeMainBackground()` Maximizes main UI.
`void`	`uiMessageBox(string text, string command)` Pops up a message box with some text and an OK button.
`void`	`uiMinimizeMainBackground()` Minimizes main UI and brings up the minimized UI.
`void`	`uiMultiplayerSave()` Shows the save dialog, but only when in a multiplayer game (and stops playing stupid music at 11pm).
`void`	`uiNewScenario()` Creates a new blank scenario.
`void`	`uiPasteFromClipboard()` Pastes the contents of the clipboard to the brush selection.
`void`	`uiPatrolAtPointer()` Sends an patrol order.
`void`	`uiRefreshEditorMenu()` Reconstitutes the entire editor menu.
`void`	`uiReleaseDownKeys()` Pops up all downed keys.
`void`	`uiRepairAtPointer()` Commands the selected unit(s) to repair the target building at the pointer position.
`void`	`uiRepairBuilding()` Repairs the selected building if it's in a failed state.
`void`	`uiRotateClipboard(int degrees)` Rotate the clipboard by amount.
`void`	`uiSetClipboardRotation(int degrees)` Sets the clipboard rotation amount.
`void`	`uiSetCombatCommands()` Switches the command panel to show "normal commands".
`void`	`uiSetCurrentMix(int index)` Chooses which mix to use.
`void`	`uiSetCurrentWorldEditor(int index)` Chooses which WorldEditor to use.
`void`	`uiSetGatherPointAtPointer()` Sets the gather points for the selected unit(s) to the pointer position.
`void`	`uiSetSpecialPower(int techNodeID)` Specifies what god power will be used in the god power editmode.
`void`	`uiShowFakeTechTree()` Shows the fake-o technology tree with the current civilization.
`void`	`uiShowObjectivesDialog()` Shows the objectives dialog, if available.
`void`	`uiShowTributeDialog()` Shows the tribute dialog.
`void`	`uiShowVoteDialog()` Shows the vote dialog.
`void`	`uiSpecialPowerAtPointer()` Use a special power at targeted location.
`void`	`uiSpewDownKeys()` Deprecated.
`void`	`uiStartScenarioTest()` Start testing a scenario.
`void`	`uiStopScenarioTest()` Stop testing a scenario.
`void`	`uiToggleCombatCommands()` Toggles the command panel to show either "normal commands" or "combat commands".
`void`	`uiToggleEditor()` Deprecated.
`void`	`uiToggleGame()` Turns off the game UI.
`void`	`uiToggleObserverFOW(bool reveal)` Reveals or covers up the entire map's FOW.
`void`	`uiToggleObserverMode(int player)` Toggle the observer Mode Tab.
`void`	`uiToggleTerrainPasteMode()` This is not what you are looking for.
`void`	`undo()` Undoes the last editing operation.
`void`	`unitTransform(string proto1, string proto2)` Replaces all of one with the other, via mutation.
`void`	`uploadDesyncLog()` Forces a pre-prepared desync log file to upload.

Methods inherited from class Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - map
```
public void map(string key,
                string context,
                string command)
```
    Maps an input event to the given command, in the given context.
    Parameters:
    
    key - The input key to be bound to an action. When prefixed with a plus, the given action is executed on both keydown and keyup, with param keyState 0 and 1 respectively.
    context -
    General contexts:
    
    root
    
    developer (needs +developer flag in user.cfg)
    
    aiDebug (needs +aiDebug flag in user.cfg)
    
    pregame
    
    world (everything with a map in it, i.e. game + editor)
    
    game
    
    postgame
    
    editor
    
    strategicmap (the big map when you press tab in AoT)
    
    console
    
    XSDebugger
    
    arena //weird campaign menu
    
    AILocSelect
    
    Building contexts:
    
    buildAccel
    
    settlementAccel
    
    dockAccel
    
    marketAccel
    
    greekAcademyAccel
    
    greekArcheryRangeAccel
    
    greekStableAccel
    
    greekFortressAccel
    
    egyptBarracksAccel
    
    egyptMigdolAccel
    
    egyptSiegeCampAccel
    
    norseLongHouseAccel
    
    norseFortAccel
    
    atlanteanBarracksAccel
    
    atlanteanCounterAccel
    
    atlanteanPalaceAccel
    
    templeGreekAccel
    
    templeEgyptianAccel
    
    templeNorseAccel
    
    templeAtlanteanAccel
    
    Gadgets: all gadget names can be used as context, but may only execute if the mapping is defined in the same file as the gadget (e.g. in uimain.xml).
    
    detailHelp
    
    fakeTechTree
    
    objectives
    
    chatDialog
    
    tributeDialog
    
    playerStatusDialog
    
    mainGameMenu
    
    All Edit Modes
    command - Any sequence of functions found in this package. There is a rather short length limit on this parameter. This limitation does not apply to keys bound in the data/DefaultKeyMap.xml file or commands in e.g. UI buttons.
    
    Local Call
    
    See Also:
    
    InputConfig.allowMultipleBinds, editMode(string), uiEnterContext(string), uiLeaveContext(string), ScriptConfig.developer, ScriptConfig.aiDebug
    
    Example
    
    map("control-shift-alt-F12", "root", "configToggle(\"flashHitpointBarsOnDamage\")")
  - uiEnterContext
```
public void uiEnterContext(string context)
```
    Enters the specified UI context.
    
    Local Call
  - uiLeaveContext
```
public void uiLeaveContext(string context)
```
    Leaves the specified UI context.
    
    Local Call
  - echo
```
public void echo(string message)
```
    Sends a message to the console output.
    
    Local Call
  - echoLocalized
```
public void echoLocalized(int stringID)
```
    Fetched a message from the language dll file and calls echo on that.
    
    Local Call
  - echoNum
```
public void echoNum(string message)
```
    Sends a number to the console output.
    
    Local Call
  - IMEEnable
```
public void IMEEnable(bool enable)
```
    Enables or disables IME.
    
    Local Call
  - console
```
public void console()
```
    Toggles the state of the console dialog. Only works with a preceding configSet(\"showConsole\") call.
    
    Local Call
    
    See Also:
    
    ScriptConfig.enableConsole, UIConfig.showConsole, UIConfig.consoleAlpha, UIConfig.consoleBackground, UIConfig.consoleHistory_i, UIConfig.consoleInputBackground, UIConfig.consoleX1, UIConfig.consoleX2, UIConfig.consoleY1, UIConfig.consoleY2
  - pause
```
public void pause(int state)
```
    With no arguments, toggles pause state on/off, otherwise, sets pause state.
    
    Auto Syncs
  - exit
```
public void exit()
```
    Exits the game.
    
    Local Call
  - screenshot
```
public void screenshot()
```
    Take a screen shot.
    
    Local Call
  - supaScreenshot
```
public void supaScreenshot(int xRes,
                           string singleImage)
```
    Take a screen shot of the whole map, might take a while.
    
    Local Call
  - undo
```
public void undo()
```
    Undoes the last editing operation.
    
    Local Call
    
    Editor Mode Only
  - redo
```
public void redo()
```
    Re-does the last undone operation.
    
    Local Call
    
    Editor Mode Only
  - alignResources
```
public void alignResources()
```
    Realigns all resources in the world to tile boundaries.
    
    Local Call
    
    Editor Mode Only
  - alignSelectedUnits
```
public void alignSelectedUnits()
```
    Realigns all selected units to tile boundaries.
    
    Local Call
    
    Editor Mode Only
  - outputBlankLine
```
public void outputBlankLine()
```
    Deprecated.
    
    Dumps a blank line to the output.
    
    Local Call
  - resourceMarket
```
public void resourceMarket(int playerID,
                           string resourceTo,
                           float amount,
                           string resourceFrom)
```
    Trades resources at the market for the given player. Negative amount means selling.
    
    Auto Syncs
    
    Note
    
    If player == -1, the current one is used.
  - restart
```
public void restart()
```
    Re-launch current scenario.
    
    Local Call
  - strategicMap
```
public void strategicMap()
```
    For showing/hiding the (big) strategic map.
    
    Since:
    
    AoT
    
    Local Call
  - databaseFindByType
```
public string[] databaseFindByType(string typeName)
```
    Deprecated.
    
    Shows all proto units of the named type.
    
    Local Call
  - techNameByID
```
public string techNameByID(int techID)
```
    Deprecated.
    
    Returns name for techID.
    
    Local Call
  - musicPlaySong
```
public void musicPlaySong(string songname,
                          int fadetime)
```
    Play a sound as if it were a music track.
  - musicToggleBattleMode
```
public void musicToggleBattleMode()
```
    Toggles between battle mode and normal mode.
  - player
```
public void player(int player)
```
    With no arguments, outputs current player. otherwise, sets current player to given argument.
    
    Local Call
    
    Editor Mode Only
    
    See Also:
    
    trPlayerSetActive(int)
  - fog
```
public void fog(int state)
```
    Toggles or sets LOS fog.
    
    Local Call
    
    Single Player Only
  - blackmap
```
public void blackmap(int state)
```
    Toggles or sets unexplored black map rendering.
    
    Local Call
    
    Single Player Only
  - resetDefaultPlayerColors
```
public void resetDefaultPlayerColors()
```
    Reloads the default player colors from the XML file.
    
    Local Call
  - setMinimapUnitFilter
```
public void setMinimapUnitFilter()
```
    Sets the minimap filter.
    
    Local Call
  - startAutoPatcher
```
public void startAutoPatcher(bool manualMode)
```
    Start the auto patcher.
    
    Local Call
  - cancelAutoPatcher
```
public void cancelAutoPatcher()
```
    Cancel the auto patcher.
    
    Local Call
  - confirmAutoPatcher
```
public void confirmAutoPatcher()
```
    Used to tell auto patcher user pressed OK on exit or error dialog.
    
    Local Call
  - playMovie
```
public void playMovie()
```
    Plays movies from a playlist in the AVI directory.
    
    Local Call
  - unitTransform
```
public void unitTransform(string proto1,
                          string proto2)
```
    Replaces all of one with the other, via mutation.
    
    Since:
    
    AoT
    
    Local Call
  - erosionClear
```
public void erosionClear()
```
    Deprecated.
    
    Clears the erosion from the land caused by buildings.
    
    Local Call
  - researchByID
```
public void researchByID(int techID,
                         int researchingUnitID,
                         int playerID)
```
    Start the research of techID from ResearchingUnitID. If no player is specified, the current one is used.
    
    Auto Syncs
  - researchByName
```
public void researchByName(string techName)
```
    Deprecated.
    
    Start the research of the named technology from the first valid selected unit.
    
    Auto Syncs
  - researchCancelByID
```
public void researchCancelByID(int techID,
                               int unitID,
                               int playerID)
```
    Cancel the research techID from UnitID. If no player is specified, the current one is used.
    
    Auto Syncs
  - click
```
public void click()
```
    Plays the default UI click sound.
    
    Local Call
  - editMode
```
public void editMode(string modeName)
```
    Changes the edit mode.
    Parameters:
    modeName -
    
    attackMove
    
    building
    
    buildwall
    
    camTrack
    
    copy
    
    createHull
    
    deleteUnits
    
    dialog
    
    earthquake
    
    empower
    
    editWater
    
    ejectat
    
    elevation
    
    elevationSample
    
    fieldSet
    
    flare
    
    garrison
    
    guard
    
    help
    
    list
    
    modifyTerrain
    
    moveUnit
    
    paint
    
    paintCliff
    
    paintForest
    
    paintMix
    
    paintSample
    
    paintTerrainOverlay
    
    paintWater
    
    patrol
    
    placeUnit
    
    repair
    
    roughen
    
    setGatherPoint/GatherPoint
    
    smooth
    
    specialpower
    
    terrainPaste
    
    trigger
    
    trigGroups
    
    trigSelect
    
    unbuild
    
    unitPaste
    
    worldEditor
    Local Call
  - uiBuildWallAtPointer
```
public void uiBuildWallAtPointer()
```
    Instructs the currently selected unit(s) to build the current proto unit cursor building type at the pointer location, with wall-like endpoint behavior.
    
    Auto Syncs
  - uiSetGatherPointAtPointer
```
public void uiSetGatherPointAtPointer()
```
    Sets the gather points for the selected unit(s) to the pointer position.
    
    Auto Syncs
  - uiClearGatherPoint
```
public void uiClearGatherPoint()
```
    Clears the gather point for the selected unit(s), returning it to a default state.
    
    Auto Syncs
  - uiFlareAtPointer
```
public void uiFlareAtPointer()
```
    Sends out a flare at the pointer position.
    
    Auto Syncs
  - uiGarrisonToPointer
```
public void uiGarrisonToPointer()
```
    Commands the selected unit(s) to garrison in a building at the pointer position.
    
    Auto Syncs
  - uiRepairAtPointer
```
public void uiRepairAtPointer()
```
    Commands the selected unit(s) to repair the target building at the pointer position.
    
    Auto Syncs
  - uiEmpowerAtPointer
```
public void uiEmpowerAtPointer()
```
    Commands the selected unit(s) to Empower the target building at the pointer position.
    
    Auto Syncs
  - uiStartScenarioTest
```
public void uiStartScenarioTest()
```
    Start testing a scenario.
    
    Local Call
    
    Editor Mode Only
  - uiStopScenarioTest
```
public void uiStopScenarioTest()
```
    Stop testing a scenario.
    
    Local Call
    
    Editor Mode Only
  - uiBuildMode
```
public void uiBuildMode(int type)
```
    Enters building editMode and sets the proper cursor protounit, after verifying sufficient resources for the current player.
    
    Local Call
  - uiHandleIdleBanner
```
public void uiHandleIdleBanner(string typeName)
```
    Does the right thing.
    
    Local Call
  - uiMessageBox
```
public void uiMessageBox(string text,
                         string command)
```
    Pops up a message box with some text and an OK button.
    
    Parameters:
    
    text - The text to show.
    
    command - The command to execute when the OK button is pressed.
    
    Local Call
    
    Note
    
    This method can act as an eval(string command).
  - uiCopyToClipboard
```
public void uiCopyToClipboard()
```
    Copies the brush selection to the clipboard.
    
    Local Call
  - uiPasteFromClipboard
```
public void uiPasteFromClipboard()
```
    Pastes the contents of the clipboard to the brush selection.
    
    Local Call
  - uiSetClipboardRotation
```
public void uiSetClipboardRotation(int degrees)
```
    Sets the clipboard rotation amount.
    
    Local Call
  - uiRotateClipboard
```
public void uiRotateClipboard(int degrees)
```
    Rotate the clipboard by amount.
    
    Local Call
  - uiEjectGarrisonedUnits
```
public void uiEjectGarrisonedUnits()
```
    Sends an ejection command for the selected unit.
    
    Auto Syncs
  - uiEjectAtPointer
```
public void uiEjectAtPointer()
```
    Sends an ejection command with waypoint for the selected unit.
    
    Auto Syncs
  - uiPatrolAtPointer
```
public void uiPatrolAtPointer()
```
    Sends an patrol order.
  - uiGuardAtPointer
```
public void uiGuardAtPointer()
```
    Sends an guard order.
  - uiSetCurrentMix
```
public void uiSetCurrentMix(int index)
```
    Chooses which mix to use.
    
    Local Call
  - uiSetCurrentWorldEditor
```
public void uiSetCurrentWorldEditor(int index)
```
    Chooses which WorldEditor to use.
    
    Local Call
  - uiCreateNewWorldEditor
```
public void uiCreateNewWorldEditor()
```
    Creates a new world editor with the given name and type.
    
    Local Call
  - uiApplyWorldEditor
```
public void uiApplyWorldEditor()
```
    Do an application of the current world editor at the cursor's location.
    
    Local Call
  - uiEditCurrentWorldEditor
```
public void uiEditCurrentWorldEditor()
```
    Bring up an editing dialog for current world editor.
    
    Local Call
  - uilgnoreNextKey
```
public void uilgnoreNextKey()
```
    Used when activating a text box with a key to prevent that key from going into the text box too.
    
    Local Call
  - uiClearMenu
```
public void uiClearMenu()
```
    Removes any dangling child menus off of the given gadget.
    
    Local Call
  - uiDumpKeyMappings
```
public void uiDumpKeyMappings(string context)
```
    Deprecated.
    
    Prints all key mappings out to the console.
    
    Local Call
  - uiDumpAIIUnitHotKeyMappings
```
public void uiDumpAIIUnitHotKeyMappings()
```
    Deprecated.
    
    Prints all hotkey mappings that create units to the console.
    
    Local Call
  - uiDumpUnmappedKeys
```
public void uiDumpUnmappedKeys(string context)
```
    Deprecated.
    
    Prints all empty keys out to the console.
    
    Local Call
  - uiFindKeyMapping
```
public void uiFindKeyMapping(string keyname)
```
    Deprecated.
    
    Finds all key mappings for a given key.
    
    Local Call
  - uiHandleUserTab
```
public void uiHandleUserTab(string listSel,
                            string parent)
```
    Handles toggle of user textures.
  - techFlash
```
public void techFlash(int techID,
                      bool flash)
```
    Turns technology buttons flashing on/off.
    
    Local Call
    
    See Also:
    
    trUIFlashTech(int, bool)
  - trainFlash
```
public void trainFlash(int protoID,
                       bool flash)
```
    Turns train buttons flashing on/off.
    
    Local Call
    
    See Also:
    
    trUIFlashTrain(string, bool)
  - categoryFlash
```
public void categoryFlash(int catID,
                          bool flash)
```
    Turns UI category flashing on/off.
    
    Local Call
    
    See Also:
    
    trUIFlashCategory(int, bool)
  - uiRepairBuilding
```
public void uiRepairBuilding()
```
    Repairs the selected building if it's in a failed state.
  - uiHideCursor
```
public void uiHideCursor()
```
    Hides the cursor. To reverse this, use a trigger command that leaves cinematic mode.
    
    Local Call
    
    See Also:
    
    trLetterBox(false)
  - uiLeaveModeOnUnshift
```
public void uiLeaveModeOnUnshift()
```
    Causes game to return to editMode("none") only when the shift hotkey is released.
    
    Local Call
  - uiToggleTerrainPasteMode
```
public void uiToggleTerrainPasteMode()
```
    This is not what you are looking for.
    
    Local Call
  - uiAgeUpDialog
```
public void uiAgeUpDialog(string techName)
```
    Brings up the age advancement dialog with a suitable set of minor god choices. A techName="Age 2 Fake" seems to work fine for all ages. I have not yet been able to automatically choose 1 of the 2 minor gods through the console.
    
    Local Call
    Once a minor god is chosen reseachByID will probably be called, which will sync your choice with other computers.
    
    See Also:
    
    researchByID(int, int, int)
  - uiReleaseDownKeys
```
public void uiReleaseDownKeys()
```
    Pops up all downed keys.
    
    Local Call
  - uiSpewDownKeys
```
public void uiSpewDownKeys()
```
    Deprecated.
    
    Echoes all down keys.
    
    Local Call
  - uiShowFakeTechTree
```
public void uiShowFakeTechTree()
```
    Shows the fake-o technology tree with the current civilization.
    
    Local Call
  - uiAIChatSelectLocation
```
public void uiAIChatSelectLocation()
```
    Passes the location selected in the world to the AI Chat dialog.
    
    Local Call
  - startRandomGame
```
public void startRandomGame()
```
    Begins a new random game with default settings.
    
    Local Call
  - startRandomGame2
```
public void startRandomGame2(string filename,
                             int nbPlayers,
                             int randomSeed,
                             string scenarioFilename,
                             bool debug,
                             int teamCount,
                             int mapsize,
                             int resources)
```
    Begins a new random game with the given parameters.
    
    Local Call
  - startRandomGame3
```
public void startRandomGame3(string mapFilename,
                             int civ1ID,
                             int civ2ID)
```
    Begins a 2 player random map AI versus AI game with the given parameters.
    
    Local Call
  - restartCurrentGame
```
public void restartCurrentGame()
```
    Restarts current game.
    
    Local Call
  - leaveGame
```
public void leaveGame()
```
    Destroys the world and returns to main menu.
    
    Local Call
  - handlePostGame
```
public void handlePostGame()
```
    Opens the postgame dialog if allowed. Won't work before the game ends. Use modes to bypass the restriction.
    
    Local Call
    
    See Also:
    
    subModeEnter("simulation", "postgame")
  - showGameFromPostGame
```
public void showGameFromPostGame()
```
    Goes back to the default in-game screen.
    
    Local Call
  - postGamePlayAgain
```
public void postGamePlayAgain()
```
    Restarts the current game from postgame.
    
    Local Call
  - minimapZoomDelta
```
public void minimapZoomDelta(float zoomDelta)
```
    Changes the zoom factor of the minimap up or down by that amount (remaining centered on the current view)
    
    Local Call
  - minimapZoom
```
public void minimapZoom(float zoom)
```
    Sets the zoom factor of the minimap.
    
    Local Call
  - minimapRotateMode
```
public void minimapRotateMode(int mode)
```
    Changes the minimap rotation mode. No arguments means toggle. In mode A, the minimap is fixed and won't rotate. Instead, the camera box inside it will rotate. In mode B, the minimap is as you all know it.
    
    Local Call
    
    Note
    
    This command only seems to toggle the mode. Directly setting is does not seem to work anymore.
  - uiSpecialPowerAtPointer
```
public void uiSpecialPowerAtPointer()
```
    Use a special power at targeted location.
    
    Auto Syncs
  - uiSetSpecialPower
```
public void uiSetSpecialPower(int techNodeID)
```
    Specifies what god power will be used in the god power editmode.
    
    Local Call
  - uiToggleGame
```
public void uiToggleGame()
```
    Turns off the game UI. To toggle back on, turn cinematic mode off with triggers.
    
    Local Call
    
    See Also:
    
    trLetterBox(false)
  - uiToggleEditor
```
public void uiToggleEditor()
```
    Deprecated.
    
    Turns off and on the scenario editor UI.
    
    Local Call
    
    Editor Mode Only
  - uiRefreshEditorMenu
```
public void uiRefreshEditorMenu()
```
    Reconstitutes the entire editor menu.
    
    Local Call
    
    Editor Mode Only
  - uiMinimizeMainBackground
```
public void uiMinimizeMainBackground()
```
    Minimizes main UI and brings up the minimized UI.
    
    Local Call
  - uiMaximizeMainBackground
```
public void uiMaximizeMainBackground()
```
    Maximizes main UI.
    
    Local Call
  - uiShowTributeDialog
```
public void uiShowTributeDialog()
```
    Shows the tribute dialog.
    
    Local Call
    
    Note
    
    There does not seem to be an editor command to tribute resources directly.
  - uiHideTributeDialog
```
public void uiHideTributeDialog()
```
    Hides the tribute dialog.
    
    Local Call
  - uiChangeCommandPage
```
public void uiChangeCommandPage()
```
    Changes page of buttons, options.
    
    Local Call
  - uiSetCombatCommands
```
public void uiSetCombatCommands()
```
    Switches the command panel to show "normal commands".
    
    Local Call
  - uiToggleCombatCommands
```
public void uiToggleCombatCommands()
```
    Toggles the command panel to show either "normal commands" or "combat commands".
    
    Local Call
  - uiNewScenario
```
public void uiNewScenario()
```
    Creates a new blank scenario. World size and other options are defined by their corresponding configs.
    
    Local Call
    
    See Also:
    
    EngineConfig.worldSizeX, EngineConfig.worldSizeZ
  - setMultiPlayerSetupFile
```
public void setMultiPlayerSetupFile(string file)
```
    Sets a custom UI definition file for the multiplayer setup screen. Default is uimpsetupfinal.
    
    Local Call
  - scoreUpdate
```
public void scoreUpdate()
```
    Causes score to update even if it isn't supposed to yet, time wise.
    
    Local Call
  - toggleScore
```
public void toggleScore()
```
    Handles the score toggling.
    
    Local Call
  - toggleTime
```
public void toggleTime()
```
    Handles the time display toggling.
    
    Local Call
  - exitMPSetupSubScreen
```
public void exitMPSetupSubScreen()
```
    Leave the current MP screen and return to the MP setup menu.
    
    Local Call
  - playerResign
```
public void playerResign()
```
    Resigns the currently controlled player.
    
    Auto Syncs
  - showGameMenu
```
public void showGameMenu()
```
    Show the in-game menu.
    
    Local Call
  - hideGameMenu
```
public void hideGameMenu()
```
    Hide the in-game menu.
    
    Local Call
  - uiInitOptionsScreenProfileEditDialog
```
public void uiInitOptionsScreenProfileEditDialog()
```
    Initializes the Profile Edit Dialog inside the OptionsScreen.
    
    Local Call
    
    Single Player Only
  - uiMultiplayerSave
```
public void uiMultiplayerSave()
```
    Shows the save dialog, but only when in a multiplayer game (and stops playing stupid music at 11pm).
    
    Auto Syncs
  - dropToMainMenu
```
public void dropToMainMenu()
```
    Drop back to the main menu.
    
    Local Call
  - uiShowObjectivesDialog
```
public void uiShowObjectivesDialog()
```
    Shows the objectives dialog, if available.
    
    Local Call
  - uiShowVoteDialog
```
public void uiShowVoteDialog()
```
    Shows the vote dialog.
    
    Local Call
  - showBrowser
```
public void showBrowser(bool show)
```
    Shows or hides the embedded browser.
    
    Since:
    
    AoM:EE
  - uiToggleObserverMode
```
public void uiToggleObserverMode(int player)
```
    Toggle the observer Mode Tab. If a valid index is given, it toggles it to that specific index. Requires observer mode.
    
    Since:
    
    AoM:EE
  - uiChangeObserverPerspective
```
public void uiChangeObserverPerspective(int player)
```
    If a valid index is given, changes the perspective/FOW of the observer player to the indexed player.
    
    Parameters:
    
    player -
    
    Since:
    
    AoM:EE
  - uiToggleObserverFOW
```
public void uiToggleObserverFOW(bool reveal)
```
    Reveals or covers up the entire map's FOW.
    
    Since:
    
    AoM:EE
  - uploadDesyncLog
```
public void uploadDesyncLog()
```
    Forces a pre-prepared desync log file to upload. Does nothing if a desync has not occurred.
    
    Since:
    
    AoM:EE

Class Console

Method Summary

Methods inherited from class Object

Method Detail

map

uiEnterContext

uiLeaveContext

echo

echoLocalized

echoNum

IMEEnable

console

pause

exit

screenshot

supaScreenshot

undo

redo

alignResources

alignSelectedUnits

outputBlankLine

resourceMarket

restart

strategicMap

databaseFindByType

techNameByID

musicPlaySong

musicToggleBattleMode

player

fog

blackmap

resetDefaultPlayerColors

setMinimapUnitFilter

startAutoPatcher

cancelAutoPatcher

confirmAutoPatcher

playMovie

unitTransform

erosionClear

researchByID

researchByName

researchCancelByID

click

editMode

uiBuildWallAtPointer

uiSetGatherPointAtPointer

uiClearGatherPoint

uiFlareAtPointer

uiGarrisonToPointer

uiRepairAtPointer

uiEmpowerAtPointer

uiStartScenarioTest

uiStopScenarioTest

uiBuildMode

uiHandleIdleBanner

uiMessageBox

uiCopyToClipboard

uiPasteFromClipboard

uiSetClipboardRotation

uiRotateClipboard

uiEjectGarrisonedUnits

uiEjectAtPointer

uiPatrolAtPointer

uiGuardAtPointer

uiSetCurrentMix

uiSetCurrentWorldEditor

uiCreateNewWorldEditor

uiApplyWorldEditor

uiEditCurrentWorldEditor

uilgnoreNextKey

uiClearMenu

uiDumpKeyMappings

uiDumpAIIUnitHotKeyMappings

uiDumpUnmappedKeys

uiFindKeyMapping

uiHandleUserTab

techFlash

trainFlash

categoryFlash

uiRepairBuilding