UpButton (Civ5 Type)

From Civilization Modding Wiki
Jump to navigationJump to search

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


Inherited from ButtonBase

XML Properties: Void1Void2

Base game Gods & Kings ___________________________
ClearCallback(MouseType arg0)
IsTrackingMiddleMouseButton
IsTrackingRightMouseButton
SetVoid2(ProcessType process)
SetVoids(ResourceType building, ResourceType addToList)
ActionType GetVoid1()
ResourceType GetVoid2()
bool IsTrackingLeftMouseButton()
RegisterCallback(MouseType OnSearchTextEnter, (void func(PolicyBranchType policyBranchIndex, UnitType y, Button button)) OnClose = nil)
SetVoid1(OrderType MAINTAIN_GOLD)


Inherited from ControlBase

XML Properties: none.

Base game Gods & Kings ___________________________
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

Base game Gods & Kings ___________________________
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

Base game Gods & Kings ___________________________
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

Base game Gods & Kings ___________________________
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

Base game Gods & Kings ___________________________
GetConsumeMouseButton
GetConsumeMouseOver
GetConsumeMouseWheel
bool HasMouseOver()
SetConsumeMouseButton
SetConsumeMouseOver(bool arg0)
SetConsumeMouseWheel


Tool Tip

XML Properties: ToolTipToolTipType

Base game Gods & Kings ___________________________
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 248 are listed.

DiploRelationships.xml (G&K)

DLC/Expansion/UI/InGame/Popups/DiploRelationships.xml
0109
<UpButton Anchor="R,T" Offset="0.0" Style="ScrollBarUp"/>


DiploTrade.xml

UI/InGame/LeaderHead/DiploTrade.xml
0165
<UpButton  Offset="7.2"  Style="ScrollBarUp"  Anchor="L,T" AnchorSide="O,I" />


EconomicGeneralInfo.xml

UI/InGame/Popups/EconomicGeneralInfo.xml
0197
<UpButton   Offset="0,0"    Style="ScrollBarUp"     Anchor="R,T"                   ID="UpButton"/>


EconomicGeneralInfo.xml (G&K)

DLC/Expansion/UI/InGame/Popups/EconomicGeneralInfo.xml
0079
<UpButton Offset="8,2" Style="ScrollBarUp" Anchor="R,T" AnchorSide="o,i"/>


GPList.xml

UI/InGame/GPList.xml
0134
<UpButton Offset="-222,0" Style="ScrollBarUp" Anchor="l,T" ID="UpButton" />


MongolScenarioLoadScreen.xml - DLC_01 DLC

DLC/DLC_01/Scenarios/Mongol Scenario/MongolScenarioLoadScreen.xml
0062
<UpButton  Offset="0.0"  Style="ScrollBarUp"  Anchor="R,T" AnchorSide="O,I" />


PremiumContentMenu.xml

UI/FrontEnd/PremiumContentMenu.xml
0038
<UpButton   Anchor="R,T" AnchorSide="O,I" Offset="0,0" Style="ScrollBarUp"/>


StagingRoom.xml

UI/FrontEnd/Multiplayer/StagingRoom.xml
0236
<UpButton   Style="ScrollBarUp"   Anchor="R,T" AnchorSide="O,I" />


UITestMenu.xml

UI/FrontEnd/UITestMenu.xml
0064
<UpButton   Style="Button_16" Anchor="L,T" AnchorSide="i,o" />


UnitList.xml

UI/InGame/UnitList.xml
0129
<UpButton  Offset="-222,0"  Style="ScrollBarUp"  Anchor="l,T" ID="UpButton"/>



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.