SCR_CampaignBuildingServicesEditorUIComponent Interface Reference

Inheritance diagram for SCR_CampaignBuildingServicesEditorUIComponent:

Public Member Functions
override void	HandlerAttached (Widget w)
override void	HandlerDeattached (Widget w)
bool	IsAnyServiceBuilt (EEditableEntityLabel label)
	Check if any listed service is fully built.
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
void	FilterServiceLabels (notnull SCR_EditableEntityUIInfo editableUIInfo)
void	GetAllServicesUIInfo ()
void	SetBaseServices (SCR_MilitaryBaseComponent militaryBaseComponent=null, SCR_ServicePointComponent serviceComponent=null)
void	GetProviderServices (out array< SCR_ServicePointComponent > services)
	Returns all services available with current provider.
void	RemoveOnServiceStateChangedEvent ()
	Removes the update ui event from all currently available services.
void	OnServiceUnregistered (SCR_MilitaryBaseComponent militaryBaseComponent, SCR_ServicePointComponent service)
void	OnServiceChanged (SCR_EServicePointStatus state)
void	RefreshServiceUI ()
	Refresh the service widgets to reflect current status of services in base.
void	ClearServicesWidget ()
Widget	CreateWidget (notnull Widget gridWidget, int serviceId)
void	SetServicesIcon ()
	Go through all available services and set an icon to it.
void	SetIcon (ImageWidget widget, EEditableEntityLabel serviceLabel)
	Set the icon of the service.
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
ResourceName	m_sServiceIconsGridPrefab
int	m_iMaxColumns
ref array< ref Tuple2< EEditableEntityLabel, SCR_ServicePointComponent > >	m_aServices = {}
Widget	m_wCampaignBuildingServicesRoot
SCR_MilitaryBaseComponent	m_MilitaryBaseComponent
ref array< EEditableEntityLabel >	m_aAvailableServicesLabel = {}
Protected Attributes inherited from SCR_BaseEditorUIComponent
vector	m_vClickPosCancel

Static Protected Attributes
const int	PADDING_LEFT = 5
const int	PADDING_RIGHT = 5
const int	PADDING_TOP = 5
const int	PADDING_BOTTOM = 5
static const int	DEFAULT_VALUE = 7

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

Member Function Documentation

ClearServicesWidget()

void SCR_CampaignBuildingServicesEditorUIComponent.ClearServicesWidget ( )

protected

CreateWidget()

Widget SCR_CampaignBuildingServicesEditorUIComponent.CreateWidget ( notnull Widget  gridWidget, int  serviceId  )

protected

FilterServiceLabels()

void SCR_CampaignBuildingServicesEditorUIComponent.FilterServiceLabels ( notnull SCR_EditableEntityUIInfo  editableUIInfo )

protected

GetAllServicesUIInfo()

void SCR_CampaignBuildingServicesEditorUIComponent.GetAllServicesUIInfo ( )

protected

GetProviderServices()

void SCR_CampaignBuildingServicesEditorUIComponent.GetProviderServices ( out array< SCR_ServicePointComponent >  services )

protected

Returns all services available with current provider.

HandlerAttached()

override void SCR_CampaignBuildingServicesEditorUIComponent.HandlerAttached

(

Widget

w

)

Implements MenuRootSubComponent.

HandlerDeattached()

override void SCR_CampaignBuildingServicesEditorUIComponent.HandlerDeattached

(

Widget

w

)

Implements MenuRootSubComponent.

IsAnyServiceBuilt()

bool SCR_CampaignBuildingServicesEditorUIComponent.IsAnyServiceBuilt

(

EEditableEntityLabel

label

)

Check if any listed service is fully built.

Parameters

[in]

label

Returns

OnServiceChanged()

void SCR_CampaignBuildingServicesEditorUIComponent.OnServiceChanged ( SCR_EServicePointStatus  state )

protected

OnServiceUnregistered()

void SCR_CampaignBuildingServicesEditorUIComponent.OnServiceUnregistered ( SCR_MilitaryBaseComponent  militaryBaseComponent, SCR_ServicePointComponent  service  )

protected

RefreshServiceUI()

void SCR_CampaignBuildingServicesEditorUIComponent.RefreshServiceUI ( )

protected

Refresh the service widgets to reflect current status of services in base.

RemoveOnServiceStateChangedEvent()

void SCR_CampaignBuildingServicesEditorUIComponent.RemoveOnServiceStateChangedEvent ( )

protected

Removes the update ui event from all currently available services.

SetBaseServices()

void SCR_CampaignBuildingServicesEditorUIComponent.SetBaseServices ( SCR_MilitaryBaseComponent  militaryBaseComponent = null, SCR_ServicePointComponent  serviceComponent = null  )

protected

SetIcon()

void SCR_CampaignBuildingServicesEditorUIComponent.SetIcon ( ImageWidget  widget, EEditableEntityLabel  serviceLabel  )

protected

Set the icon of the service.

Parameters

[in]	widget
[in]	serviceLabel

SetServicesIcon()

void SCR_CampaignBuildingServicesEditorUIComponent.SetServicesIcon ( )

protected

Go through all available services and set an icon to it.

Member Data Documentation

DEFAULT_VALUE

const int SCR_CampaignBuildingServicesEditorUIComponent.DEFAULT_VALUE = 7

staticprotected

m_aAvailableServicesLabel

ref array<EEditableEntityLabel> SCR_CampaignBuildingServicesEditorUIComponent.m_aAvailableServicesLabel = {}

protected

m_aServices

ref array<ref Tuple2<EEditableEntityLabel, SCR_ServicePointComponent> > SCR_CampaignBuildingServicesEditorUIComponent.m_aServices = {}

protected

m_iMaxColumns

int SCR_CampaignBuildingServicesEditorUIComponent.m_iMaxColumns

protected

m_MilitaryBaseComponent

SCR_MilitaryBaseComponent SCR_CampaignBuildingServicesEditorUIComponent.m_MilitaryBaseComponent

protected

m_sServiceIconsGridPrefab

ResourceName SCR_CampaignBuildingServicesEditorUIComponent.m_sServiceIconsGridPrefab

protected

m_wCampaignBuildingServicesRoot

Widget SCR_CampaignBuildingServicesEditorUIComponent.m_wCampaignBuildingServicesRoot

protected

PADDING_BOTTOM

const int SCR_CampaignBuildingServicesEditorUIComponent.PADDING_BOTTOM = 5

staticprotected

PADDING_LEFT

const int SCR_CampaignBuildingServicesEditorUIComponent.PADDING_LEFT = 5

staticprotected

PADDING_RIGHT

const int SCR_CampaignBuildingServicesEditorUIComponent.PADDING_RIGHT = 5

staticprotected

PADDING_TOP

const int SCR_CampaignBuildingServicesEditorUIComponent.PADDING_TOP = 5

staticprotected

---

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

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