https://modiki.civfanatics.com/index.php?action=history&feed=atom&title=UIElement.SetToolTipString_%28Civ5_API%29
UIElement.SetToolTipString (Civ5 API) - Revision history
2026-04-21T09:43:10Z
Revision history for this page on the wiki
MediaWiki 1.43.1
https://modiki.civfanatics.com/index.php?title=UIElement.SetToolTipString_(Civ5_API)&diff=13553&oldid=prev
DonQuich: Bot update
2012-09-20T14:32:35Z
<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 '''ControlBase'''.<br/><br />
This is an instance method, invoke it with a colon.<br />
}}<br />
<br />
<br />
=Usage=<br />
<code>'''void''' UIElement:SetToolTipString<b>(</b>'''string''' foodToolTip<b>)</b></code><br />
<br />
<br />
'''Parameters'''<br />
:{|<br />
|-<br />
|valign="top" style="padding-right:6px;"|foodToolTip:<br />
|valign="top"| ''No description available.''<br />
|}<br />
<br />
<br />
=Source code samples=<br />
''Too many occurences. Only 50 out of 751 are listed.''<br />
<br />
{{PseudoH4|AdvancedSetup.lua}}<br />
:<code>UI/FrontEnd/GameSetup/AdvancedSetup.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0117}}<syntaxhighlight lang="lua">dropDownButton:SetToolTipString(possibleValue.ToolTip);</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|1109}}<syntaxhighlight lang="lua">Controls.StartButton:SetToolTipString(nil);</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|ChooseFaithGreatPerson.lua (G&K)}}<br />
:<code>DLC/Expansion/UI/InGame/Popups/ChooseFaithGreatPerson.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0044}}<syntaxhighlight lang="lua">controlTable.Button:SetToolTipString(Locale.ConvertTextKey("TXT_KEY_NO_SCIENTIST_FROM_FAITH"));</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|ChooseReligionPopup.lua (G&K)}}<br />
:<code>DLC/Expansion/UI/InGame/Popups/ChooseReligionPopup.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0308}}<syntaxhighlight lang="lua">religionButton.Button:SetToolTipString(t);</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|CityBannerManager.lua}}<br />
:<code>UI/InGame/CityBannerManager.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0217}}<syntaxhighlight lang="lua">controls.OccupiedIcon:SetToolTipString(Locale.ConvertTextKey( "TXT_KEY_CITY_OCCUPIED"));</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0344}}<syntaxhighlight lang="lua">controls.CityBannerLeftBackground:SetToolTipString(tooltipString);</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0515}}<syntaxhighlight lang="lua">controls.BannerButton:SetToolTipString(Locale.ConvertTextKey("TXT_KEY_HAVENT_MET"));</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|CityStateDiploPopup.lua (G&K)}}<br />
:<code>DLC/Expansion/UI/InGame/Popups/CityStateDiploPopup.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0278}}<syntaxhighlight lang="lua">Controls.AllyIcon:SetToolTipString(strAllyTT);</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0540}}<syntaxhighlight lang="lua">Controls.RevokePledgeButton:SetToolTipString(strRevokeProtectTT);</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0999}}<syntaxhighlight lang="lua">Controls.UnitTributeButton:SetToolTipString(ttText);</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|CityView.lua}}<br />
:<code>UI/InGame/CityView/CityView.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0426}}<syntaxhighlight lang="lua">controlTable.BuildingFilledSpecialistSlot3:SetToolTipString(ToolTipString);</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0786}}<syntaxhighlight lang="lua">Controls.ProductionButton:SetToolTipString( Locale.ConvertTextKey( "TXT_KEY_CITYVIEW_QUEUE_PROD_TT") );</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|1333}}<syntaxhighlight lang="lua">Controls.RazeCityButton:SetToolTipString( Locale.ConvertTextKey( "TXT_KEY_CITYVIEW_RAZE_BUTTON_TT" ) );</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|1773}}<syntaxhighlight lang="lua">controlTable.PlotButtonImage:SetToolTipString( Locale.ConvertTextKey("TXT_KEY_CITYVIEW_NUTHA_CITY_TILE") );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|CivilopediaScreen.lua}}<br />
:<code>UI/Civilopedia/CivilopediaScreen.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|2087}}<syntaxhighlight lang="lua">thisBuildingInstance.UnlockedBuildingButton:SetToolTipString( Locale.ConvertTextKey( thisBuildingInfo.Description ) );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|Demographics.lua}}<br />
:<code>UI/InGame/Popups/Demographics.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0171}}<syntaxhighlight lang="lua">instance.BestTT:SetToolTipString( Locale.ConvertTextKey("TXT_KEY_DEMOGRAPHICS_FOOD_MEASURE") );</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0179}}<syntaxhighlight lang="lua">instance.WorstTT:SetToolTipString( Locale.ConvertTextKey("TXT_KEY_DEMOGRAPHICS_FOOD_MEASURE") );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|DiploList.lua}}<br />
:<code>UI/InGame/DiploList.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0443}}<syntaxhighlight lang="lua">controlTable.MinorButton:SetToolTipString(Locale.ConvertTextKey("TXT_KEY_ALWAYS_WAR_TT"));</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|DiploRelationships.lua}}<br />
:<code>UI/InGame/Popups/DiploRelationships.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0486}}<syntaxhighlight lang="lua">pStack.StatusMeter:SetToolTipString(strStatusTT);</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0547}}<syntaxhighlight lang="lua">pStack.AllyLabel:SetToolTipString(strAllyTT);</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|DiscussionDialog.lua}}<br />
:<code>UI/InGame/LeaderHead/DiscussionDialog.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0336}}<syntaxhighlight lang="lua">Controls.Button2:SetToolTipString(strButton2Tooltip);</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|EconomicGeneralInfo.lua}}<br />
:<code>UI/InGame/Popups/EconomicGeneralInfo.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0261}}<syntaxhighlight lang="lua">instance.TradeIncomeValue:SetToolTipString( strTooltip .. strPopInfo );</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|0638}}<syntaxhighlight lang="lua">agentEntry.AgentActivity:SetToolTipString(strActivityTT);</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|1199}}<syntaxhighlight lang="lua">entry.RigElectionEnabled:SetToolTipString(strCityStateTT);</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|FoRScenarioLoadScreen.lua (G&K)}}<br />
:<code>DLC/Expansion/Scenarios/FallOfRomeScenario/FoRScenarioLoadScreen.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0108}}<syntaxhighlight lang="lua">controlTable.Button:SetToolTipString(Locale.ConvertTextKey( info.Help ) );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|GameMenu.lua}}<br />
:<code>UI/InGame/Menus/GameMenu.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0218}}<syntaxhighlight lang="lua">Controls.LeaderFrame:SetToolTipString( Locale.ConvertTextKey( leaderDescription ) );</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0272}}<syntaxhighlight lang="lua">Controls.TypeFrame:SetToolTipString(Locale.ConvertTextKey("TXT_KEY_RANDOM_MAP_SCRIPT") );</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0282}}<syntaxhighlight lang="lua">Controls.SizeFrame:SetToolTipString( Locale.ConvertTextKey( "TXT_KEY_RANDOM_MAP_SIZE" ) );</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0289}}<syntaxhighlight lang="lua">Controls.DifficultyFrame:SetToolTipString( Locale.ConvertTextKey( info.Description ) );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|GameSetupScreen.lua}}<br />
:<code>UI/FrontEnd/GameSetup/GameSetupScreen.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0513}}<syntaxhighlight lang="lua">Controls[buttonName]:SetToolTipString( unknownString );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|GPList.lua}}<br />
:<code>UI/InGame/GPList.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0147}}<syntaxhighlight lang="lua">instance.GPMeter:SetToolTipString( strProgress );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|HappinessInfo.lua}}<br />
:<code>UI/InGame/Popups/HappinessInfo.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0523}}<syntaxhighlight lang="lua">Controls.PopulationUnhappiness:SetToolTipString(strTooltip);</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|LoadMenu.lua}}<br />
:<code>UI/FrontEnd/LoadMenu.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0275}}<syntaxhighlight lang="lua">Controls.CivIcon:SetToolTipString(unknownString);</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0357}}<syntaxhighlight lang="lua">Controls.MapType:SetToolTipString(name);</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|Lobby.lua}}<br />
:<code>UI/FrontEnd/Multiplayer/Lobby.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0346}}<syntaxhighlight lang="lua">controlTable.DLCHostedLabel:SetToolTipString(CreateDlcToolTip("TXT_KEY_LOBBY_REQUIRED_DLC", filteredPackages));</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|MiniMapPanel.lua}}<br />
:<code>UI/InGame/WorldView/MiniMapPanel.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0425}}<syntaxhighlight lang="lua">Controls.StrategicViewButton:SetToolTipString(sToolTip .. " (" .. keyDesc .. ")");</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|ModsBrowser.lua}}<br />
:<code>UI/FrontEnd/Modding/ModsBrowser.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0064}}<syntaxhighlight lang="lua">button:SetToolTipString(tooltip);</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|ProductionPopup.lua}}<br />
:<code>UI/InGame/Popups/ProductionPopup.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0238}}<syntaxhighlight lang="lua">Controls.Food:SetToolTipString(strFoodToolTip);</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0244}}<syntaxhighlight lang="lua">Controls.Gold:SetToolTipString(strGoldToolTip);</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|SaveMapMenu.lua}}<br />
:<code>UI/InGame/Menus/SaveMapMenu.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0247}}<syntaxhighlight lang="lua">controlTable.ButtonText:SetToolTipString(v.Description);</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|SelectMapType.lua}}<br />
:<code>UI/FrontEnd/GameSetup/SelectMapType.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0214}}<syntaxhighlight lang="lua">item.Button:SetToolTipString(v.Description);</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|TechButtonInclude.lua}}<br />
:<code>UI/InGame/TechTree/TechButtonInclude.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0222}}<syntaxhighlight lang="lua">thisButton:SetToolTipString( Locale.ConvertTextKey( "TXT_KEY_FASTER_EMBARKED_MOVEMENT" ) );</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0277}}<syntaxhighlight lang="lua">thisButton:SetToolTipString( Locale.ConvertTextKey( "TXT_KEY_ALLOWS_DEFENSIVE_PACTS" ) );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|TechButtonInclude.lua (G&K)}}<br />
:<code>DLC/Expansion/Scenarios/SteampunkScenario/TechButtonInclude.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0474}}<syntaxhighlight lang="lua">thisButton:SetToolTipString( Locale.ConvertTextKey("TXT_KEY_REVEALS_RESOURCE_ON_MAP", resourceName));</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|TradeLogic.lua}}<br />
:<code>UI/InGame/WorldView/TradeLogic.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|1094}}<syntaxhighlight lang="lua">Controls.UsPocketOpenBorders:SetToolTipString(strOurTooltip);</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|1240}}<syntaxhighlight lang="lua">Controls.ThemPocketTradeAgreement:SetToolTipString(strTooltip);</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|1454}}<syntaxhighlight lang="lua">Controls.ThemPocketLuxury:SetToolTipString( Locale.ConvertTextKey( "TXT_KEY_DIPLO_LUX_RESCR_TRADE_NO_THEM" ));</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|1687}}<syntaxhighlight lang="lua">Controls.UsTableGoldPerTurn:SetToolTipString( strTooltip );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|VictoryStatus.lua (G&K)}}<br />
:<code>DLC/Expansion/Scenarios/SteampunkScenario/VictoryStatus.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0139}}<syntaxhighlight lang="lua">gtTokenUI[s].TokenLabel:SetToolTipString(sLabelTT);</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|VoteResultsPopup.lua (G&K)}}<br />
:<code>DLC/Expansion/UI/InGame/Popups/VoteResultsPopup.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0203}}<syntaxhighlight lang="lua">controlTable.VoteCastBox:SetToolTipString(strVoteCastTT);</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
<br />
<br />
{{Civ5 API Footer}}<br />
[[Category:Civ5 Methods and Functions|SetToolTipString]]</div>
DonQuich