SCR_MapCampaignUI Interface Reference

Inheritance diagram for SCR_MapCampaignUI:

Public Member Functions
void	InitMobileAssembly (string factionKey, bool deployed)
void	RemoveSpawnPositionHint ()
	Called to hide Spawn Position hint if player is killed (or his entity disappear for some reason)
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.
override void	OnMapOpen (MapConfiguration config)
	SCR_MapEntity event.
override void	OnMapClose (MapConfiguration config)
	SCR_MapEntity event.
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 ()
Public Member Functions inherited from SCR_MapUIBaseComponent
bool	IsConfigDisabled ()
void	SetActive (bool active, bool isCleanup=false)
	Enable open/close events, called every time component is activated, usually on map open.
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	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	OnSpawnPointFactionChange (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	ShowSpawnPoint (notnull SCR_SpawnPoint spawnPoint)
void	InitTaskMarkers ()
void	InitTaskIcon (SCR_BaseTask task)
void	OnTaskAdded (SCR_BaseTask task)
void	OnTaskRemoved (SCR_BaseTask task)
void	RemoveAllIcons ()
SCR_MapUIElement	FindSpawnPointIconById (RplId id)
void	OnPlayerGroupChanged (SCR_AIGroup group)
void	OnMapOpen (MapConfiguration config)
	SCR_MapEntity event.
void	OnMapClose (MapConfiguration config)
	SCR_MapEntity event.

Protected Attributes
ResourceName	m_sBaseElement
ResourceName	m_sServiceHint
ResourceName	m_sSpawnPositionHint
Widget	m_wMobileAssembly
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_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
ref ScriptInvoker< SCR_MapUIElement >	m_OnElementSelected
ref ScriptInvoker< RplId >	m_OnSpawnPointSelected
Protected Attributes inherited from SCR_MapUIBaseComponent
bool	m_bDisableComponent
bool	m_bHookToRoot = false
Widget	m_RootWidget
SCR_MapEntity	m_MapEntity

Constructor & Destructor Documentation

~SCR_MapCampaignUI()

void SCR_MapCampaignUI.~SCR_MapCampaignUI

(

)

Member Function Documentation

CreatePlayerSpawnPositionHint()

void SCR_MapCampaignUI.CreatePlayerSpawnPositionHint ( )

protected

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)

ShowSpawnPoint()

override void SCR_MapCampaignUI.ShowSpawnPoint ( notnull SCR_SpawnPoint  spawnPoint )

protected

Implements SCR_MapUIElementContainer.

Member Data Documentation

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

---

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

• Game/UI/Conflict/SCR_MapCampaignUI.c