Bar (Civ5 Type)

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

New Properties

BGColor

Format: Unknown.

Usage: Unknown.

Direction

Format: Unknown.

Usage: Unknown.

FGColor

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 Bar.
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>)

				___________________________
					SetFGColor(Vector4 tBarColor)

Inherited from ControlBase

XML Properties: none.

				___________________________
					BuildEntry(string arg0, table arg1)
					CalculateInternals()
					CalculateInternalSize()
					CalculateSize()
					ClearEntries()
				Button	GetButton()
					RegisterCheckHandler((void func(bool bIsChecked)) OnPolicyInfo)
					RegisterSelectionCallback((void func(FaithPurchaseType v1, int v2)) OnChatTarget)
					SetCheck(bool cityBanners)
					SetPercent(int percentDone)
					SetPercents(float productionProgressPercent, float productionProgressPlusThisTurnPercent)
					SetScrollValue(int arg0)
					SetTexture(string textureName)
					SetTextureOffsetVal(int arg0, int offset)
					UnloadTexture()
					SetVoid2(ProcessType process)
					SetVoids(ResourceType building, ResourceType addToList)
				string	GetText()
					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)
					RegisterCallback(MouseType OnSearchTextEnter, (void func(PolicyBranchType policyBranchIndex, UnitType y, Button button)) OnClose = nil)
					SetText(string localizedString)
					SetVoid1(OrderType MAINTAIN_GOLD)

Common

XML Properties: IDDisabled

				___________________________
					ChangeParent(Image parent)
					DestroyAllChildren()
				string	GetID()
					GetNumChildren
					IsDisabled
					ReleaseChild(WorldAnchor arg0)
					SetDisabled(bool disableBanners)
					SortChildren((void func(unknown a, unknown b)) SortFunction)

Layout

XML Properties: SizeOffsetAnchorAnchorSide

				___________________________
				unknown, int	GetOffsetVal()
				int	GetOffsetX()
				int	GetOffsetY()
				Vector2	GetSize()
				int, int	GetSizeVal()
				int	GetSizeX()
				int	GetSizeY()
					ReprocessAnchoring()
					SetAnchor(string arg0)
					SetOffset(Vector2 offset)
					SetOffsetVal(int xOffset, int yOffset)
					SetOffsetX(int xOffset)
					SetOffsetY(int TOP_COMPENSATION)
					SetSize(table blockSize)
					SetSizeVal(int baseWidth, int newHeight)
					SetSizeX(int width)
					SetSizeY(int newSizeY)

Appearance

XML Properties: HiddenStyleNoClipColorBranchAlpha

				___________________________
					BranchResetAnimation()
					CalculateVisibilityBox
				int	IsHidden()
					SetAlpha(float DimAlpha)
					SetColor(table fadeColor, int arg1)
					SetColorByName(string colorSet)
					SetColorChannel(int arg0, float arg1)
					SetColorVal(int arg0, int arg1 = nil, int arg2 = nil, int arg3 = nil)
					SetHide(int disablePolicies)
					SetNoClip

Interaction

XML Properties: NeedsMouseOverConsumeMouseConsumeMouseOverConsumeMouseWheelConsumeMouseButton

				___________________________
					GetConsumeMouseButton
					GetConsumeMouseOver
					GetConsumeMouseWheel
				bool	HasMouseOver()
					SetConsumeMouseButton
					SetConsumeMouseOver(bool arg0)
					SetConsumeMouseWheel

Tool Tip

XML Properties: ToolTipToolTipType

				___________________________
					EnableToolTip(bool arg0)
					GetToolTipString
					IsToolTipEnabled
					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)
					SetToolTipCallback((void func(Slider control)) TipHandler)
					SetToolTipString(string foodToolTip)
					SetToolTipType(string arg0)

Source code samples

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

CityBannerManager.xml (G&K)

DLC/Expansion/UI/InGame/CityBannerManager.xml

0041	<Bar Anchor="C,B" Offset="0,0" Size="4,30" FGColor="Food,128" Hidden="0" ID="GrowthBarShadow" Direction="Up"/>
0042	<Bar Anchor="C,B" Offset="0,0" Size="4,30" FGColor="Food,255" Hidden="0" ID="GrowthBar" Direction="Up"/>
0049	<Bar Anchor="C,B" Offset="0,0" Size="4,30" FGColor="Production,128" Hidden="0" ID="ProductionBarShadow" Direction="Up"/>
0050	<Bar Anchor="C,B" Offset="0,0" Size="4,30" FGColor="Production,255" Hidden="0" ID="ProductionBar" Direction="Up"/>
0075	<Bar Anchor="C,C" Offset="0,0" Size="98,3" Direction="Right" FGColor="Green,255" ID="CityBannerHealthBar" Hidden="0"/>

CityList.xml

UI/InGame/CityList.xml

0173	<Bar Anchor="C,C" Offset="0,0" Size="138,3" Direction="Right" FGColor="Green,255" ID="HealthBar" />

GPList.xml (G&K)

DLC/Expansion/UI/InGame/GPList.xml

0156	<Bar Anchor="L,T" Offset="1,2" Direction="R" Size="357,18" FGColor="0,255,0,100" ID="GGMeter"/>

UITestMenu.xml

UI/FrontEnd/UITestMenu.xml

0075	<Bar Anchor="C,B" Direction="L" Size="100,3" BGColor="0,0,0,255" FGColor="0,255,0,255" ID="Bar2"/>
0076	<Bar Anchor="L,C" Direction="U" Size="3,100" BGColor="0,0,0,255" FGColor="0,255,0,255" ID="Bar3"/>
0077	<Bar Anchor="R,C" Direction="D" Size="3,100" BGColor="0,0,0,255" FGColor="0,255,0,255" ID="Bar4"/>

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.