SCR_CampaignBuildingBudgetEditorUIComponent Interface Reference

Inheritance diagram for SCR_CampaignBuildingBudgetEditorUIComponent:

Public Member Functions
override void	InitializeBudgets ()
override void	OnBudgetAdd (SCR_EditableEntityCoreBudgetSetting budget, int maxBudget)
override void	OnBudgetUpdate (EEditableEntityBudget budgetType, int originalBudgetValue, int updatedBudgetValue, int maxBudgetValue)
SCR_CampaignBuildingProviderComponent	GetProviderComponent ()
	Get current provider component.
int	GetMaxBudgetValue (EEditableEntityBudget budget)
int	GetCurrentBudgetValue ()
Public Member Functions inherited from SCR_BudgetEditorUIComponent
override void	HandlerAttachedScripted (Widget w)
	Event called when subcomponent is initialized.
override void	HandlerDeattached (Widget w)
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 Attributes
ref array< EEditableEntityBudget >	m_aVisibleBudgetUI
Protected Attributes inherited from SCR_BudgetEditorUIComponent
float	m_fDisabledOpacity
SCR_BudgetEditorComponent	m_BudgetManager
ResourceName	m_BudgetEntryPrefab
Widget	m_Layout
ref map< EEditableEntityBudget, Widget >	m_BudgetWidgets = new map<EEditableEntityBudget, Widget>()
Protected Attributes inherited from SCR_BaseEditorUIComponent
vector	m_vClickPosCancel

Static Protected Attributes
static const int	UNLIMITED_PROP_BUDGET = -1

Additional Inherited Members
Static Public Attributes inherited from SCR_BudgetEditorUIComponent
const string	WIDGET_BUDGET_TEXT = "PercentageText"
const string	WIDGET_BUDGET_ICON = "Icon"
const string	WIDGET_BUDGET_PROGRESSBAR = "RadialProgressBar"
const string	WIDGET_BUDGETPREVIEW_TEXT = "Preview"
const string	WIDGET_ICON_AREA = "IconArea"
const string	WIDGET_LOCK_VISUALS = "LockVisuals"
Static Public Attributes inherited from SCR_BaseEditorUIComponent
const int	CANCEL_CLICK_MAX_DIS = 5
const int	CANCEL_CLICK_MAX_TIME = 500
Protected Member Functions inherited from SCR_BudgetEditorUIComponent
void	OnBudgetMaxUpdate (EEditableEntityBudget budgetType, int currentBudgetValue, int maxBudgetValue)
void	OnBudgetUpdate (EEditableEntityBudget budgetType, int originalBudgetValue, int updatedBudgetValue, int maxBudgetValue)
void	OnBudgetAdd (SCR_EditableEntityCoreBudgetSetting budget, int maxBudget)
void	OnBudgetPreviewUpdate (EEditableEntityBudget budgetType, float previewBudgetValue, float budgetChange)
void	InitializeBudgets ()
void	SetBudgetData (Widget budgetWidget, int budgetValue, int maxBudgetValue, SCR_UIInfo info=null)
void	SetBudgetPreviewData (Widget w, float previewBudgetValue, float budgetChange)
void	UnregisterEvents ()
Protected Member Functions inherited from SCR_BaseEditorUIComponent
vector	OnCancelDown ()
bool	OnCancelUp ()
void	OnCancelExpired ()
Protected Member Functions inherited from MenuRootSubComponent
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.

Member Function Documentation

GetCurrentBudgetValue()

int SCR_CampaignBuildingBudgetEditorUIComponent.GetCurrentBudgetValue

(

)

Returns

current budget value from provider

GetMaxBudgetValue()

int SCR_CampaignBuildingBudgetEditorUIComponent.GetMaxBudgetValue

(

EEditableEntityBudget

budget

)

Returns

max budget value from provider

GetProviderComponent()

SCR_CampaignBuildingProviderComponent SCR_CampaignBuildingBudgetEditorUIComponent.GetProviderComponent

(

)

Get current provider component.

InitializeBudgets()

override void SCR_CampaignBuildingBudgetEditorUIComponent.InitializeBudgets

(

)

Implements SCR_BudgetEditorUIComponent.

OnBudgetAdd()

override void SCR_CampaignBuildingBudgetEditorUIComponent.OnBudgetAdd	(	SCR_EditableEntityCoreBudgetSetting	budget,
		int	maxBudget
	)

Implements SCR_BudgetEditorUIComponent.

OnBudgetUpdate()

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

Implements SCR_BudgetEditorUIComponent.

Member Data Documentation

m_aVisibleBudgetUI

ref array<EEditableEntityBudget> SCR_CampaignBuildingBudgetEditorUIComponent.m_aVisibleBudgetUI

protected

UNLIMITED_PROP_BUDGET

const int SCR_CampaignBuildingBudgetEditorUIComponent.UNLIMITED_PROP_BUDGET = -1

staticprotected

---

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

• Game/Editor/UI/Components/Common/SCR_CampaignBuildingBudgetEditorUIComponent.c