https://modiki.civfanatics.com/index.php?action=history&feed=atom&title=IconHookup_%28Civ5_API%29
IconHookup (Civ5 API) - Revision history
2026-06-30T11:46:54Z
Revision history for this page on the wiki
MediaWiki 1.43.1
https://modiki.civfanatics.com/index.php?title=IconHookup_(Civ5_API)&diff=10405&oldid=prev
DonQuich: Bot update
2012-09-19T16:50:01Z
<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 function is a global function. Use: <code>include("IconSupport.lua")</code><br />
}}<br />
<br />
<br />
=Usage=<br />
<code>'''bool''' IconHookup<b>(</b>'''int''' offset, '''float''' iconSize, '''string''' atlas, {{Type5|Image}} imageControl, '''unknown''' debugPrint = nil<b>)</b></code><br />
<br />
<br />
'''Returned Value'''<br />
:No description available.<br />
'''Parameters'''<br />
:{|<br />
|-<br />
|valign="top" style="padding-right:6px;"|offset:<br />
|valign="top"| ''No description available.''<br />
|-<br />
|valign="top" style="padding-right:6px;"|iconSize:<br />
|valign="top"| ''No description available.''<br />
|-<br />
|valign="top" style="padding-right:6px;"|atlas:<br />
|valign="top"| ''No description available.''<br />
|-<br />
|valign="top" style="padding-right:6px;"|imageControl:<br />
|valign="top"| ''No description available.''<br />
|-<br />
|valign="top" style="padding-right:6px;"|debugPrint:<br />
|valign="top"| ''No description available.''<br />
|}<br />
<br />
<br />
=Source code samples=<br />
''Too many occurences. Only 50 out of 457 are listed.''<br />
<br />
{{PseudoH4|AdvancedSetup.lua}}<br />
:<code>UI/FrontEnd/GameSetup/AdvancedSetup.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0315}}<syntaxhighlight lang="lua">IconHookup( 22, 64, "LEADER_ATLAS", controlTable.Portrait );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|ChangePassword.lua}}<br />
:<code>UI/InGame/ChangePassword.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0116}}<syntaxhighlight lang="lua">IconHookup( civ.PortraitIndex, 128, civ.IconAtlas, Controls.Icon );</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|0033}}<syntaxhighlight lang="lua">IconHookup( info.PortraitIndex, 64, info.IconAtlas, controlTable.Icon64 );</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|0466}}<syntaxhighlight lang="lua">IconHookup(portraitIndex, 80, iconAtlas, Controls.ReligionIcon);</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|CityBannerManager.lua}}<br />
:<code>UI/InGame/CityBannerManager.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0360}}<syntaxhighlight lang="lua">if IconHookup( thisUnitInfo.PortraitIndex, 45, thisUnitInfo.IconAtlas, controls.CityBannerProductionImage ) then</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0367}}<syntaxhighlight lang="lua">if IconHookup( thisBuildingInfo.PortraitIndex, 45, thisBuildingInfo.IconAtlas, controls.CityBannerProductionImage ) then</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0418}}<syntaxhighlight lang="lua">IconHookup( civInfo.PortraitIndex, 32, civInfo.AlphaIconAtlas, controls.StatusIcon );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|CityBannerManager.lua (G&K)}}<br />
:<code>DLC/Expansion/UI/InGame/CityBannerManager.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0203}}<syntaxhighlight lang="lua">IconHookup( religion.PortraitIndex, 32, religion.IconAtlas, controls.ReligiousIcon );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|CityList.lua}}<br />
:<code>UI/InGame/CityList.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0403}}<syntaxhighlight lang="lua">if IconHookup( thisProjectInfo.PortraitIndex, g_iPortraitSize, thisProjectInfo.IconAtlas, instance.ProdImage ) then</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|CityStateStatusHelper.lua (G&K)}}<br />
:<code>DLC/Expansion/UI/CityStateStatusHelper.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0134}}<syntaxhighlight lang="lua">IconHookup(kBarIconNeutralIndex, size, kBarIconAtlas, barMarkerCtrl);</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|CityView.lua}}<br />
:<code>UI/InGame/CityView/CityView.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0325}}<syntaxhighlight lang="lua">if IconHookup( building.PortraitIndex, 64, building.IconAtlas, controlTable.BuildingImage ) then</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0588}}<syntaxhighlight lang="lua">IconHookup( thisBuildingInfo.PortraitIndex, 45, thisBuildingInfo.IconAtlas, Controls[controlImage] );</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0607}}<syntaxhighlight lang="lua">IconHookup( thisProcessInfo.PortraitIndex, 45, thisProcessInfo.IconAtlas, Controls[controlImage] );</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0885}}<syntaxhighlight lang="lua">if IconHookup( thisProcessInfo.PortraitIndex, g_iPortraitSize, thisProcessInfo.IconAtlas, Controls.ProductionPortrait ) then</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|1760}}<syntaxhighlight lang="lua">IconHookup( 0, 45, "CITIZEN_ATLAS", controlTable.PlotButtonImage);</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|1772}}<syntaxhighlight lang="lua">IconHookup( 12, 45, "CITIZEN_ATLAS", controlTable.PlotButtonImage);</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|CivilopediaScreen.lua}}<br />
:<code>UI/Civilopedia/CivilopediaScreen.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|1375}}<syntaxhighlight lang="lua">if IconHookup( portraitIndex, portraitSize, portraitAtlas, Controls.Portrait ) then</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|1618}}<syntaxhighlight lang="lua">if IconHookup( 44, portraitSize, "UNIT_ATLAS_2", Controls.Portrait ) then</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|2937}}<syntaxhighlight lang="lua">if not IconHookup( thisBuildingInfo.PortraitIndex, buttonSize, thisBuildingInfo.IconAtlas, thisBuildingInstance.RequiredBuildingImage ) then</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|3264}}<syntaxhighlight lang="lua">if IconHookup( thisPolicy.PortraitIndex, portraitSize, thisPolicy.IconAtlas, Controls.Portrait ) then</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|3467}}<syntaxhighlight lang="lua">if IconHookup( thisCiv.PortraitIndex, portraitSize, thisCiv.IconAtlas, Controls.Portrait ) then</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|3575}}<syntaxhighlight lang="lua">if not IconHookup( thisImprovement.PortraitIndex, buttonSize, thisImprovement.IconAtlas, thisImprovementInstance.UniqueImprovementImage ) then</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|3867}}<syntaxhighlight lang="lua">if IconHookup( thisTerrain.PortraitIndex, portraitSize, thisTerrain.IconAtlas, Controls.Portrait ) then</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|DiploList.lua}}<br />
:<code>UI/InGame/DiploList.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0278}}<syntaxhighlight lang="lua">IconHookup( otherLeaderInfo.PortraitIndex, 64, otherLeaderInfo.IconAtlas, controlTable.LeaderPortrait );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|EnemyUnitPanel.lua}}<br />
:<code>UI/InGame/WorldView/EnemyUnitPanel.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0079}}<syntaxhighlight lang="lua">IconHookup( 0, g_iPortraitSize, "ENEMY_CITY_ATLAS", Controls.UnitPortrait );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|FoRScenarioLoadScreen.lua (G&K)}}<br />
:<code>DLC/Expansion/Scenarios/FallOfRomeScenario/FoRScenarioLoadScreen.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0259}}<syntaxhighlight lang="lua">IconHookup( civ.PortraitIndex, 64, civ.IconAtlas, Controls.IconShadow );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|GameMenu.lua}}<br />
:<code>UI/InGame/Menus/GameMenu.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0271}}<syntaxhighlight lang="lua">IconHookup( 4, 64, "WORLDTYPE_ATLAS", Controls.TypeIcon);</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0278}}<syntaxhighlight lang="lua">IconHookup( info.PortraitIndex, 64, info.IconAtlas, Controls.SizeIcon );</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0281}}<syntaxhighlight lang="lua">IconHookup( 6, 64, "WORLDSIZE_ATLAS", Controls.SizeIcon );</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0288}}<syntaxhighlight lang="lua">IconHookup( info.PortraitIndex, 64, info.IconAtlas, Controls.DifficultyIcon );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|GameSetupScreen.lua}}<br />
:<code>UI/FrontEnd/GameSetup/GameSetupScreen.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0274}}<syntaxhighlight lang="lua">IconHookup( mapScript.IconIndex or 0, 128, mapScript.IconAtlas, Controls.TypeIcon );</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0387}}<syntaxhighlight lang="lua">IconHookup(3, 128, "WORLDTYPE_ATLAS", Controls.TypeIcon);</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0493}}<syntaxhighlight lang="lua">IconHookup( 22, 128, "LEADER_ATLAS", Controls.Portrait );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|HallOfFame.lua}}<br />
:<code>UI/InGame/Popups/HallOfFame.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0049}}<syntaxhighlight lang="lua">IconHookup( leader.PortraitIndex, 64, leader.IconAtlas, controlTable.LeaderPortrait );</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0063}}<syntaxhighlight lang="lua">IconHookup( info.PortraitIndex, 32, info.IconAtlas, controlTable.Difficulty );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|IconSupport.lua}}<br />
:<code>UI/IconSupport.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0245}}<syntaxhighlight lang="lua">IconHookup( 23, iconSize, "CIV_COLOR_ATLAS", iconControl );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|LoadMenu.lua}}<br />
:<code>UI/FrontEnd/LoadMenu.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0356}}<syntaxhighlight lang="lua">IconHookup(4, 64, "WORLDTYPE_ATLAS", Controls.MapType);</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|MongolScenarioLoadScreen.lua - DLC_01 DLC}}<br />
:<code>DLC/DLC_01/Scenarios/Mongol Scenario/MongolScenarioLoadScreen.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0115}}<syntaxhighlight lang="lua">IconHookup( civ.PortraitIndex, 80, civ.IconAtlas, Controls.IconShadow );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|NotificationPanel.lua}}<br />
:<code>UI/InGame/WorldView/NotificationPanel.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0196}}<syntaxhighlight lang="lua">IconHookup( portraitIndex, 80, GameInfo.Buildings[iGameValue].IconAtlas, instance.WonderConstructedAlphaAnim );</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0227}}<syntaxhighlight lang="lua">IconHookup( portraitIndex, 80, thisResourceInfo.IconAtlas, instance.ResourceImage );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|ProductionPopup.lua}}<br />
:<code>UI/InGame/Popups/ProductionPopup.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0571}}<syntaxhighlight lang="lua">if IconHookup( thisProjectInfo.PortraitIndex, 128, thisProjectInfo.IconAtlas, Controls.ProductionPortrait ) then</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|0541}}<syntaxhighlight lang="lua">IconHookup(v.FounderIconIndex, 45, v.FounderIconAtlas, entry.FounderIcon);</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0629}}<syntaxhighlight lang="lua">IconHookup(v.ReligionIconIndex, 48, v.ReligionIconAtlas, beliefEntry.BeliefReligionIcon);</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|SocialPolicyPopup.lua}}<br />
:<code>UI/InGame/Popups/SocialPolicyPopup.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0472}}<syntaxhighlight lang="lua">IconHookup( policyInfo.PortraitIndex, 64, policyInfo.IconAtlas, thisPolicyIcon.PolicyImage );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|TechButtonInclude.lua}}<br />
:<code>UI/InGame/TechTree/TechButtonInclude.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0161}}<syntaxhighlight lang="lua">IconHookup( row.PortraitIndex, textureSize, row.IconAtlas, thisButton );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|TechPopup.lua}}<br />
:<code>UI/InGame/TechPopup.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0231}}<syntaxhighlight lang="lua">if IconHookup( tech.PortraitIndex, 64, tech.IconAtlas, thisTechButtonInstance.TechPortrait ) then</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|UnitPanel.lua}}<br />
:<code>UI/InGame/WorldView/UnitPanel.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0122}}<syntaxhighlight lang="lua">IconHookup(iconIndex, actionIconSize, iconAtlas, icon);</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0584}}<syntaxhighlight lang="lua">IconHookup( civPortraitIndex, 128, civInfo.IconAtlas, Controls.BackgroundCivSymbol );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|VictoryProgress.lua}}<br />
:<code>UI/InGame/Popups/VictoryProgress.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0841}}<syntaxhighlight lang="lua">IconHookup( leader.PortraitIndex, iconSize, leader.IconAtlas, controlTable );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|VictoryStatus.lua (G&K)}}<br />
:<code>DLC/Expansion/Scenarios/SteampunkScenario/VictoryStatus.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0127}}<syntaxhighlight lang="lua">IconHookup( tLeader.PortraitIndex, 64, tLeader.IconAtlas, gtTokenUI[s].Portrait );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
<br />
<br />
{{Civ5 API Footer}}<br />
[[Category:Civ5 Methods and Functions|IconHookup]]</div>
DonQuich