GetHelpTextForBuilding (Civ5 API)

From Civilization Modding Wiki
Jump to navigationJump to search

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


Function.png This function is a global function. Use: include("InfoTooltipInclude.lua")


Usage

string GetHelpTextForBuilding(BuildingType building, bool excludeName, bool excludeHeader, bool noMaintenance)


Returned Value

No description available.

Parameters

building: No description available.
excludeName: No description available.
excludeHeader: No description available.
noMaintenance: No description available.


Source code samples

Redundant occurences have been removed.

CityView.lua

UI/InGame/CityView/CityView.lua
0483
local strToolTip = GetHelpTextForBuilding(buildingID, bExcludeName, bExcludeHeader, bNoMaintenance);
0866
szHelpText = GetHelpTextForBuilding(buildingProduction, bExcludeName, bExcludeHeader, false);


CityView.lua (G&K)

DLC/Expansion/UI/InGame/CityView/CityView.lua
0487
local strToolTip = GetHelpTextForBuilding(buildingID, bExcludeName, bExcludeHeader, bNoMaintenance, pCity);
0875
szHelpText = GetHelpTextForBuilding(buildingProduction, bExcludeName, bExcludeHeader, false, pCity);


ProductionPopup.lua

UI/InGame/Popups/ProductionPopup.lua
0563
strToolTip = Locale.ConvertTextKey(GetHelpTextForBuilding(buildingProduction, false, false, false)) .. "[NEWLINE][NEWLINE]" .. strToolTip;
0976
strToolTip = GetHelpTextForBuilding(id, bExcludeName, bExcludeHeader, false);


ProductionPopup.lua (G&K)

DLC/Expansion/UI/InGame/Popups/ProductionPopup.lua
0651
strToolTip = Locale.ConvertTextKey(GetHelpTextForBuilding(buildingProduction, false, false, false, city)) .. "[NEWLINE][NEWLINE]" .. strToolTip;
1068
strToolTip = GetHelpTextForBuilding(id, bExcludeName, bExcludeHeader, false, pCity);


TechButtonInclude.lua

UI/InGame/TechTree/TechButtonInclude.lua
0368
thisButton:SetToolTipString( GetHelpTextForBuilding(thisBuildingInfo.ID, bExcludeName, bExcludeHeader, false) );


TechButtonInclude.lua (G&K)

DLC/Expansion/UI/InGame/TechTree/TechButtonInclude.lua
0413
thisButton:SetToolTipString( GetHelpTextForBuilding(thisBuildingInfo.ID, bExcludeName, bExcludeHeader, false, nil) );


UniqueBonuses.lua

UI/FrontEnd/GameSetup/UniqueBonuses.lua
0048
thisButton:SetToolTipString( Locale.ConvertTextKey(GetHelpTextForBuilding(thisBuildingInfo.ID, false, false, false)));


WonderPopup.lua

UI/InGame/Popups/WonderPopup.lua
0079
strGameInfo = GetHelpTextForBuilding(iBuildingID, bExcludeName, bExcludeHeader, false);



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.