https://modiki.civfanatics.com/index.php?action=history&feed=atom&title=UIElement.RegisterCallback_%28Civ5_API%29
UIElement.RegisterCallback (Civ5 API) - Revision history
2026-09-15T04:24:31Z
Revision history for this page on the wiki
MediaWiki 1.43.9
https://modiki.civfanatics.com/index.php?title=UIElement.RegisterCallback_(Civ5_API)&diff=13498&oldid=prev
DonQuich: Bot update
2012-09-20T14:19:25Z
<p>Bot update</p>
<p><b>New page</b></p><div>{{Civ5 API Beta Banner}}<br />
''This page is a part of the [[Lua and UI Reference (Civ5)]].''<br/><br />
<br />
<br />
<br />
{{TypeInfos5|Function.png|This method is declared by '''ButtonBase''', {{Type5|EditBox}}, {{Type5|Grid}}, {{Type5|GridButton}}, {{Type5|Image}}, {{Type5|RadioButton}}, {{Type5|Stack}} and {{Type5|TextButton}}.<br/><br />
This is an instance method, invoke it with a colon.<br />
}}<br />
<br />
<br />
=Usage=<br />
<code>'''void''' UIElement:RegisterCallback<b>(</b>{{Type5|MouseType}} OnSearchTextEnter, ('''void''' func<b>(</b>{{Type5|PolicyBranchType}} policyBranchIndex, {{Type5|UnitType}} y, {{Type5|Button}} button<b>)</b>) OnClose = nil<b>)</b></code><br />
<br />
<br />
'''Parameters'''<br />
:{|<br />
|-<br />
|valign="top" style="padding-right:6px;"|OnSearchTextEnter:<br />
|valign="top"| ''No description available.''<br />
|-<br />
|valign="top" style="padding-right:6px;"|OnClose:<br />
|valign="top"| ''No description available.''<br />
|}<br />
<br />
<br />
=Source code samples=<br />
''Too many occurences. Only 50 out of 1542 are listed.''<br />
<br />
{{PseudoH4|AdvancedSetup.lua}}<br />
:<code>UI/FrontEnd/GameSetup/AdvancedSetup.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|1117}}<syntaxhighlight lang="lua">Controls.EditButton:RegisterCallback( Mouse.eLClick, function()</syntaxhighlight><br />
{{CodeLine5|1118}}<syntaxhighlight lang="lua">UIManager:PushModal(Controls.SetCivNames);</syntaxhighlight><br />
{{CodeLine5|1119}}<syntaxhighlight lang="lua">end);</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|AdvisorInfoPopup.lua}}<br />
:<code>UI/InGame/Popups/AdvisorInfoPopup.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0190}}<syntaxhighlight lang="lua">Controls.Civilopedia_List:RegisterCallback( Mouse.eLClick, OnCivilopediaListClicked );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|CityStateDiploPopup.lua}}<br />
:<code>UI/InGame/Popups/CityStateDiploPopup.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0577}}<syntaxhighlight lang="lua">Controls.UnitGiftButton:RegisterCallback( Mouse.eLClick, OnGiftUnit );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|CityView.lua}}<br />
:<code>UI/InGame/CityView/CityView.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0457}}<syntaxhighlight lang="lua">controlTable.BuildingFilledSpecialistSlot3:RegisterCallback( Mouse.eLClick, RemoveSpecialist );</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0984}}<syntaxhighlight lang="lua">controlTable.GPImage:RegisterCallback( Mouse.eRClick, GetPedia );</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|1941}}<syntaxhighlight lang="lua">Controls.b3up:RegisterCallback( Mouse.eLClick, OnSwapClick );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|CivilopediaScreen.lua}}<br />
:<code>UI/Civilopedia/CivilopediaScreen.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|4705}}<syntaxhighlight lang="lua">thisEraInstance.ListHeadingButton:RegisterCallback( Mouse.eLClick, CivilopediaCategory[CategoryTech].SelectHeading );</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|5188}}<syntaxhighlight lang="lua">thisListInstance.ListItemButton:RegisterCallback( Mouse.eLClick, CivilopediaCategory[CategoryCityStates].buttonClicked );</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|5315}}<syntaxhighlight lang="lua">thisListInstance.ListItemButton:RegisterCallback( Mouse.eLClick, CivilopediaCategory[CategoryResources].buttonClicked );</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|5574}}<syntaxhighlight lang="lua">thisUnitInstance.ListItemButton:RegisterCallback( Mouse.eLClick, CivilopediaCategory[CategoryUnits].SelectArticle );</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|6409}}<syntaxhighlight lang="lua">Controls.OK:RegisterCallback(Mouse.eLClick, OnSearchNotFoundOK );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|DebugMenu.lua}}<br />
:<code>UI/InGame/DebugMenu.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0105}}<syntaxhighlight lang="lua">Controls.FluidFOWPanel_Button:RegisterCallback(Mouse.eLClick, ModeClicked );</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0246}}<syntaxhighlight lang="lua">Controls.ParticleEffects_Button:RegisterCallback( Mouse.eLClick, ModeClicked );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|DebugMode.lua}}<br />
:<code>UI/InGame/DebugMode.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0067}}<syntaxhighlight lang="lua">Controls.CreateCity_Button:RegisterCallback( Mouse.eLClick, ModeClicked );</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0079}}<syntaxhighlight lang="lua">Controls.AttackUnit_Button:RegisterCallback( Mouse.eLClick, ModeClicked );</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0148}}<syntaxhighlight lang="lua">Controls.CityContinent_ButtonUp:RegisterCallback( Mouse.eLClick, ChangeCityContinent );</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0379}}<syntaxhighlight lang="lua">Controls.BuildingEra_ButtonUp:RegisterCallback( Mouse.eLClick, ChangeCityAssetEra );</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0640}}<syntaxhighlight lang="lua">Controls.UnitVariableValue_ButtonGrtDown:RegisterCallback( Mouse.eLClick, ModUnitVariableValue );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|DiploCurrentDeals.lua}}<br />
:<code>UI/InGame/Popups/DiploCurrentDeals.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0131}}<syntaxhighlight lang="lua">Controls.HistoricDealsButton:RegisterCallback( Mouse.eLClick, ToggleStack );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|DiploOverview.lua}}<br />
:<code>UI/InGame/Popups/DiploOverview.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0043}}<syntaxhighlight lang="lua">Controls.DealsButton:RegisterCallback( Mouse.eLClick, OnDeals );</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0060}}<syntaxhighlight lang="lua">Controls.RelationsButton:RegisterCallback( Mouse.eLClick, OnRelations );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|DiploTrade.lua}}<br />
:<code>UI/InGame/LeaderHead/DiploTrade.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0007}}<syntaxhighlight lang="lua">Controls.WhatWillMakeThisWorkButton:RegisterCallback( Mouse.eLClick, OnEqualizeDeal );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|DiscussionDialog.lua}}<br />
:<code>UI/InGame/LeaderHead/DiscussionDialog.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0973}}<syntaxhighlight lang="lua">Controls.DenounceConfirmYes:RegisterCallback( Mouse.eLClick, OnDenonceConfirmYes );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|EndGameMenu.lua}}<br />
:<code>UI/InGame/Popups/EndGameMenu.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0227}}<syntaxhighlight lang="lua">Controls.GameOverButton:RegisterCallback( Mouse.eLClick, OnGameOver );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|EspionageOverview.lua (G&K)}}<br />
:<code>DLC/Expansion/UI/InGame/Popups/EspionageOverview.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0314}}<syntaxhighlight lang="lua">Controls.CancelButton:RegisterCallback(Mouse.eLClick, function() Refresh(); end);</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0733}}<syntaxhighlight lang="lua">agentEntry.StageCoupButton:RegisterCallback(Mouse.eLClick, OnCoupClicked);</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|GPList.lua}}<br />
:<code>UI/InGame/GPList.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0281}}<syntaxhighlight lang="lua">Controls.EngineerToggle:RegisterCallback( Mouse.eLClick, OnEngineerToggle );</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0379}}<syntaxhighlight lang="lua">Controls.SortCity:RegisterCallback( Mouse.eLClick, OnSort );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|HappinessInfo.lua}}<br />
:<code>UI/InGame/Popups/HappinessInfo.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0127}}<syntaxhighlight lang="lua">Controls.ResourcesImportedToggle:RegisterCallback( Mouse.eLClick, OnResourcesImportedToggle );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|HappinessInfo.lua (G&K)}}<br />
:<code>DLC/Expansion/UI/InGame/Popups/HappinessInfo.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0077}}<syntaxhighlight lang="lua">Controls.LocalCityToggle:RegisterCallback( Mouse.eLClick, OnLocalCityToggle );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|InGame.lua}}<br />
:<code>UI/InGame/InGame.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|1048}}<syntaxhighlight lang="lua">Controls.ScrollTop:RegisterCallback( Mouse.eMouseExit, ScrollMouseExit );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|InstalledPanel.lua}}<br />
:<code>UI/FrontEnd/Modding/InstalledPanel.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0302}}<syntaxhighlight lang="lua">listing.Button:RegisterCallback(Mouse.eMouseEnter, OnListingMouseEnter);</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|Lobby.lua}}<br />
:<code>UI/FrontEnd/Multiplayer/Lobby.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0363}}<syntaxhighlight lang="lua">controlTable.Button:RegisterCallback( Mouse.eLClick, SelectGame );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|MainMenu.lua}}<br />
:<code>UI/FrontEnd/MainMenu.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0066}}<syntaxhighlight lang="lua">Controls.ModsButton:RegisterCallback( Mouse.eLClick, ModsButtonClick );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|ModsBrowser.lua}}<br />
:<code>UI/FrontEnd/Modding/ModsBrowser.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0036}}<syntaxhighlight lang="lua">Controls.BackButton:RegisterCallback(Mouse.eLClick, NavigateBack);</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|MPGameOptions.lua}}<br />
:<code>UI/FrontEnd/Multiplayer/GameSetup/MPGameOptions.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0829}}<syntaxhighlight lang="lua">controlTable.Button:RegisterCallback(Mouse.eLClick, function()</syntaxhighlight><br />
{{CodeLine5|0830}}<syntaxhighlight lang="lua">dropDownButton:SetText(possibleValue.Name);</syntaxhighlight><br />
{{CodeLine5|0831}}<syntaxhighlight lang="lua">dropDownButton:SetToolTipString(possibleValue.ToolTip);</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0833}}<syntaxhighlight lang="lua">PreGame.SetMapOption(option.ID, possibleValue.Value);</syntaxhighlight><br />
{{CodeLine5|0834}}<syntaxhighlight lang="lua">SendGameOptionChanged();</syntaxhighlight><br />
{{CodeLine5|0835}}<syntaxhighlight lang="lua">end);</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|NotificationPanel.lua}}<br />
:<code>UI/InGame/WorldView/NotificationPanel.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0043}}<syntaxhighlight lang="lua">Controls[ "ProductionButton" ]:RegisterCallback( Mouse.eLClick, GenericLeftClick );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|NotificationPanel.lua (G&K)}}<br />
:<code>DLC/Expansion/UI/InGame/WorldView/NotificationPanel.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0043}}<syntaxhighlight lang="lua">Controls["StealTechButton"]:RegisterCallback(Mouse.eLClick, GenericLeftClick);</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|ReligionOverview.lua (G&K)}}<br />
:<code>DLC/Expansion/UI/InGame/Popups/ReligionOverview.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0212}}<syntaxhighlight lang="lua">Controls.TabButtonYourReligion:RegisterCallback( Mouse.eLClick, function() TabSelect("YourReligion"); end);</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|SetCivNames.lua}}<br />
:<code>UI/FrontEnd/GameSetup/SetCivNames.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0172}}<syntaxhighlight lang="lua">Controls.EditCivAdjective:RegisterCallback(Validate);</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|SinglePlayer.lua}}<br />
:<code>UI/FrontEnd/SinglePlayer.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0133}}<syntaxhighlight lang="lua">Controls.ScenariosButton:RegisterCallback( Mouse.eLClick, ScenariosClicked );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|StagingRoom.lua}}<br />
:<code>UI/FrontEnd/Multiplayer/StagingRoom.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0062}}<syntaxhighlight lang="lua">Controls.InviteButton:RegisterCallback( Mouse.eLClick, OnInviteButton );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|TerrainPanel.lua}}<br />
:<code>UI/InGame/TerrainPanel.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0093}}<syntaxhighlight lang="lua">Controls.WaterGradientScale_ButtonUp:RegisterCallback( Mouse.eLClick, IncWaterGradientScale );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|TradeLogic.lua}}<br />
:<code>UI/InGame/WorldView/TradeLogic.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0838}}<syntaxhighlight lang="lua">Controls.ProposeButton:RegisterCallback( Mouse.eLClick, OnPropose );</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|2078}}<syntaxhighlight lang="lua">Controls.ThemPocketOpenBorders:RegisterCallback( Mouse.eLClick, PocketOpenBordersHandler );</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|2171}}<syntaxhighlight lang="lua">Controls.UsTableResearchAgreement:RegisterCallback( Mouse.eLClick, TableResearchAgreementHandler );</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|2473}}<syntaxhighlight lang="lua">instance.Button:RegisterCallback( Mouse.eLClick, OnChooseCity );</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|2675}}<syntaxhighlight lang="lua">Controls.UsPocketLeaderClose:RegisterCallback( Mouse.eLClick, LeaderClose );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|VictoryProgress.lua}}<br />
:<code>UI/InGame/Popups/VictoryProgress.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0132}}<syntaxhighlight lang="lua">Controls.SpaceRaceClose:RegisterCallback( Mouse.eLClick, OnSpaceRaceClose );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|WorldPicker.lua}}<br />
:<code>UI/FrontEnd/WorldPicker.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0022}}<syntaxhighlight lang="lua">Controls.TinyWorldSizeButton:RegisterCallback( eLClick, TinyWorldSizeButtonClick );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
<br />
<br />
{{Civ5 API Footer}}<br />
[[Category:Civ5 Methods and Functions|RegisterCallback]]</div>
DonQuich