https://modiki.civfanatics.com/index.php?action=history&feed=atom&title=GetHelpTextForBuilding_%28Civ5_API%29 GetHelpTextForBuilding (Civ5 API) - Revision history 2026-04-19T14:48:32Z Revision history for this page on the wiki MediaWiki 1.43.1 https://modiki.civfanatics.com/index.php?title=GetHelpTextForBuilding_(Civ5_API)&diff=10409&oldid=prev DonQuich: Bot update 2012-09-19T16:50:57Z <p>Bot update</p> <p><b>New page</b></p><div>{{Civ5 API Beta Banner}}<br /> &#039;&#039;This page is a part of the [[Lua and UI Reference (Civ5)]].&#039;&#039;&lt;br/&gt;<br /> <br /> <br /> <br /> {{TypeInfos5|Function.png|This function is a global function. Use: &lt;code&gt;include(&quot;InfoTooltipInclude.lua&quot;)&lt;/code&gt;<br /> }}<br /> <br /> <br /> =Usage=<br /> &lt;code&gt;&#039;&#039;&#039;string&#039;&#039;&#039; GetHelpTextForBuilding&lt;b&gt;(&lt;/b&gt;{{Type5|BuildingType}} building, &#039;&#039;&#039;bool&#039;&#039;&#039; excludeName, &#039;&#039;&#039;bool&#039;&#039;&#039; excludeHeader, &#039;&#039;&#039;bool&#039;&#039;&#039; noMaintenance&lt;b&gt;)&lt;/b&gt;&lt;/code&gt;<br /> <br /> <br /> &#039;&#039;&#039;Returned Value&#039;&#039;&#039;<br /> :No description available.<br /> &#039;&#039;&#039;Parameters&#039;&#039;&#039;<br /> :{|<br /> |-<br /> |valign=&quot;top&quot; style=&quot;padding-right:6px;&quot;|building:<br /> |valign=&quot;top&quot;| &#039;&#039;No description available.&#039;&#039;<br /> |-<br /> |valign=&quot;top&quot; style=&quot;padding-right:6px;&quot;|excludeName:<br /> |valign=&quot;top&quot;| &#039;&#039;No description available.&#039;&#039;<br /> |-<br /> |valign=&quot;top&quot; style=&quot;padding-right:6px;&quot;|excludeHeader:<br /> |valign=&quot;top&quot;| &#039;&#039;No description available.&#039;&#039;<br /> |-<br /> |valign=&quot;top&quot; style=&quot;padding-right:6px;&quot;|noMaintenance:<br /> |valign=&quot;top&quot;| &#039;&#039;No description available.&#039;&#039;<br /> |}<br /> <br /> <br /> =Source code samples=<br /> &#039;&#039;Redundant occurences have been removed.&#039;&#039;<br /> <br /> {{PseudoH4|CityView.lua}}<br /> :&lt;code&gt;UI/InGame/CityView/CityView.lua&lt;/code&gt;<br /> :{{CodeBegin5}}<br /> {{CodeLine5|0483}}&lt;syntaxhighlight lang=&quot;lua&quot;&gt;local strToolTip = GetHelpTextForBuilding(buildingID, bExcludeName, bExcludeHeader, bNoMaintenance);&lt;/syntaxhighlight&gt;<br /> {{CodeBreak5}}<br /> {{CodeLine5|0866}}&lt;syntaxhighlight lang=&quot;lua&quot;&gt;szHelpText = GetHelpTextForBuilding(buildingProduction, bExcludeName, bExcludeHeader, false);&lt;/syntaxhighlight&gt;<br /> {{CodeEnd5}}<br /> <br /> <br /> {{PseudoH4|CityView.lua (G&amp;K)}}<br /> :&lt;code&gt;DLC/Expansion/UI/InGame/CityView/CityView.lua&lt;/code&gt;<br /> :{{CodeBegin5}}<br /> {{CodeLine5|0487}}&lt;syntaxhighlight lang=&quot;lua&quot;&gt;local strToolTip = GetHelpTextForBuilding(buildingID, bExcludeName, bExcludeHeader, bNoMaintenance, pCity);&lt;/syntaxhighlight&gt;<br /> {{CodeBreak5}}<br /> {{CodeLine5|0875}}&lt;syntaxhighlight lang=&quot;lua&quot;&gt;szHelpText = GetHelpTextForBuilding(buildingProduction, bExcludeName, bExcludeHeader, false, pCity);&lt;/syntaxhighlight&gt;<br /> {{CodeEnd5}}<br /> <br /> <br /> {{PseudoH4|ProductionPopup.lua}}<br /> :&lt;code&gt;UI/InGame/Popups/ProductionPopup.lua&lt;/code&gt;<br /> :{{CodeBegin5}}<br /> {{CodeLine5|0563}}&lt;syntaxhighlight lang=&quot;lua&quot;&gt;strToolTip = Locale.ConvertTextKey(GetHelpTextForBuilding(buildingProduction, false, false, false)) .. &quot;[NEWLINE][NEWLINE]&quot; .. strToolTip;&lt;/syntaxhighlight&gt;<br /> {{CodeBreak5}}<br /> {{CodeLine5|0976}}&lt;syntaxhighlight lang=&quot;lua&quot;&gt;strToolTip = GetHelpTextForBuilding(id, bExcludeName, bExcludeHeader, false);&lt;/syntaxhighlight&gt;<br /> {{CodeEnd5}}<br /> <br /> <br /> {{PseudoH4|ProductionPopup.lua (G&amp;K)}}<br /> :&lt;code&gt;DLC/Expansion/UI/InGame/Popups/ProductionPopup.lua&lt;/code&gt;<br /> :{{CodeBegin5}}<br /> {{CodeLine5|0651}}&lt;syntaxhighlight lang=&quot;lua&quot;&gt;strToolTip = Locale.ConvertTextKey(GetHelpTextForBuilding(buildingProduction, false, false, false, city)) .. &quot;[NEWLINE][NEWLINE]&quot; .. strToolTip;&lt;/syntaxhighlight&gt;<br /> {{CodeBreak5}}<br /> {{CodeLine5|1068}}&lt;syntaxhighlight lang=&quot;lua&quot;&gt;strToolTip = GetHelpTextForBuilding(id, bExcludeName, bExcludeHeader, false, pCity);&lt;/syntaxhighlight&gt;<br /> {{CodeEnd5}}<br /> <br /> <br /> {{PseudoH4|TechButtonInclude.lua}}<br /> :&lt;code&gt;UI/InGame/TechTree/TechButtonInclude.lua&lt;/code&gt;<br /> :{{CodeBegin5}}<br /> {{CodeLine5|0368}}&lt;syntaxhighlight lang=&quot;lua&quot;&gt;thisButton:SetToolTipString( GetHelpTextForBuilding(thisBuildingInfo.ID, bExcludeName, bExcludeHeader, false) );&lt;/syntaxhighlight&gt;<br /> {{CodeEnd5}}<br /> <br /> <br /> {{PseudoH4|TechButtonInclude.lua (G&amp;K)}}<br /> :&lt;code&gt;DLC/Expansion/UI/InGame/TechTree/TechButtonInclude.lua&lt;/code&gt;<br /> :{{CodeBegin5}}<br /> {{CodeLine5|0413}}&lt;syntaxhighlight lang=&quot;lua&quot;&gt;thisButton:SetToolTipString( GetHelpTextForBuilding(thisBuildingInfo.ID, bExcludeName, bExcludeHeader, false, nil) );&lt;/syntaxhighlight&gt;<br /> {{CodeEnd5}}<br /> <br /> <br /> {{PseudoH4|UniqueBonuses.lua}}<br /> :&lt;code&gt;UI/FrontEnd/GameSetup/UniqueBonuses.lua&lt;/code&gt;<br /> :{{CodeBegin5}}<br /> {{CodeLine5|0048}}&lt;syntaxhighlight lang=&quot;lua&quot;&gt;thisButton:SetToolTipString( Locale.ConvertTextKey(GetHelpTextForBuilding(thisBuildingInfo.ID, false, false, false)));&lt;/syntaxhighlight&gt;<br /> {{CodeEnd5}}<br /> <br /> <br /> {{PseudoH4|WonderPopup.lua}}<br /> :&lt;code&gt;UI/InGame/Popups/WonderPopup.lua&lt;/code&gt;<br /> :{{CodeBegin5}}<br /> {{CodeLine5|0079}}&lt;syntaxhighlight lang=&quot;lua&quot;&gt;strGameInfo = GetHelpTextForBuilding(iBuildingID, bExcludeName, bExcludeHeader, false);&lt;/syntaxhighlight&gt;<br /> {{CodeEnd5}}<br /> <br /> <br /> <br /> <br /> {{Civ5 API Footer}}<br /> [[Category:Civ5 Methods and Functions|GetHelpTextForBuilding]]<br /> [[Category:Civ5 Buildings API|GetHelpTextForBuilding]]</div> DonQuich