SCR_BudgetEditorUIComponent Interface Reference

Inheritance diagram for SCR_BudgetEditorUIComponent:

Public Member Functions
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,.
override void	HandlerAttached (Widget w)

Static Public Attributes
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
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.

Protected Attributes
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

Member Function Documentation

HandlerAttachedScripted()

override void SCR_BudgetEditorUIComponent.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_BudgetEditorUIComponent.HandlerDeattached

(

Widget

w

)

Implements MenuRootSubComponent.

InitializeBudgets()

void SCR_BudgetEditorUIComponent.InitializeBudgets ( )

protected

Implemented in SCR_CampaignBuildingBudgetEditorUIComponent.

OnBudgetAdd()

void SCR_BudgetEditorUIComponent.OnBudgetAdd ( SCR_EditableEntityCoreBudgetSetting budget, int maxBudget )

protected

Implemented in SCR_CampaignBuildingBudgetEditorUIComponent.

OnBudgetMaxUpdate()

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

protected

OnBudgetPreviewUpdate()

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

protected

OnBudgetUpdate()

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

protected

Implemented in SCR_CampaignBuildingBudgetEditorUIComponent.

SetBudgetData()

void SCR_BudgetEditorUIComponent.SetBudgetData ( Widget budgetWidget, int budgetValue, int maxBudgetValue, SCR_UIInfo info = null )

protected

SetBudgetPreviewData()

void SCR_BudgetEditorUIComponent.SetBudgetPreviewData ( Widget w, float previewBudgetValue, float budgetChange )

protected

UnregisterEvents()

void SCR_BudgetEditorUIComponent.UnregisterEvents ( )

protected

Member Data Documentation

m_BudgetEntryPrefab

ResourceName SCR_BudgetEditorUIComponent.m_BudgetEntryPrefab

protected

m_BudgetManager

SCR_BudgetEditorComponent SCR_BudgetEditorUIComponent.m_BudgetManager

protected

m_BudgetWidgets

ref map<EEditableEntityBudget, Widget> SCR_BudgetEditorUIComponent.m_BudgetWidgets = new map<EEditableEntityBudget, Widget>()

protected

m_fDisabledOpacity

float SCR_BudgetEditorUIComponent.m_fDisabledOpacity

protected

m_Layout

Widget SCR_BudgetEditorUIComponent.m_Layout

protected

WIDGET_BUDGET_ICON

const string SCR_BudgetEditorUIComponent.WIDGET_BUDGET_ICON = "Icon"

static

WIDGET_BUDGET_PROGRESSBAR

const string SCR_BudgetEditorUIComponent.WIDGET_BUDGET_PROGRESSBAR = "RadialProgressBar"

static

WIDGET_BUDGET_TEXT

const string SCR_BudgetEditorUIComponent.WIDGET_BUDGET_TEXT = "PercentageText"

static

WIDGET_BUDGETPREVIEW_TEXT

const string SCR_BudgetEditorUIComponent.WIDGET_BUDGETPREVIEW_TEXT = "Preview"

static

WIDGET_ICON_AREA

const string SCR_BudgetEditorUIComponent.WIDGET_ICON_AREA = "IconArea"

static

WIDGET_LOCK_VISUALS

const string SCR_BudgetEditorUIComponent.WIDGET_LOCK_VISUALS = "LockVisuals"

static

---

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

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