GetHelpTextForImprovement (Civ5 API)

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

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

Usage

string GetHelpTextForImprovement(ImprovementType improvement, bool excludeName, bool excludeHeader, bool noMaintenance)

Returned Value

No description available.

Parameters

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

Source code samples

UniqueBonuses.lua

UI/FrontEnd/GameSetup/UniqueBonuses.lua

0076	thisButton:SetToolTipString( Locale.ConvertTextKey(GetHelpTextForImprovement(thisImprovmentInfo.ID, false, false, 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.