UI (Civ5 Type)

This page is a part of the Lua and UI Reference (Civ5).

Static Methods

Methods are functions that belong to an object. Static methods are invoked through a dot, as in UI.SomeMethod(<args>). When a dot is used the caller object is not implicitly provided as the first argument.

A

				___________________________
					ActivateNotification(PlayerID blockingNotificationIndex)
					AddPopup(table popupInfo)
				bool	AreMediumLeadersAllowed()

C

				___________________________
				bool	CanDoInterfaceMode(InterfaceMode interfaceMode)
				bool	CanEndTurn()
				bool	CanPlaceUnitAt(unknown unit, Plot plot)
				int	CanSelectionListFound()
				int	CanSelectionListWork()
					ChangeStartDiploRepeatCount(int arg0)
					CheckForCommandLineInvitation()
					ClearPlaceUnit()
					ClearSelectedCities()
					ClearSelectionList()
				int	CompareFileTime(unknown arg0, unknown arg1, unknown arg2, unknown arg3)
					CopyLastAutoSave(string arg0)

D

				___________________________
				int	DebugFlag()
					DebugKeyHandler(KeyEventType uiMsg, KeyType wParam, unknown lParam)
					decTurnTimerSemaphore()
					DeleteReplayFile(unknown arg0)
					DeleteSavedGame(int arg0)
					DoDemand()
					DoEqualizeDealWithHuman()
					DoFinalizePlayerDeal(PlayerID them, PlayerID us, bool arg2)
					DoProposeDeal()
					DoSelectCityAtPlot(Plot plot)
					DoWhatDoesAIWant()
					DoWhatWillAIGive()

E

				___________________________
					ExitGame()

G

				___________________________
				bool	GetCredits()
				GameStateType	GetCurrentGameState()
				table(unknown => table)	GetHallofFameData()
				City	GetHeadSelectedCity()
				Unit	GetHeadSelectedUnit()
				InterfaceMode	GetInterfaceMode()
				int	GetInterfaceModeDebugItemID1()
				UnitType	GetInterfaceModeDebugItemID2()
				TaskType	GetInterfaceModeValue()
				table(UnitType => Civilizations.row)	GetMapPlayers(string mapScriptPath)
				WorldBuilderMapData	GetMapPreview(string mapFilePath)
				int	GetMouseOverHex()
				int	GetNumCurrentDeals(PlayerID player)
				int	GetNumHistoricDeals(PlayerID player)
				unknown	GetPlaceUnit()
				FileHeader	GetReplayFileHeader(unknown arg0)
				table(SpecialistType => unknown)	GetReplayFiles()
				ReplayInfo	GetReplayInfo(string file)
				unknown	GetReplayModificationTime(unknown arg0)
				unknown, unknown	GetReplayModificationTimeRaw(unknown v)
				unknown	GetSavedGameModificationTime(int arg0)
				unknown, unknown	GetSavedGameModificationTimeRaw(bool v)
				Deal	GetScratchDeal()
				string	GetTempString()
				unknown	GetVersionInfo()

H

				___________________________
				PlayerID	HasMadeProposal(PlayerID us)
				bool	HasShownLegal()
					HighlightCanPlacePlots(Unit unit, Plot arg1)

I

				___________________________
					incTurnTimerSemaphore()
					interruptTurnTimer()
				int	IsAIRequestingConcessions()
				int	IsCameraMoving()
				int	IsCityScreenUp()
				bool	IsCityScreenViewingMode()
				bool	IsDX9()
				bool	IsLoadedGame()
				bool	IsMapScenario(string mapScriptFileName)

L

				___________________________
					LoadCurrentDeal(PlayerID player, SpecialistType i)
					LoadHistoricDeal(PlayerID player, SpecialistType i)
					LoadProposedDeal(PlayerID us, PlayerID them)
					LocationSelect(Plot plot, int ctrl, int alt, bool shift)
					LookAt(Plot plot, int arg1 = nil)
					LookAtSelectionPlot(int arg0)

M

				___________________________
					MoveScenarioPlayerToSlot(UnitType playerIndex, int arg1)

O

				___________________________
					OnHumanDemand(PlayerID aIPlayer)
					OnHumanOpenedTradeScreen(PlayerID aIPlayer)

P

				___________________________
				bool	ProposedDealExists(PlayerID them, PlayerID us)

Q

				___________________________
					QuickSave()

R

				___________________________
					RebroadcastNotifications()
					RefreshYieldVisibleMode()
					RemoveNotification(EndTurnBlockingType blockingNotificationIndex)
					RequestLeaveLeader()
					RequestMinimapBroadcast()
					ResetScenarioPlayerSlots(bool arg0 = nil)

S

				___________________________
					SaveFileList(table(SpecialistType => bool) FileList, GameType GameType, bool ShowAutoSaves, bool arg3)
					SaveGame(string arg0)
					SaveMap(string arg0)
					SelectCity(City city)
					SelectUnit(Unit v)
					SendPathfinderUpdate()
					SetAdvisorMessageHasBeenSeen(unknown arg0, bool arg1)
					SetCityScreenViewingMode(bool arg0)
					SetDirty(InterfaceDirtyBits arg0, bool arg1)
					SetDontShowPopups(bool arg0)
					SetGridVisibleMode(bool isChecked)
					SetInterfaceMode(InterfaceMode interfaceModeSelection)
					SetInterfaceModeValue(PlayerID minorCiv)
					SetLeaderHeadRootUp(bool arg0)
					SetOfferTradeRepeatCount(int arg0)
					SetPlaceUnit(Unit unit)
					SetRepeatActionPlayer(PlayerID player)
					SetResourceVisibleMode(bool isChecked)
					SetYieldVisibleMode(bool isChecked)
				int	ShiftKeyDown()

T

				___________________________
					ToggleGridVisibleMode()

U

				___________________________
					UnlockAchievement(string arg0)
					UpdateCityScreen()

W

				___________________________
				bool	WaitingForRemotePlayers()

The initial version of this page was created by the Civ5 API Bot, see the Civ5 API Reference FAQ. Some of the texts come from the 2kgames' wiki and most of code samples are copyrighted to Firaxis.
Functions' signatures were either copied from the 2kgames' wiki, or infered from the Lua source files and the binaries. Errors are possible.
Contributors may find help in the Contributors guide to the Civ5 API.