SCR_CampaignLogisticMapUIBase Interface Reference

Inheritance diagram for SCR_CampaignLogisticMapUIBase:

Public Member Functions
bool	IsSelected ()
bool	IsOpened ()
override bool	OnClick (Widget w, int x, int y, int button)
override bool	OnMouseEnter (Widget w, int x, int y)
override void	InitBase (SCR_CampaignMilitaryBaseComponent base)
override void	Select (bool select=true)
override bool	OnMouseLeave (Widget w, Widget enterW, int x, int y)
override void	HandlerAttached (Widget w)
override void	HandlerDeattached (Widget w)
Public Member Functions inherited from SCR_CampaignMapUIBase
ScriptInvoker	GetOnMapIconEnter ()
ScriptInvoker	GetOnMapIconClick ()
int	GetBaseIconSize ()
override void	SelectIcon (bool invoke=true)
void	FlashBaseIcon (Faction faction=null, bool changeToDefault=false)
override void	AnimExpand ()
override void	AnimCollapse ()
void	ShowServiceHint (string name, string text, bool show, int suppliesAmount=-1, int suppliesMax=-1)
void	OnMapCloseInvoker (MapConfiguration config)
void	RemoveHint ()
void	SetIconInfoText ()
void	InitServices ()
void	UpdateBaseIcon (int id)
void	InitMobile (SCR_CampaignMobileAssemblyStandaloneComponent assembly)
void	ChangeBaseIconSize ()
override void	ShowName (bool visible)
override vector	GetPos ()
void	ChangeNameSize (bool visible)
void	ChangeNameSizeOnLayerChange (int layer)
string	GetFactionKey ()
Color	GetFactionColor ()
SCR_CampaignMilitaryBaseComponent	GetBase ()
void	SetBaseIconFactionColor (Faction faction)
override void	SetImage (string image)
override RplId	GetSpawnPointId ()
void	SetAntennaIconVisible (bool visible)
void	~SCR_CampaignMapUIBase ()
Public Member Functions inherited from SCR_MapUIElement
void	SetParent (SCR_MapUIElementContainer parent)
string	GetName ()
bool	GetIconVisible ()
void	SetVisible (bool visible)
Widget	GetRoot ()
Color	GetColorForFaction (string factionKey)
void	SetName (string name)
Public Member Functions inherited from SCR_ScriptedWidgetComponent
Widget	GetRootWidget ()
bool	IsVisible ()

Static Public Member Functions
static ScriptInvokerBool	GetOnBaseSelected ()
Static Public Member Functions inherited from SCR_ScriptedWidgetComponent
static SCR_ScriptedWidgetComponent	GetComponent (TypeName componentType, string name, Widget parent, bool searchAllChildren=true)
	Base method for component lookup through the widget library.

Static Public Attributes
const string	LOGISTIC_CLOSE_ACTION_NAME = "LogisticClose"
Static Public Attributes inherited from SCR_CampaignMapUIBase
static ref ScriptInvoker	Event_OnIconUpdated = new ScriptInvoker()

Protected Member Functions
override bool	CanShowOpenButton ()
bool	CanOpenExtendedInfoWrapper ()
void	OpenExtendedInfoWrapper ()
override void	OnOpenButtonActivated (SCR_InputButtonComponent button, string action)
void	OnLogisticClose ()
void	OnSupplyLimitChanged (SCR_SliderComponent sliderComponent, float value)
void	OnReservedSupplyAmountChanged (SCR_SliderComponent sliderComponent, float value)
void	UpdateSliderDisplayValue (SCR_SliderComponent slider)
	Multiplies the slider value with the max amount of supplies of base.
void	OnPriorityButtonToggled (notnull SCR_ModularButtonComponent newPriorityButton, bool isOn)
void	OnSwitchPriorityButton ()
void	SetPriorityButtonsState (notnull SCR_ModularButtonComponent newPriorityButton)
void	SetSupplyRequestExecutionPriority (int priority)
void	SetPriorityButtonWidgetsVisibility (bool isVisible)
void	UpdatePriorityWidgetsValues (int priority)
void	SetNextShipmentText ()
Protected Member Functions inherited from SCR_CampaignMapUIBase
void	SelectBase ()
void	OnLeave ()
void	InitOpenButton (Widget w)
void	DeinitOpenButton (Widget w)
void	FocusOnBase (SCR_SpawnPoint sp)
void	OnSelected (SCR_SpawnPoint sp)
void	ShowServices (bool show)
void	ShowBase (bool show)
void	UpdateIconAndText ()
void	InitBaseIcon ()
void	UpdateResources ()
void	UpdateAssemblyIcon ()
void	SetIconFaction (Faction faction)
void	SetBaseImage ()
void	OnMapClose (MapConfiguration config)
void	SetIconName (string name)
void	CheckIfCanRespawn ()
void	SetBaseType (SCR_ECampaignBaseType type)
void	SetBaseServices (SCR_CampaignMilitaryBaseComponent base)
void	OnGroupRallyPointChanged (SCR_AIGroup group)
void	SetRallyPointVisibility (SCR_AIGroup playerGroup=null)
void	SetRallyPointVisible (bool visible)
Protected Member Functions inherited from SCR_MapUIElement
void	PlayHoverSound (string sound)

Protected Attributes
string	m_sPriorityTextWidgetName
string	m_sSupplyLimitSliderName
string	m_sExtendedInfoWrapperName
string	m_sPriorityButtonsWrapperName
string	m_sCloseButtonName
string	m_sSwitchPriorityButtonName
string	m_sPriorityButton1Name
string	m_sPriorityButton2Name
string	m_sPriorityButton3Name
string	m_sReservedSupplyAmountSliderName
string	m_sPriorityWrapperName
string	m_sNextShipmentWrapperName
string	m_sNextShipmentTextName
float	m_fNextShipmentTextUpdatePeriod
SCR_SliderComponent	m_SupplyLimitSlider
SCR_SliderComponent	m_ReservedSupplyAmountSlider
SCR_MapEntity	m_MapEntity
Widget	m_wExtendedInfoWrapper
Widget	m_wPriorityButtonsWrapper
SCR_InputButtonComponent	m_CloseButton
SCR_InputButtonComponent	m_SwitchPriorityButton
ref array< SCR_ModularButtonComponent >	m_aPriorityButtons = {}
TextWidget	m_wPriorityTextWidget
Widget	m_wPriorityButtonWidget1
Widget	m_wPriorityButtonWidget2
Widget	m_wPriorityButtonWidget3
Widget	m_wPriorityWrapper
Widget	m_wNextShipmentWrapper
TextWidget	m_wNextShipmentText
Widget	m_wSupplyLimitSliderWidget
Protected Attributes inherited from SCR_CampaignMapUIBase
ResourceName	m_sServiceElement
ResourceName	m_sServiceHint
ResourceName	m_sSupplyIcon
string	m_sOpenButtonName
int	m_iServicesPadding = 0
float	m_fNameOffset = 2
ref map< EEditableEntityLabel, SCR_ServicePointDelegateComponent >	m_mServices = new map<EEditableEntityLabel, SCR_ServicePointDelegateComponent>()
SCR_CampaignMilitaryBaseComponent	m_Base
string	m_sFactionKey
SCR_CampaignFaction	m_PlayerFaction
SCR_CampaignMobileAssemblyStandaloneComponent	m_MobileAssembly
SCR_ResourceComponent	m_ResourceComponent
SCR_ResourceConsumer	m_ResourceConsumer
ref SCR_ResourceSystemSubscriptionHandleBase	m_ResourceSubscriptionHandleConsumer
RplId	m_ResourceInventoryPlayerComponentRplId
SizeLayoutWidget	m_wImageOverlay
Widget	m_wBaseFrame
Widget	m_wBaseIcon
Widget	m_wBaseOverlay
Widget	m_wInfoOverlay
Widget	m_wServices
TextWidget	m_w_NameDialog
Widget	m_w_ServicesOverlay
Widget	m_wOpenButton
SCR_InputButtonComponent	m_OpenInputButtonComponent
TextWidget	m_wBaseName
TextWidget	m_wCallsignName
TextWidget	m_wBaseNameDialog
TextWidget	m_wCallsignNameDialog
TextWidget m_wSuppliesText Widget	m_wInfoText
Widget	m_wAntennaImg
Widget	m_wRallyPointIconTop
Widget	m_wRallyPointIconBalancer
Widget	m_wRallyPointIconBottom
TextWidget	m_wRallyPointText
LocalizedString	m_sRallyPointText = "#AR-RallyPoint_Name"
int	m_iBaseSize = 80
int	m_iDefBaseSize = 46
int	m_iMaxBaseSize = 80
int	m_iDefHQSize = 88
int	m_iDefRelaySize = 64
ImageWidget	m_wLocalTask
LocalizedString	m_sAssembly = "#AR-Vehicle_MobileAssembly_Name"
ref ScriptInvoker	m_OnBaseSelected = new ScriptInvoker()
ref ScriptInvoker	m_OnMapIconEnter
ref ScriptInvoker	m_OnMapIconClick
bool	m_bServicesShown
bool	m_bCanRespawn
bool	m_bIsRespawnMenu
bool	m_bIsEditor
bool	m_bCanPlaySounds = true
SCR_SpawnPoint	m_SpawnPoint
Protected Attributes inherited from SCR_CampaignMapUIElement
string	m_sArmory
string	m_sFuelDepot
string	m_sLightVehicleDepot
string	m_sHeavyVehicleDepot
string	m_sRadioAntenna
string	m_sFieldHospital
string	m_sBarracks
string	m_sSupplyDepot
string	m_sVehicleDepot
string	m_sHelipad
string	m_sFactionNeutral
string	m_sRelay
string	m_sBase
string	m_sSourceBase
string	m_sMobileAssembly
string	m_sMajorBase
string	m_sMinorBase
string	m_sSmallBase
string	m_sRespawn
string	m_sRespawnBackground
string	m_sSelection
ResourceName	m_sImageSet
Protected Attributes inherited from SCR_MapUIElement
SCR_MapUIElementContainer	m_Parent
MapItem	m_MapItem
ImageWidget	m_wImage
ImageWidget	m_wGradient
ImageWidget	m_wSelectImg
ImageWidget	m_wHighlightImg
bool	m_bIsSelected
SCR_EIconType	m_eIconType
bool	m_bVisible = false
ResourceName	m_sImageSetARO
ResourceName	m_sImageSetSpecial
bool	m_bUseBackgroundGradient
string	m_sSoundBase
string	m_sSoundEnemyBase
string	m_sSoundRelay
string	m_sSoundTask
string	m_sSoundService
string	m_sSoundHover
string	m_sName
Protected Attributes inherited from SCR_ScriptedWidgetComponent
Widget	m_wRoot

Static Protected Attributes
static ref ScriptInvokerBool	s_OnBaseSelected
static const LocalizedString	NEXT_SHIPMENT_ETA = "#AR-FactionCommander_LogisticUIBaseNextShipmentETA"
Static Protected Attributes inherited from SCR_CampaignMapUIBase
static const float	OPACITY_DISABLED = 0.5
static const float	OPACITY_UNSELECTED = 0.9
static Widget	m_wServiceHint
Static Protected Attributes inherited from SCR_MapUIElement
static SCR_MapUIElement	s_SelectedElement
const float	ANIM_SPEED = 20

Additional Inherited Members
Public Attributes inherited from SCR_CampaignMapUIBase
bool	m_bHighlighted
bool	m_bIsAnyElementHovered
bool	m_bIsAnyElementClicked
Public Attributes inherited from SCR_MapUIElement
ref Color	m_UnknownFactionColor
Public Attributes inherited from SCR_ScriptedWidgetComponent
ref ScriptInvoker	m_OnClick = new ScriptInvoker

Member Function Documentation

CanOpenExtendedInfoWrapper()

bool SCR_CampaignLogisticMapUIBase.CanOpenExtendedInfoWrapper ( )

protected

CanShowOpenButton()

override bool SCR_CampaignLogisticMapUIBase.CanShowOpenButton ( )

protected

Implements SCR_CampaignMapUIBase.

GetOnBaseSelected()

static ScriptInvokerBool SCR_CampaignLogisticMapUIBase.GetOnBaseSelected ( )

static

HandlerAttached()

override void SCR_CampaignLogisticMapUIBase.HandlerAttached

(

Widget

w

)

Implements SCR_CampaignMapUIBase.

HandlerDeattached()

override void SCR_CampaignLogisticMapUIBase.HandlerDeattached

(

Widget

w

)

Implements SCR_CampaignMapUIBase.

InitBase()

override void SCR_CampaignLogisticMapUIBase.InitBase

(

SCR_CampaignMilitaryBaseComponent

base

)

Parameters

[in]

base

Implements SCR_CampaignMapUIBase.

IsOpened()

bool SCR_CampaignLogisticMapUIBase.IsOpened

(

)

IsSelected()

bool SCR_CampaignLogisticMapUIBase.IsSelected

(

)

OnClick()

override bool SCR_CampaignLogisticMapUIBase.OnClick	(	Widget	w,
		int	x,
		int	y,
		int	button )

Implements SCR_CampaignMapUIBase.

OnLogisticClose()

void SCR_CampaignLogisticMapUIBase.OnLogisticClose ( )

protected

OnMouseEnter()

override bool SCR_CampaignLogisticMapUIBase.OnMouseEnter	(	Widget	w,
		int	x,
		int	y )

Implements SCR_CampaignMapUIBase.

OnMouseLeave()

override bool SCR_CampaignLogisticMapUIBase.OnMouseLeave	(	Widget	w,
		Widget	enterW,
		int	x,
		int	y )

Implements SCR_CampaignMapUIBase.

OnOpenButtonActivated()

override void SCR_CampaignLogisticMapUIBase.OnOpenButtonActivated ( SCR_InputButtonComponent button, string action )

protected

Implements SCR_CampaignMapUIBase.

OnPriorityButtonToggled()

void SCR_CampaignLogisticMapUIBase.OnPriorityButtonToggled ( notnull SCR_ModularButtonComponent newPriorityButton, bool isOn )

protected

OnReservedSupplyAmountChanged()

void SCR_CampaignLogisticMapUIBase.OnReservedSupplyAmountChanged ( SCR_SliderComponent sliderComponent, float value )

protected

OnSupplyLimitChanged()

void SCR_CampaignLogisticMapUIBase.OnSupplyLimitChanged ( SCR_SliderComponent sliderComponent, float value )

protected

OnSwitchPriorityButton()

void SCR_CampaignLogisticMapUIBase.OnSwitchPriorityButton ( )

protected

OpenExtendedInfoWrapper()

void SCR_CampaignLogisticMapUIBase.OpenExtendedInfoWrapper ( )

protected

Select()

override void SCR_CampaignLogisticMapUIBase.Select

(

bool

select = true

)

Implements SCR_MapUIElement.

SetNextShipmentText()

void SCR_CampaignLogisticMapUIBase.SetNextShipmentText ( )

protected

SetPriorityButtonsState()

void SCR_CampaignLogisticMapUIBase.SetPriorityButtonsState ( notnull SCR_ModularButtonComponent newPriorityButton )

protected

SetPriorityButtonWidgetsVisibility()

void SCR_CampaignLogisticMapUIBase.SetPriorityButtonWidgetsVisibility ( bool isVisible )

protected

SetSupplyRequestExecutionPriority()

void SCR_CampaignLogisticMapUIBase.SetSupplyRequestExecutionPriority ( int priority )

protected

UpdatePriorityWidgetsValues()

void SCR_CampaignLogisticMapUIBase.UpdatePriorityWidgetsValues ( int priority )

protected

UpdateSliderDisplayValue()

void SCR_CampaignLogisticMapUIBase.UpdateSliderDisplayValue ( SCR_SliderComponent slider )

protected

Multiplies the slider value with the max amount of supplies of base.

Member Data Documentation

LOGISTIC_CLOSE_ACTION_NAME

const string SCR_CampaignLogisticMapUIBase.LOGISTIC_CLOSE_ACTION_NAME = "LogisticClose"

static

m_aPriorityButtons

ref array<SCR_ModularButtonComponent> SCR_CampaignLogisticMapUIBase.m_aPriorityButtons = {}

protected

m_CloseButton

SCR_InputButtonComponent SCR_CampaignLogisticMapUIBase.m_CloseButton

protected

m_fNextShipmentTextUpdatePeriod

float SCR_CampaignLogisticMapUIBase.m_fNextShipmentTextUpdatePeriod

protected

m_MapEntity

SCR_MapEntity SCR_CampaignLogisticMapUIBase.m_MapEntity

protected

m_ReservedSupplyAmountSlider

SCR_SliderComponent SCR_CampaignLogisticMapUIBase.m_ReservedSupplyAmountSlider

protected

m_sCloseButtonName

string SCR_CampaignLogisticMapUIBase.m_sCloseButtonName

protected

m_sExtendedInfoWrapperName

string SCR_CampaignLogisticMapUIBase.m_sExtendedInfoWrapperName

protected

m_sNextShipmentTextName

string SCR_CampaignLogisticMapUIBase.m_sNextShipmentTextName

protected

m_sNextShipmentWrapperName

string SCR_CampaignLogisticMapUIBase.m_sNextShipmentWrapperName

protected

m_sPriorityButton1Name

string SCR_CampaignLogisticMapUIBase.m_sPriorityButton1Name

protected

m_sPriorityButton2Name

string SCR_CampaignLogisticMapUIBase.m_sPriorityButton2Name

protected

m_sPriorityButton3Name

string SCR_CampaignLogisticMapUIBase.m_sPriorityButton3Name

protected

m_sPriorityButtonsWrapperName

string SCR_CampaignLogisticMapUIBase.m_sPriorityButtonsWrapperName

protected

m_sPriorityTextWidgetName

string SCR_CampaignLogisticMapUIBase.m_sPriorityTextWidgetName

protected

m_sPriorityWrapperName

string SCR_CampaignLogisticMapUIBase.m_sPriorityWrapperName

protected

m_sReservedSupplyAmountSliderName

string SCR_CampaignLogisticMapUIBase.m_sReservedSupplyAmountSliderName

protected

m_sSupplyLimitSliderName

string SCR_CampaignLogisticMapUIBase.m_sSupplyLimitSliderName

protected

m_sSwitchPriorityButtonName

string SCR_CampaignLogisticMapUIBase.m_sSwitchPriorityButtonName

protected

m_SupplyLimitSlider

SCR_SliderComponent SCR_CampaignLogisticMapUIBase.m_SupplyLimitSlider

protected

m_SwitchPriorityButton

SCR_InputButtonComponent SCR_CampaignLogisticMapUIBase.m_SwitchPriorityButton

protected

m_wExtendedInfoWrapper

Widget SCR_CampaignLogisticMapUIBase.m_wExtendedInfoWrapper

protected

m_wNextShipmentText

TextWidget SCR_CampaignLogisticMapUIBase.m_wNextShipmentText

protected

m_wNextShipmentWrapper

Widget SCR_CampaignLogisticMapUIBase.m_wNextShipmentWrapper

protected

m_wPriorityButtonsWrapper

Widget SCR_CampaignLogisticMapUIBase.m_wPriorityButtonsWrapper

protected

m_wPriorityButtonWidget1

Widget SCR_CampaignLogisticMapUIBase.m_wPriorityButtonWidget1

protected

m_wPriorityButtonWidget2

Widget SCR_CampaignLogisticMapUIBase.m_wPriorityButtonWidget2

protected

m_wPriorityButtonWidget3

Widget SCR_CampaignLogisticMapUIBase.m_wPriorityButtonWidget3

protected

m_wPriorityTextWidget

TextWidget SCR_CampaignLogisticMapUIBase.m_wPriorityTextWidget

protected

m_wPriorityWrapper

Widget SCR_CampaignLogisticMapUIBase.m_wPriorityWrapper

protected

m_wSupplyLimitSliderWidget

Widget SCR_CampaignLogisticMapUIBase.m_wSupplyLimitSliderWidget

protected

NEXT_SHIPMENT_ETA

const LocalizedString SCR_CampaignLogisticMapUIBase.NEXT_SHIPMENT_ETA = "#AR-FactionCommander_LogisticUIBaseNextShipmentETA"

staticprotected

s_OnBaseSelected

ref ScriptInvokerBool SCR_CampaignLogisticMapUIBase.s_OnBaseSelected

staticprotected

---

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

• Game/UI/Conflict/SCR_CampaignLogisticMapUIBase.c