SimpleCivIconHookup (Civ5 API)

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

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

Usage

bool SimpleCivIconHookup(PlayerID player, int iconSize, Image iconControl)

Returned Value

No description available.

Parameters

player:	No description available.
iconSize:	No description available.
iconControl:	No description available.

Source code samples

Redundant occurences have been removed.

AdvancedSetup.lua

UI/FrontEnd/GameSetup/AdvancedSetup.lua

0316	SimpleCivIconHookup(-1, 64, controlTable.Icon);
0377	SimpleCivIconHookup(-1, 64, Controls.Icon);

GameSetupScreen.lua

UI/FrontEnd/GameSetup/GameSetupScreen.lua

0469	SimpleCivIconHookup( 0, 64, Controls.IconShadow );

LoadScreen.lua

UI/FrontEnd/LoadScreen.lua

0063	SimpleCivIconHookup( Game.GetActivePlayer(), 80, Controls.IconShadow );

StagingRoom.lua

UI/FrontEnd/Multiplayer/StagingRoom.lua

0334	SimpleCivIconHookup( playerID, 64, slotInstance.Icon);
0343	SimpleCivIconHookup(-1, 64, slotInstance.Icon);
0515	SimpleCivIconHookup( Matchmaking.GetLocalID(), 64, Controls.Icon);

VictoryProgress.lua

UI/InGame/Popups/VictoryProgress.lua

0479	SimpleCivIconHookup( Game.GetActivePlayer(), 64, Controls.Icon );

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.