Player.GetUnitByID (Civ5 API)

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

This function is a member of Player. This is an instance method, invoke it with a colon.

Usage

Unit Player:GetUnitByID(UnitID unit)

Returned Value

Unit object

Parameters

unit:

unit ID

Source code samples

Redundant occurences have been removed.

BarbarianRansomPopup.lua

UI/InGame/PopupsGeneric/BarbarianRansomPopup.lua

0008	local pUnit = pPlayer:GetUnitByID(iUnitID);

CityBannerManager.lua

UI/InGame/CityBannerManager.lua

1142	local unit = player:GetUnitByID( unitID );

ConfirmGiftPopup.lua

UI/InGame/PopupsGeneric/ConfirmGiftPopup.lua

0017	pUnit = pGiftingPlayer:GetUnitByID(iUnitIndex);

TurnsRemaining.lua - DLC_02 DLC

DLC/DLC_02/Scenarios/NewWorldScenario/TurnsRemaining.lua

0134	local unit = player:GetUnitByID(iUnitID);

TurnsRemaining.lua (G&K)

DLC/Expansion/Scenarios/FallOfRomeScenario/TurnsRemaining.lua

1023	pUnit = Players[iPlayer]:GetUnitByID(iUnitID);

UnitFlagManager.lua

UI/InGame/UnitFlagManager.lua

0078	local pUnit = Players[ playerID ]:GetUnitByID( unitID );
0306	local unit = Players[ self.m_PlayerID ]:GetUnitByID( self.m_UnitID );
0372	local pUnit = Players[ self.m_PlayerID ]:GetUnitByID( self.m_UnitID );
0884	Players[ playerID ]:GetUnitByID( unitID ) == nil or
0885	Players[ playerID ]:GetUnitByID( unitID ):IsDead() )
0973	local thisUnit = Players[ playerID ]:GetUnitByID( unitID );
1578	local pUnit = pPlayer:GetUnitByID( unitID );

UnitMemberOverlay.lua

UI/InGame/UnitMemberOverlay.lua

0251	local unit = playerUnitList:GetUnitByID( unitID );
0539	local unit = playersUnitList:GetUnitByID( unitID );

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.