PreGame.GetCivilizationShortDescription (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 member of PreGame.

This is a static method, invoke it with a dot.


Usage

string PreGame.GetCivilizationShortDescription(PlayerID player)


Returned Value

No description available.

Parameters

player: No description available.


Source code samples

Redundant occurences have been removed.

AdvancedSetup.lua

UI/FrontEnd/GameSetup/AdvancedSetup.lua
0343
local civName = PreGame.GetCivilizationShortDescription(0);


DiploList.lua

UI/InGame/DiploList.lua
0230
if(PreGame.GetCivilizationShortDescription(g_iPlayer) ~= "") then
0231
TruncateString(Controls.CivName, textBoxSize, Locale.ConvertTextKey(PreGame.GetCivilizationShortDescription(g_iPlayer)));


GameMenu.lua

UI/InGame/Menus/GameMenu.lua
0210
elseif( iPlayer == Game.GetActivePlayer() and PreGame.GetCivilizationShortDescription( 0 ) ~= "" ) then
0211
Controls.CivIconFrame:SetToolTipString( PreGame.GetCivilizationShortDescription( 0 ) .. "     " .. Locale.ConvertTextKey( gameTrait.ShortDescription ) .. "[NEWLINE]" .. Locale.ConvertTextKey( gameTrait.Description ) );
0327
elseif(iPlayer == Game.GetActivePlayer() and PreGame.GetCivilizationShortDescription(0) ~= "") then
0328
TruncateString(Controls.DetailsCiv, availableTextExtent, PreGame.GetCivilizationShortDescription(0));


GameplayUtilities.lua

Gameplay/Lua/GameplayUtilities.lua
0033
local civShortDescription = PreGame.GetCivilizationShortDescription(playerID);


SetCivNames.lua

UI/FrontEnd/GameSetup/SetCivNames.lua
0225
name = PreGame.GetCivilizationShortDescription(g_EditSlot);


VictoryProgress.lua

UI/InGame/Popups/VictoryProgress.lua
0385
if(PreGame.GetCivilizationShortDescription(pPlayer:GetID()) ~= "") then
0386
strPlayer = PreGame.GetCivilizationShortDescription(pPlayer:GetID());
0865
strCiv = PreGame.GetCivilizationShortDescription(pPlayer:GetID());



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.