https://modiki.civfanatics.com/index.php?action=history&feed=atom&title=TruncateString_%28Civ5_API%29
TruncateString (Civ5 API) - Revision history
2026-04-10T16:29:09Z
Revision history for this page on the wiki
MediaWiki 1.43.1
https://modiki.civfanatics.com/index.php?title=TruncateString_(Civ5_API)&diff=10371&oldid=prev
DonQuich: Bot update
2012-09-19T16:42:12Z
<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("SupportFunctions.lua")</code><br />
}}<br />
<br />
<br />
=Usage=<br />
<code>'''void''' TruncateString<b>(</b>{{Type5|Label}} control, '''int''' resultSize, '''string''' longStr, '''string''' trailingText = nil<b>)</b></code><br />
<br />
<br />
'''Parameters'''<br />
:{|<br />
|-<br />
|valign="top" style="padding-right:6px;"|control:<br />
|valign="top"| ''No description available.''<br />
|-<br />
|valign="top" style="padding-right:6px;"|resultSize:<br />
|valign="top"| ''No description available.''<br />
|-<br />
|valign="top" style="padding-right:6px;"|longStr:<br />
|valign="top"| ''No description available.''<br />
|-<br />
|valign="top" style="padding-right:6px;"|trailingText:<br />
|valign="top"| ''No description available.''<br />
|}<br />
<br />
<br />
=Source code samples=<br />
''Redundant occurences have been removed.''<br />
<br />
{{PseudoH4|CityView.lua}}<br />
:<code>UI/InGame/CityView/CityView.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0726}}<syntaxhighlight lang="lua">TruncateString(Controls.CityNameTitleBarLabel, cityNameSize, convertedKey);</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|DiploCorner.lua}}<br />
:<code>UI/InGame/WorldView/DiploCorner.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0144}}<syntaxhighlight lang="lua">TruncateString( controlTable.String, 200, Players[fromPlayer]:GetNickName() );</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0157}}<syntaxhighlight lang="lua">TruncateString( controlTable.String, 200, Players[toPlayer]:GetNickName() );</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0296}}<syntaxhighlight lang="lua">TruncateString( Controls.LengthTest, Controls.ChatPull:GetSizeX(), Locale.ConvertTextKey("TXT_KEY_DIPLO_TO_TEAM"));</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0300}}<syntaxhighlight lang="lua">TruncateString( Controls.LengthTest, Controls.ChatPull:GetSizeX(), Locale.ConvertTextKey("TXT_KEY_DIPLO_TO_PLAYER", Players[ iPlayer ]:GetNickName()));</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0356}}<syntaxhighlight lang="lua">TruncateString( textControl, Controls.ChatPull:GetSizeX()-20, Locale.ConvertTextKey("TXT_KEY_DIPLO_TO_PLAYER", pPlayer:GetNickName()));</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|DiploList.lua}}<br />
:<code>UI/InGame/DiploList.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0216}}<syntaxhighlight lang="lua">TruncateString(Controls.LeaderName, textBoxSize, g_pPlayer:GetNickName());</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0218}}<syntaxhighlight lang="lua">TruncateString(Controls.LeaderName, textBoxSize, Locale.ConvertTextKey( PreGame.GetLeaderName( g_iPlayer ) ), " (" .. Locale.ConvertTextKey( "TXT_KEY_YOU" ) .. ")");</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0220}}<syntaxhighlight lang="lua">TruncateString(Controls.LeaderName, textBoxSize, Locale.ConvertTextKey( leaderDescription ), " (" .. Locale.ConvertTextKey( "TXT_KEY_YOU" ) .. ")");</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0231}}<syntaxhighlight lang="lua">TruncateString(Controls.CivName, textBoxSize, Locale.ConvertTextKey(PreGame.GetCivilizationShortDescription(g_iPlayer)));</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0233}}<syntaxhighlight lang="lua">TruncateString(Controls.CivName, textBoxSize, Locale.ConvertTextKey(myCivInfo.ShortDescription));</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0263}}<syntaxhighlight lang="lua">TruncateString(controlTable.LeaderName, textBoxSize, pOtherPlayer:GetNickName());</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0334}}<syntaxhighlight lang="lua">TruncateString( controlTable.DiploState, controlTable.StatusBox:GetSizeX(), statusString );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|DiploVotePopup.lua}}<br />
:<code>UI/InGame/Popups/DiploVotePopup.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0070}}<syntaxhighlight lang="lua">TruncateString(controlTable.ButtonText, textBoxSize, pOtherPlayer:GetNickName());</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0076}}<syntaxhighlight lang="lua">TruncateString(controlTable.ButtonText, textBoxSize, Locale.ConvertTextKey( PreGame.GetLeaderName( Game.GetActivePlayer() ) ), " (" .. Locale.ConvertTextKey( "TXT_KEY_YOU" ) .. ")");</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0078}}<syntaxhighlight lang="lua">TruncateString(controlTable.ButtonText, textBoxSize, Locale.ConvertTextKey( leaderDescription ), " (" .. Locale.ConvertTextKey( "TXT_KEY_YOU" ) .. ")");</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0081}}<syntaxhighlight lang="lua">TruncateString(controlTable.ButtonText, textBoxSize, Locale.ConvertTextKey("TXT_KEY_POP_UN_TEAM_LABEL", pOtherTeam:GetID() + 1) , " (" .. Locale.ConvertTextKey("TXT_KEY_POP_VOTE_RESULTS_YOUR_TEAM") .. ")");</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0087}}<syntaxhighlight lang="lua">TruncateString(controlTable.ButtonText, textBoxSize, Locale.ConvertTextKey( leaderDescription ));</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0089}}<syntaxhighlight lang="lua">TruncateString(controlTable.ButtonText, textBoxSize, Locale.ConvertTextKey("TXT_KEY_POP_UN_TEAM_LABEL", pOtherTeam:GetID() + 1));</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|GameMenu.lua}}<br />
:<code>UI/InGame/Menus/GameMenu.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0325}}<syntaxhighlight lang="lua">TruncateString(Controls.DetailsCiv, availableTextExtent, Locale.ConvertTextKey(myCivInfo.ShortDescription));</syntaxhighlight><br />
{{CodeLine5|0326}}<syntaxhighlight lang="lua">TruncateString(Controls.DetailsLeader, availableTextExtent, pPlayer:GetNickName());</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0328}}<syntaxhighlight lang="lua">TruncateString(Controls.DetailsCiv, availableTextExtent, PreGame.GetCivilizationShortDescription(0));</syntaxhighlight><br />
{{CodeLine5|0329}}<syntaxhighlight lang="lua">TruncateString(Controls.DetailsLeader, availableTextExtent, PreGame.GetLeaderName(0));</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0334}}<syntaxhighlight lang="lua">TruncateString(Controls.DetailsLeader, availableTextExtent, Locale.ConvertTextKey(leaderDescription));</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|GPList.lua}}<br />
:<code>UI/InGame/GPList.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0117}}<syntaxhighlight lang="lua">TruncateString( instance.CityName, 74, sortEntry.name );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|LoadMenu.lua}}<br />
:<code>UI/FrontEnd/LoadMenu.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0231}}<syntaxhighlight lang="lua">TruncateString(Controls.SaveFileName, Controls.DetailsBox:GetSizeX(), name);</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0558}}<syntaxhighlight lang="lua">TruncateString(controlTable.ButtonText, controlTable.Button:GetSizeX(), entryName);</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0576}}<syntaxhighlight lang="lua">TruncateString(controlTable.ButtonText, controlTable.Button:GetSizeX(), displayName);</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|Lobby.lua}}<br />
:<code>UI/FrontEnd/Multiplayer/Lobby.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0228}}<syntaxhighlight lang="lua">TruncateString(controlTable.ServerNameLabel, controlTable.ServerNameBox:GetSizeX(), serverEntry.serverName);</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|MPList.lua}}<br />
:<code>UI/InGame/WorldView/MPList.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0140}}<syntaxhighlight lang="lua">TruncateString( controlTable.Name, textSize, pPlayer:GetNickName() );</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0153}}<syntaxhighlight lang="lua">TruncateString( controlTable.Name, textSize, pPlayer:GetName() );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|ResourceList.lua}}<br />
:<code>UI/InGame/ResourceList.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0116}}<syntaxhighlight lang="lua">TruncateString( instance.ResourceName, 140, resource.IconString .. " " .. sortEntry.name );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|SaveMenu.lua}}<br />
:<code>UI/InGame/Menus/SaveMenu.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0569}}<syntaxhighlight lang="lua">TruncateString(instance.ButtonText, instance.Button:GetSizeX(), displayName);</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|StagingRoom.lua}}<br />
:<code>UI/FrontEnd/Multiplayer/StagingRoom.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0385}}<syntaxhighlight lang="lua">TruncateString(slotInstance.PlayerNameLabel, slotInstance.PlayerNameBox:GetSizeX() -</syntaxhighlight><br />
{{CodeLine5|0386}}<syntaxhighlight lang="lua">slotInstance.PlayerNameLabel:GetOffsetX(), playerName);</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0403}}<syntaxhighlight lang="lua">TruncateString(slotInstance.PlayerNameLabel, slotInstance.PlayerNameBox:GetSizeX() -</syntaxhighlight><br />
{{CodeLine5|0404}}<syntaxhighlight lang="lua">slotInstance.PlayerNameLabel:GetOffsetX(), Locale.ConvertTextKey("TXT_KEY_AI_NICKNAME"));</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0559}}<syntaxhighlight lang="lua">TruncateString(Controls.PlayerNameLabel, Controls.PlayerNameBox:GetSizeX() -</syntaxhighlight><br />
{{CodeLine5|0560}}<syntaxhighlight lang="lua">Controls.PlayerNameLabel:GetOffsetX(), playerName);</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|TradeLogic.lua}}<br />
:<code>UI/InGame/WorldView/TradeLogic.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0985}}<syntaxhighlight lang="lua">TruncateString(Controls.ThemName, Controls.ThemTablePanel:GetSizeX() - Controls.ThemTablePanel:GetOffsetX(),</syntaxhighlight><br />
{{CodeLine5|0986}}<syntaxhighlight lang="lua">Locale.ConvertTextKey( "TXT_KEY_DIPLO_ITEMS_LABEL", g_pThem:GetNickName() ));</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|2784}}<syntaxhighlight lang="lua">TruncateString(controlTable.Name, controlTable.ButtonSize:GetSizeX() - controlTable.Name:GetOffsetX(), szName);</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|UnitList.lua}}<br />
:<code>UI/InGame/UnitList.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0132}}<syntaxhighlight lang="lua">TruncateString( instance.UnitName, 110, sortEntry.name );</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|VictoryProgress.lua}}<br />
:<code>UI/InGame/Popups/VictoryProgress.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0394}}<syntaxhighlight lang="lua">TruncateString(Controls.UNInfo, 200, strPlayer);</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0467}}<syntaxhighlight lang="lua">TruncateString(Controls.CultureLabel, 200, strCiv);</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0879}}<syntaxhighlight lang="lua">TruncateString(controlTable, controlSize, displayText);</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|VoteResultsPopup.lua}}<br />
:<code>UI/InGame/Popups/VoteResultsPopup.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0168}}<syntaxhighlight lang="lua">TruncateString(controlTable.PlayerNameText, controlTable.PlayerNameBox:GetSizeX(), strName);</syntaxhighlight><br />
{{CodeBreak5}}<br />
{{CodeLine5|0176}}<syntaxhighlight lang="lua">TruncateString(controlTable.VoteCastText, controlTable.VoteCastBox:GetSizeX() - unSize, strVote);</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
{{PseudoH4|VoteResultsPopup.lua (G&K)}}<br />
:<code>DLC/Expansion/UI/InGame/Popups/VoteResultsPopup.lua</code><br />
:{{CodeBegin5}}<br />
{{CodeLine5|0199}}<syntaxhighlight lang="lua">TruncateString(controlTable.VoteCastText, controlTable.VoteCastBox:GetSizeX(), strVote);</syntaxhighlight><br />
{{CodeEnd5}}<br />
<br />
<br />
<br />
<br />
{{Civ5 API Footer}}<br />
[[Category:Civ5 Methods and Functions|TruncateString]]</div>
DonQuich