Label (Civ5 Type)

From Civilization Modding Wiki
Revision as of 16:19, 19 September 2012 by DonQuich (talk | contribs) (Bot update)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search

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


New Properties

ColorLayer0

Format: Unknown.
Usage: Unknown.


ColorLayer1

Format: Unknown.
Usage: Unknown.


TextAnchor

Format: Unknown.
Usage: Unknown.


TextAnchorSide

Format: Unknown.
Usage: Unknown.


New Instance Methods

Methods are functions that belong to an object. Instance methods are invoked through a colon, as in caller:SomeMethod(<args>), where caller is an instance of Label.
A colon implictly passes the caller object as the first argument. That is, the former call is equivalent to this one: caller.SomeMethod(caller, <args>)

Base game Gods & Kings ___________________________
Check.png Check.png Star.png Speech.png string GetText()
Check.png Check.png Star.png Speech.png LocalizeAndSetText(string name, int searchString = nil, string minFaithForProphet = nil, unknown arg3, unknown arg4, unknown arg5, unknown arg6, unknown arg7, unknown arg8, string arg9, unknown arg10, unknown arg11)
Check.png Check.png Star.png Speech.png SetText(string localizedString)


Inherited from TextBase

XML Properties: StringFontFontStyleWrapWidthTruncateWidthReduceOnTruncateLeadingOffsetColorSetColor0Color1Color2Color3ForceIMEForceNonIME

Base game Gods & Kings ___________________________
Check.png Check.png Star.png Speech.png string GetText()
Check.png Check.png Star.png Speech.png SetFontByName(string arg0)
Question.png Question.png Star.png Speech.png Question-blue.png SetForceIME
Question.png Question.png Star.png Speech.png Question-blue.png SetForceNonIME
Question.png Check.png Star.png Speech.png SetString(unknown arg0)
Check.png Check.png Star.png Speech.png SetTruncateWidth(int width)
Check.png Check.png Star.png Speech.png SetWrapWidth(PlayerID arg0)
Check.png Check.png Star.png Speech.png LocalizeAndSetText(string name, int searchString = nil, string minFaithForProphet = nil, unknown arg3, unknown arg4, unknown arg5, unknown arg6, unknown arg7, unknown arg8, string arg9, unknown arg10, unknown arg11)
Check.png Check.png Star.png Speech.png SetText(string localizedString)


Inherited from ControlBase

XML Properties: none.

Base game Gods & Kings ___________________________
Check.png Check.png Star.png Speech.png BuildEntry(string arg0, table arg1)
Check.png Check.png Star.png Speech.png CalculateInternals()
Check.png Check.png Star.png Speech.png CalculateInternalSize()
Check.png Check.png Star.png Speech.png CalculateSize()
Check.png Check.png Star.png Speech.png ClearEntries()
Check.png Check.png Star.png Speech.png Button GetButton()
Check.png Check.png Star.png Speech.png RegisterCheckHandler((void func(bool bIsChecked)) OnPolicyInfo)
Question.png Check.png Star.png Speech.png RegisterSelectionCallback((void func(FaithPurchaseType v1, int v2)) OnChatTarget)
Check.png Check.png Star.png Speech.png SetCheck(bool cityBanners)
Check.png Check.png Star.png Speech.png SetPercent(int percentDone)
Check.png Check.png Star.png Speech.png SetPercents(float productionProgressPercent, float productionProgressPlusThisTurnPercent)
Check.png Check.png Star.png Speech.png SetScrollValue(int arg0)
Check.png Check.png Star.png Speech.png SetTexture(string textureName)
Question.png Check.png Star.png Speech.png SetTextureOffsetVal(int arg0, int offset)
Check.png Check.png Star.png Speech.png UnloadTexture()
Check.png Check.png Star.png Speech.png SetVoid2(ProcessType process)
Check.png Check.png Star.png Speech.png SetVoids(ResourceType building, ResourceType addToList)
Check.png Check.png Star.png Speech.png string GetText()
Check.png Check.png Star.png Speech.png LocalizeAndSetText(string name, int searchString = nil, string minFaithForProphet = nil, unknown arg3, unknown arg4, unknown arg5, unknown arg6, unknown arg7, unknown arg8, string arg9, unknown arg10, unknown arg11)
Check.png Check.png Star.png Speech.png RegisterCallback(MouseType OnSearchTextEnter, (void func(PolicyBranchType policyBranchIndex, UnitType y, Button button)) OnClose = nil)
Check.png Check.png Star.png Speech.png SetText(string localizedString)
Check.png Check.png Star.png Speech.png SetVoid1(OrderType MAINTAIN_GOLD)


Common

XML Properties: IDDisabled

Base game Gods & Kings ___________________________
Question.png Question.png Star.png Speech.png ChangeParent(Image parent)
Question.png Question.png Star.png Speech.png DestroyAllChildren()
Question.png Question.png Star.png Speech.png string GetID()
Question.png Question.png Star.png Speech.png Question-blue.png GetNumChildren
Question.png Question.png Star.png Speech.png Question-blue.png IsDisabled
Question.png Question.png Star.png Speech.png ReleaseChild(WorldAnchor arg0)
Check.png Check.png Star.png Speech.png SetDisabled(bool disableBanners)
Check.png Check.png Star.png Speech.png SortChildren((void func(unknown a, unknown b)) SortFunction)


Layout

XML Properties: SizeOffsetAnchorAnchorSide

Base game Gods & Kings ___________________________
Question.png Question.png Star.png Speech.png unknown, int GetOffsetVal()
Question.png Question.png Star.png Speech.png int GetOffsetX()
Question.png Question.png Star.png Speech.png int GetOffsetY()
Check.png Check.png Star.png Speech.png Vector2 GetSize()
Question.png Question.png Star.png Speech.png int, int GetSizeVal()
Question.png Question.png Star.png Speech.png int GetSizeX()
Question.png Question.png Star.png Speech.png int GetSizeY()
Check.png Check.png Star.png Speech.png ReprocessAnchoring()
Question.png Question.png Star.png Speech.png SetAnchor(string arg0)
Check.png Check.png Star.png Speech.png SetOffset(Vector2 offset)
Check.png Check.png Star.png Speech.png SetOffsetVal(int xOffset, int yOffset)
Question.png Question.png Star.png Speech.png SetOffsetX(int xOffset)
Question.png Question.png Star.png Speech.png SetOffsetY(int TOP_COMPENSATION)
Check.png Check.png Star.png Speech.png SetSize(table blockSize)
Check.png Check.png Star.png Speech.png SetSizeVal(int baseWidth, int newHeight)
Question.png Question.png Star.png Speech.png SetSizeX(int width)
Question.png Question.png Star.png Speech.png SetSizeY(int newSizeY)


Appearance

XML Properties: HiddenStyleNoClipColorBranchAlpha

Base game Gods & Kings ___________________________
Question.png Question.png Star.png Speech.png BranchResetAnimation()
Question.png Question.png Star.png Speech.png Question-blue.png CalculateVisibilityBox
Check.png Check.png Star.png Speech.png int IsHidden()
Question.png Question.png Star.png Speech.png SetAlpha(float DimAlpha)
Check.png Check.png Star.png Speech.png SetColor(table fadeColor, int arg1)
Check.png Check.png Star.png Speech.png SetColorByName(string colorSet)
Check.png Check.png Star.png Speech.png SetColorChannel(int arg0, float arg1)
Question.png Check.png Star.png Speech.png SetColorVal(int arg0, int arg1 = nil, int arg2 = nil, int arg3 = nil)
Check.png Check.png Star.png Speech.png SetHide(int disablePolicies)
Question.png Question.png Star.png Speech.png Question-blue.png SetNoClip


Interaction

XML Properties: NeedsMouseOverConsumeMouseConsumeMouseOverConsumeMouseWheelConsumeMouseButton

Base game Gods & Kings ___________________________
Question.png Question.png Star.png Speech.png Question-blue.png GetConsumeMouseButton
Question.png Question.png Star.png Speech.png Question-blue.png GetConsumeMouseOver
Question.png Question.png Star.png Speech.png Question-blue.png GetConsumeMouseWheel
Question.png Question.png Star.png Speech.png bool HasMouseOver()
Question.png Question.png Star.png Speech.png Question-blue.png SetConsumeMouseButton
Question.png Question.png Star.png Speech.png SetConsumeMouseOver(bool arg0)
Question.png Question.png Star.png Speech.png Question-blue.png SetConsumeMouseWheel


Tool Tip

XML Properties: ToolTipToolTipType

Base game Gods & Kings ___________________________
Question.png Question.png Star.png Speech.png EnableToolTip(bool arg0)
Question.png Question.png Star.png Speech.png Question-blue.png GetToolTipString
Question.png Question.png Star.png Speech.png Question-blue.png IsToolTipEnabled
Check.png Check.png Star.png Speech.png LocalizeAndSetToolTip(string description, string minFaithForProphet = nil, string threshold, string moodText, string spyRank, string spyName, string spyRank, string spyName, unknown arg8, unknown arg9, string arg10, unknown arg11, unknown arg12)
Question.png Question.png Star.png Speech.png SetToolTipCallback((void func(Slider control)) TipHandler)
Check.png Check.png Star.png Speech.png SetToolTipString(string foodToolTip)
Question.png Question.png Star.png Speech.png SetToolTipType(string arg0)


Source code samples

Too many occurences. Only 10 out of 3790 are listed.

AdvancedSetup.xml

UI/FrontEnd/GameSetup/AdvancedSetup.xml
0110
<Label Anchor="L,C" ColorSet="Beige_Black" Font="TwCenMT20" FontStyle="Shadow" String="TXT_KEY_AD_SETUP_HANDICAP" />


BarbarianCampPopup.xml

UI/InGame/Popups/BarbarianCampPopup.xml
0024
<Label Anchor="C,C" Offset="0,-2" String="TXT_KEY_CLOSE"  Color0="255.255.200.255" Color1="0.0.0.128" Color2="255.255.200.255" Font="TwCenMT22" FontStyle="Shadow" />


ChooseReligionPopup.xml (G&K)

DLC/Expansion/UI/InGame/Popups/ChooseReligionPopup.xml
0021
<Label Anchor="L,T" Offset="45,10" Font="TwCenMT20" ColorSet="Beige_Black_Alpha" FontStyle="Shadow" ID="Name"/>


CityBannerManager.xml

UI/InGame/CityBannerManager.xml
0113
<Label ID="ResistanceIcon"  Anchor="C,C" Offset="0,0" String="[ICON_RESISTANCE]"    Hidden="1"/>


CityView.xml

UI/InGame/CityView/CityView.xml
0072
<Label Anchor="C,T" Offset="0,18" String="TXT_KEY_CITYVIEW_CITYINFO_TEXT" ColorSet="Beige_Black_Alpha" Font="TwCenMT20" FontStyle="Shadow"/>


DebugMode.xml

UI/InGame/DebugMode.xml
0173
<Label Anchor="L,C" String="Unit Variable:"/>


DiploRelationships.xml

UI/InGame/Popups/DiploRelationships.xml
0110
<Label ID="AllyLabel" Anchor="L,T" Offset="32,0" Font="TwCenMT14" FontStyle="Shadow" ColorSet="Beige_Black_Alpha" String="TXT_KEY_POP_CSTATE_ALLIED_WITH">


Lobby.xml

UI/FrontEnd/Multiplayer/Lobby.xml
0025
<Label Anchor="C,C" Offset="0,0" Font="TwCenMT18" ColorSet="Beige_Black_Alpha" FontStyle="Shadow" ID="MembersLabel"/>


MilitaryOverview.xml

UI/InGame/Popups/MilitaryOverview.xml
0138
<Label Offset="10,0" Font="TwCenMT18" Anchor="L,C" String="TXT_KEY_SUPPLY_REMAINING"  />


UITestMenu.xml

UI/FrontEnd/UITestMenu.xml
0126
<Label   Anchor="R,T"  Offset="30,10" ColorSet="Beige_Black" Font="TwCenMT18" FontStyle="Shadow" String="(M)" />



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.