Inheritance diagram for SCR_MapCampaignUI:

Public Member Functions
void	InitMobileAssembly (string factionKey, bool deployed)

override void	UpdateIconPosition (Widget widget, SCR_MapUIElement icon, float x, float y)
	Offset task icon so it doesn't overlap with base icon.

void	RemoveSpawnPositionHint ()
	Called to hide Spawn Position hint if player is killed (or his entity disappear for some reason)

int	GetBases (out notnull array< SCR_CampaignMapUIBase > bases)
	Get all bases elements.

void	SetHoveredBase (SCR_CampaignMilitaryBaseComponent base)
	Sets provided base as hovered.

BaseHoveredInvoker	GetOnBaseHovered ()

ScriptInvokerVoid	GetOnBasesInited ()

void	OnMapZoom (float pixelPerUnit)

override void	OnMapOpen (MapConfiguration config)
	SCR_MapEntity event.

override void	OnMapClose (MapConfiguration config)
	SCR_MapEntity event.

void	~SCR_MapCampaignUI ()

Public Member Functions inherited from SCR_MapUIElementContainer
override void	Init ()
	Init method for cases where all modules and components should be loaded already so constructor cannot be used, called once after creation.

void	OnMapPan (float panX, float panY, bool adjustedPan)

void	RemoveIcon (SCR_MapUIElement icon)

void	OnSpawnPointSelectedExt (RplId id)

void	OnElementSelected (notnull SCR_MapUIElement element)

void	OnSpawnPointSelected (RplId spId=RplId.Invalid())

SCR_MapUISpawnPoint	FindSpawnPoint (RplId id)

ScriptInvoker	GetOnSpawnPointSelected ()

ScriptInvoker	GetOnElementSelected ()

SCR_TaskMapUIComponent	GetTaskFromID (string taskID)

Public Member Functions inherited from SCR_MapUIBaseComponent
bool	IsConfigDisabled ()

bool	IsExclusive ()

void	SetActive (bool active, bool isCleanup=false)
	Enable open/close events, called every time component is activated, usually on map open.

void	Update (float timeSlice)
	Update method for frame operations.

bool	IsToolMenuFocused ()

void	SCR_MapUIBaseComponent ()

Protected Member Functions
void	InitBases ()

override void	ShowSpawnPoint (notnull SCR_SpawnPoint spawnPoint)

void	CreatePlayerSpawnPositionHint ()

void	HideSpawnPositionHint (int layer)

override void	OnSpawnPointFactionChange (SCR_SpawnPoint spawnPoint)

Protected Member Functions inherited from SCR_MapUIElementContainer
void	AddSpawnPoint (SCR_SpawnPoint spawnPoint)

void	RemoveSpawnPoint (SCR_SpawnPoint spawnPoint)

void	UpdateSpawnPointName (RplId id, string name)

void	HideSpawnPoint (RplId spawnPointId)

void	OnPlayerFactionResponse (SCR_PlayerFactionAffiliationComponent component, int factionIndex, bool response)

void	UpdateIcons ()

void	InitSpawnPoints ()

void	InitTaskMarkers ()
	Creates task icon for every task which is visible on map for player.

void	InitTaskIcon (SCR_Task task)
	Creates map icon for task.

void	OnTaskAdded (SCR_Task task)
	Creates task icon when task is added.

void	OnTaskRemoved (notnull SCR_Task task)
	Remove task icon from map when task is removed from system.

void	RemoveAllIcons ()

SCR_MapUIElement	FindSpawnPointIconById (RplId id)

void	OnPlayerGroupChanged (SCR_AIGroup group)

Protected Attributes
ResourceName	m_sBaseElement

ResourceName	m_sServiceHint

ResourceName	m_sSpawnPositionHint

Widget	m_wMobileAssembly

ref ScriptInvokerVoid	m_OnBasesInited

ref BaseHoveredInvoker	m_OnBaseHovered

SCR_CampaignMilitaryBaseComponent	m_HoveredBase

Protected Attributes inherited from SCR_MapUIElementContainer
string	m_sIconsContainer

Widget	m_wIconsContainer

ResourceName	m_sSpawnPointElement

ResourceName	m_sTaskElement

ResourceName	m_sWarningWidget

Widget	m_wWarningWidget

bool	m_bShowSpawnPointsHint

bool	m_bShowSpawnPoints

bool	m_bShowTasks

bool	m_bShowAllTaskTypenames

ref array< string >	m_aAllowedTaskTypenames

bool	m_bIsEditor

bool	m_bIsDeployMap

ref map< Widget, SCR_MapUIElement >	m_mIcons = new map<Widget, SCR_MapUIElement>()

SCR_PlayerFactionAffiliationComponent	m_PlyFactionAffilComp

SCR_PlayerControllerGroupComponent	m_PlyGroupComp

SCR_BaseGameMode	m_GameMode

SCR_TaskSystem	m_TaskSystem

ref ScriptInvoker< SCR_MapUIElement >	m_OnElementSelected

ref ScriptInvoker< RplId >	m_OnSpawnPointSelected

Protected Attributes inherited from SCR_MapUIBaseComponent
bool	m_bDisableComponent

bool	m_bIsExclusive

bool	m_bHookToRoot = false

Widget	m_RootWidget

SCR_MapEntity	m_MapEntity

Static Protected Attributes
static const int	TASK_ICON_Y_OFFSET = 10

Constructor & Destructor Documentation

◆ ~SCR_MapCampaignUI()

void SCR_MapCampaignUI.~SCR_MapCampaignUI ( )

Member Function Documentation

◆ CreatePlayerSpawnPositionHint()

void SCR_MapCampaignUI.CreatePlayerSpawnPositionHint ( )

protected

◆ GetBases()

int SCR_MapCampaignUI.GetBases ( out notnull array< SCR_CampaignMapUIBase > bases )

Get all bases elements.

◆ GetOnBaseHovered()

BaseHoveredInvoker SCR_MapCampaignUI.GetOnBaseHovered ( )

Returns

◆ GetOnBasesInited()

ScriptInvokerVoid SCR_MapCampaignUI.GetOnBasesInited ( )

Returns

◆ HideSpawnPositionHint()

void SCR_MapCampaignUI.HideSpawnPositionHint ( int layer )

protected

◆ InitBases()

void SCR_MapCampaignUI.InitBases ( )

protected

◆ InitMobileAssembly()

void SCR_MapCampaignUI.InitMobileAssembly	(	string	factionKey,
		bool	deployed )

◆ OnMapClose()

override void SCR_MapCampaignUI.OnMapClose ( MapConfiguration config )

SCR_MapEntity event.

Parameters

[in] config

Implements SCR_MapUIElementContainer.

◆ OnMapOpen()

override void SCR_MapCampaignUI.OnMapOpen ( MapConfiguration config )

SCR_MapEntity event.

Parameters

[in] config

Implements SCR_MapUIElementContainer.

◆ OnMapZoom()

void SCR_MapCampaignUI.OnMapZoom ( float pixelPerUnit )

◆ OnSpawnPointFactionChange()

override void SCR_MapCampaignUI.OnSpawnPointFactionChange ( SCR_SpawnPoint spawnPoint )

protected

Implements SCR_MapUIElementContainer.

◆ RemoveSpawnPositionHint()

void SCR_MapCampaignUI.RemoveSpawnPositionHint ( )

Called to hide Spawn Position hint if player is killed (or his entity disappear for some reason)

◆ SetHoveredBase()

void SCR_MapCampaignUI.SetHoveredBase ( SCR_CampaignMilitaryBaseComponent base )

Sets provided base as hovered.

Parameters

[in] base

◆ ShowSpawnPoint()

override void SCR_MapCampaignUI.ShowSpawnPoint ( notnull SCR_SpawnPoint spawnPoint )

protected

Implements SCR_MapUIElementContainer.

◆ UpdateIconPosition()

override void SCR_MapCampaignUI.UpdateIconPosition	(	Widget	widget,
		SCR_MapUIElement	icon,
		float	x,
		float	y )

Offset task icon so it doesn't overlap with base icon.

Implements SCR_MapUIElementContainer.

Member Data Documentation

◆ m_HoveredBase

SCR_CampaignMilitaryBaseComponent SCR_MapCampaignUI.m_HoveredBase

protected

◆ m_OnBaseHovered

ref BaseHoveredInvoker SCR_MapCampaignUI.m_OnBaseHovered

protected

◆ m_OnBasesInited

ref ScriptInvokerVoid SCR_MapCampaignUI.m_OnBasesInited

protected

◆ m_sBaseElement

ResourceName SCR_MapCampaignUI.m_sBaseElement

protected

◆ m_sServiceHint

ResourceName SCR_MapCampaignUI.m_sServiceHint

protected

◆ m_sSpawnPositionHint

ResourceName SCR_MapCampaignUI.m_sSpawnPositionHint

protected

◆ m_wMobileAssembly

Widget SCR_MapCampaignUI.m_wMobileAssembly

protected

◆ TASK_ICON_Y_OFFSET

const int SCR_MapCampaignUI.TASK_ICON_Y_OFFSET = 10

staticprotected

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

Game/UI/Conflict/SCR_MapCampaignUI.c

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Constructor & Destructor Documentation

◆ ~SCR_MapCampaignUI()

Member Function Documentation

◆ CreatePlayerSpawnPositionHint()

◆ GetBases()

◆ GetOnBaseHovered()

◆ GetOnBasesInited()

◆ HideSpawnPositionHint()

◆ InitBases()

◆ InitMobileAssembly()

◆ OnMapClose()

◆ OnMapOpen()

◆ OnMapZoom()

◆ OnSpawnPointFactionChange()

◆ RemoveSpawnPositionHint()

◆ SetHoveredBase()

◆ ShowSpawnPoint()

◆ UpdateIconPosition()

Member Data Documentation

◆ m_HoveredBase

◆ m_OnBaseHovered

◆ m_OnBasesInited

◆ m_sBaseElement

◆ m_sServiceHint

◆ m_sSpawnPositionHint

◆ m_wMobileAssembly

◆ TASK_ICON_Y_OFFSET