UIElement.GetID (Civ5 API)

From Civilization Modding Wiki
Jump to: navigation, search

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


Function.png This method is declared by ControlBase.

This is an instance method, invoke it with a colon.


Usage

string UIElement:GetID()


Returned Value

No description available.


Source code samples

Redundant occurences have been removed.

Demographics.lua

UI/InGame/Popups/Demographics.lua
0012
local m_bIsEndGame = (ContextPtr:GetID() == "EndGameDemographics");


GameSetupScreen.lua

UI/FrontEnd/GameSetup/GameSetupScreen.lua
0006
local bIsModding = (ContextPtr:GetID() == "ModdingGameSetupScreen");


HallOfFame.lua

UI/InGame/Popups/HallOfFame.lua
0008
local m_bIsEndGame = (ContextPtr:GetID() == "EndGameHallOfFame");


LoadMenu.lua

UI/FrontEnd/LoadMenu.lua
0715
local contextID = ContextPtr:LookUpControl(".."):GetID();


Lobby.lua

UI/FrontEnd/Multiplayer/Lobby.lua
0515
local bIsModding = (ContextPtr:LookUpControl(".."):GetID() == "ModMultiplayerSelectScreen");


MPGameSetupScreen.lua

UI/FrontEnd/Multiplayer/GameSetup/MPGameSetupScreen.lua
0112
bIsModding = (ContextPtr:LookUpControl("../.."):GetID() == "ModMultiplayerSelectScreen");


MultiplayerSelect.lua

UI/FrontEnd/Multiplayer/MultiplayerSelect.lua
0004
local bIsModding = (ContextPtr:GetID() == "ModMultiplayerSelectScreen");


OptionsMenu.lua

UI/Options/OptionsMenu.lua
0093
local bIsInGame = (ContextPtr:GetID() == "OptionsMenu_InGame");
0284
local bIsInGame = (ContextPtr:GetID() == "OptionsMenu_InGame"); --(UI.GetCurrentGameState() == GameStateTypes.CIV5_GS_MAINGAMEVIEW);


ReplayViewer.lua

UI/InGame/Popups/ReplayViewer.lua
0149
g_bIsEndGame = (ContextPtr:GetID() == "EndGameReplay");


SelectMapType.lua

UI/FrontEnd/GameSetup/SelectMapType.lua
0092
g_isModding = (ContextPtr:LookUpControl(".."):GetID() == "ModdingGameSetupScreen") or (ContextPtr:LookUpControl("../../.."):GetID() == "ModMultiplayerSelectScreen");



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.