SCR_BudgetUIComponent Interface Reference

Component to display budget progress. More...

Inheritance diagram for SCR_BudgetUIComponent:

Public Member Functions
override void	HandlerAttachedScripted (Widget w)
	Event called when subcomponent is initialized.
override void	HandlerDeattached (Widget w)
void	SetBudgetType (EEditableEntityBudget type)
	Set a budget which will will be used in UI of provider detail.
EEditableEntityBudget	GetBudgetType ()
SCR_BudgetProgressEditorUIComponent	GetUIComponent ()
Public Member Functions inherited from MenuRootSubComponent
Widget	GetWidget ()
	Get widget to which the component belongs to.
MenuRootBase	GetMenu ()
	Get menu of which the widget is part of.
MenuRootComponent	GetRootComponent ()
	Get root component of this subcomponent,.
void	HandlerAttachedScripted (Widget w)
	Event called when subcomponent is initialized.
override void	HandlerAttached (Widget w)
override void	HandlerDeattached (Widget w)

Protected Member Functions
override bool	IsUnique ()
	Is the component to exist only in one instance? If so, it will be registered in the list of components and can be searched for.
void	InitializeBudgets ()
void	OnBudgetUpdate (EEditableEntityBudget budgetType, int originalBudgetValue, int updatedBudgetValue, int maxBudgetValue)
void	OnBudgetMaxUpdate (EEditableEntityBudget budgetType, int currentBudgetValue, int maxBudgetValue)
void	OnBudgetPreviewUpdate (EEditableEntityBudget budgetType, float previewBudgetValue, float budgetChange)
void	ResetWidgetPreviewData ()
void	SetBudgetUIIcon (EEditableEntityBudget budgetType)
	Load icon of given budget from budgetUI and set it.
Protected Member Functions inherited from SCR_BaseEditorUIComponent
vector	OnCancelDown ()
bool	OnCancelUp ()
void	OnCancelExpired ()
bool	IsUnique ()
	Is the component to exist only in one instance? If so, it will be registered in the list of components and can be searched for.

Protected Attributes
EEditableEntityBudget	m_BudgetType
string	m_sBudgetProgressRoot
SCR_CampaignBuildingEditorComponent	m_CampaignBuildingComponent
SCR_BudgetEditorComponent	m_BudgetManager
SCR_BudgetProgressEditorUIComponent	m_BudgetProgress
int	m_iCurrentBudget
int	m_iMaxBudget
Protected Attributes inherited from SCR_BaseEditorUIComponent
vector	m_vClickPosCancel

Static Protected Attributes
const int	INVALID_BUDGET = -1

Additional Inherited Members
Static Public Attributes inherited from SCR_BaseEditorUIComponent
const int	CANCEL_CLICK_MAX_DIS = 5
const int	CANCEL_CLICK_MAX_TIME = 500

Detailed Description

Component to display budget progress.

Member Function Documentation

GetBudgetType()

EEditableEntityBudget SCR_BudgetUIComponent.GetBudgetType

(

)

GetUIComponent()

SCR_BudgetProgressEditorUIComponent SCR_BudgetUIComponent.GetUIComponent

(

)

HandlerAttachedScripted()

override void SCR_BudgetUIComponent.HandlerAttachedScripted

(

Widget

w

)

Event called when subcomponent is initialized.

Called only after all other subcomponents were registered as well and can be searched for. To be overwritten by inherited classes.

Parameters

Widget

Implements MenuRootSubComponent.

HandlerDeattached()

override void SCR_BudgetUIComponent.HandlerDeattached

(

Widget

w

)

Implements MenuRootSubComponent.

InitializeBudgets()

void SCR_BudgetUIComponent.InitializeBudgets ( )

protected

IsUnique()

override bool SCR_BudgetUIComponent.IsUnique ( )

protected

Is the component to exist only in one instance? If so, it will be registered in the list of components and can be searched for.

To be overwritten by inherited classes.

Returns

True if unique

Implements MenuRootSubComponent.

OnBudgetMaxUpdate()

void SCR_BudgetUIComponent.OnBudgetMaxUpdate ( EEditableEntityBudget  budgetType, int  currentBudgetValue, int  maxBudgetValue  )

protected

OnBudgetPreviewUpdate()

void SCR_BudgetUIComponent.OnBudgetPreviewUpdate ( EEditableEntityBudget  budgetType, float  previewBudgetValue, float  budgetChange  )

protected

OnBudgetUpdate()

void SCR_BudgetUIComponent.OnBudgetUpdate ( EEditableEntityBudget  budgetType, int  originalBudgetValue, int  updatedBudgetValue, int  maxBudgetValue  )

protected

ResetWidgetPreviewData()

void SCR_BudgetUIComponent.ResetWidgetPreviewData ( )

protected

SetBudgetType()

void SCR_BudgetUIComponent.SetBudgetType

(

EEditableEntityBudget

type

)

Set a budget which will will be used in UI of provider detail.

SetBudgetUIIcon()

void SCR_BudgetUIComponent.SetBudgetUIIcon ( EEditableEntityBudget  budgetType )

protected

Load icon of given budget from budgetUI and set it.

Member Data Documentation

INVALID_BUDGET

const int SCR_BudgetUIComponent.INVALID_BUDGET = -1

staticprotected

m_BudgetManager

SCR_BudgetEditorComponent SCR_BudgetUIComponent.m_BudgetManager

protected

m_BudgetProgress

SCR_BudgetProgressEditorUIComponent SCR_BudgetUIComponent.m_BudgetProgress

protected

m_BudgetType

EEditableEntityBudget SCR_BudgetUIComponent.m_BudgetType

protected

m_CampaignBuildingComponent

SCR_CampaignBuildingEditorComponent SCR_BudgetUIComponent.m_CampaignBuildingComponent

protected

m_iCurrentBudget

int SCR_BudgetUIComponent.m_iCurrentBudget

protected

m_iMaxBudget

int SCR_BudgetUIComponent.m_iMaxBudget

protected

m_sBudgetProgressRoot

string SCR_BudgetUIComponent.m_sBudgetProgressRoot

protected

---

The documentation for this interface was generated from the following file:

• Game/Editor/UI/Components/Toolbar/Building/SCR_BudgetUIComponent.c