Inheritance diagram for SCR_TaskNotificationManagerComponent:

Public Member Functions
SCR_BaseTaskNotificationData	GetTaskNotificationData (SCR_ETaskNotification taskNotification, SCR_ETaskNotificationMsg taskNotificationMsg)

SCR_TaskNotificationConfig	GetTaskNotificationConfig (SCR_ETaskNotification taskNotification)

string	GetTaskNameWithBase (string taskName, notnull Faction faction, notnull SCR_CampaignMilitaryBaseComponent base)

string	GetTaskNameWithGrid (LocalizedString taskKey, int grid)

void	PlayTaskNotificationMsg (SCR_ETaskNotification taskNotification, SCR_ETaskNotificationMsg msg, int factionId, int baseCallsign, int callerGroupId, int calledGroupId, int grid, float quality)
	Play task notification message.

void	PlayVOTaskNotification (string soundEventName, int factionId, int baseCallsign, int callerGroupId, int calledGroupId, int gridX, int gridY, float quality)
	Play VO for task notification.

override void	EOnInit (IEntity owner)

override void	OnPostInit (IEntity owner)

void	SCR_TaskNotificationManagerComponent (IEntityComponentSource src, IEntity ent, IEntity parent)

Public Member Functions inherited from SCR_BaseGameModeComponent
SCR_BaseGameMode	GetGameMode ()

void	OnGameEnd ()
	Called on all machines when the world ends.

void	OnGameStateChanged (SCR_EGameModeState state)
	Called when game mode state changes called on all machines.

void	OnGameModeStart ()
	Called on every machine when game mode starts.

void	OnGameModeEnd (SCR_GameModeEndData data)
	Called when game mode ends.

void	OnPlayerConnected (int playerId)
	Called after a player is connected.

void	OnPlayerAuditSuccess (int playerId)
	Event is called when player connecting Session hosting current Game Mode where is required authentication verification via.

void	OnPlayerAuditFail (int playerId)
	Event is called when player connecting Session hosting current Game Mode AuditFail() call may be called under two occasions: 1) verification is required but failed (account is not valid, player is banned, internet issues) 2) player cannot be verified as authentication is not required or possible - where it may be valid behavior (server online connectivity turned off for example) Basically non-audited player cannot access persistency/ etc.

void	OnPlayerAuditTimeouted (int playerId)
	Event is called when player connected to Session was kicked and did not reconnected in time This mean that slot reservation can be canceled.

void	OnPlayerAuditRevived (int playerId)
	Event is called when player reconnected successfully back to Session after kick This mean that slot reservation need to be finished (closed).

void	OnPlayerRegistered (int playerId)
	Called on every machine after a player is registered (identity, name etc.).

void	OnPlayerDisconnected (int playerId, KickCauseCode cause, int timeout)
	Called after a player is disconnected.

bool	PreparePlayerEntity_S (SCR_SpawnRequestComponent requestComponent, SCR_SpawnHandlerComponent handlerComponent, SCR_SpawnData data, IEntity entity)

void	OnSpawnPlayerEntityFailure_S (SCR_SpawnRequestComponent requestComponent, SCR_SpawnHandlerComponent handlerComponent, IEntity entity, SCR_SpawnData data, SCR_ESpawnResult reason)

void	OnPlayerSpawnFinalize_S (SCR_SpawnRequestComponent requestComponent, SCR_SpawnHandlerComponent handlerComponent, SCR_SpawnData data, IEntity entity)

bool	HandlePlayerKilled (int playerId, IEntity playerEntity, IEntity killerEntity, notnull Instigator instigator)
	See SCR_BaseGameMode.HandlePlayerKilled.

void	OnPlayerKilled (notnull SCR_InstigatorContextData instigatorContextData)
	Called after a player gets killed.

void	OnPlayerKilledHandled (int playerId, IEntity playerEntity, IEntity killerEntity, notnull Instigator instigator)
	Called after player gets killed in cases where the kill was handled by the game mode, supressing the default OnPlayerKilled behaviour.

void	OnPlayerDeleted (int playerId, IEntity player)
	Called after a player gets deleted.

void	OnPlayerRoleChange (int playerId, EPlayerRole roleFlags)
	Called when player role changes.

void	OnWorldPostProcess (World world)
	Called once loading of all entities of the world have been finished (still within the loading)

void	OnControllableSpawned (IEntity entity)
	When a controllable entity is spawned, this event is raised.

void	OnControllableDestroyed (notnull SCR_InstigatorContextData instigatorContextData)
	When a controllable entity is destroyed, this event is raised.

void	OnControllableDeleted (IEntity entity)
	Prior to a controllable entity being DELETED, this event is raised.

void	SCR_BaseGameModeComponent (IEntityComponentSource src, IEntity ent, IEntity parent)

Static Public Member Functions
static SCR_TaskNotificationManagerComponent	GetInstance ()

Protected Member Functions
void	PopupMsg (string text, int prio=-1, string param1="", string param2="", string sound="", bool isFriendly=true)

void	PlayVONotification (string soundEventName, int factionId, int baseCallsign=SCR_MilitaryBaseComponent.INVALID_BASE_CALLSIGN, int callerGroupId=-1, int calledGroupId=-1, int grid=-1, float quality=0.5)

Protected Attributes
ref SCR_TaskNotificationsRootConfig	m_TaskNotificationsConfig

SimpleSoundComponent	m_SimpleSoundComponent

SCR_GroupsManagerComponent	m_GroupsManager

SCR_GameModeCampaign	m_Campaign

SCR_FactionManager	m_FactionManager

SCR_CallsignManagerComponent	m_CallsignManager

ref map< SCR_ETaskNotification, WorldTimestamp >	m_mNotificationIntervalMap = new map<SCR_ETaskNotification, WorldTimestamp>()

Protected Attributes inherited from SCR_BaseGameModeComponent
SCR_BaseGameMode	m_pGameMode
	The game mode entity this component is attached to.

Static Protected Attributes
static SCR_TaskNotificationManagerComponent	s_Instance

const int	POPUP_DURATION = 6

const bool	SHOW_ENEMY_MAJOR_TEXT_NOTIFICATION = false

const bool	SHOW_ENEMY_MINOR_TEXT_NOTIFICATION = false

const string	GRID_FORMAT = "%1 %2"

Constructor & Destructor Documentation

◆ SCR_TaskNotificationManagerComponent()

void SCR_TaskNotificationManagerComponent.SCR_TaskNotificationManagerComponent	(	IEntityComponentSource	src,
		IEntity	ent,
		IEntity	parent )

Parameters

[in]	src
[in]	ent
[in]	parent

Member Function Documentation

◆ EOnInit()

override void SCR_TaskNotificationManagerComponent.EOnInit ( IEntity owner )

◆ GetInstance()

static SCR_TaskNotificationManagerComponent SCR_TaskNotificationManagerComponent.GetInstance ( )

static

Returns: instance of SCR_TaskNotificationManagerComponent

◆ GetTaskNameWithBase()

string SCR_TaskNotificationManagerComponent.GetTaskNameWithBase	(	string	taskName,
		notnull Faction	faction,
		notnull SCR_CampaignMilitaryBaseComponent	base )

Parameters

[in]	taskName
[in]	faction
[in]	base

Returns: task name with formatted base name

◆ GetTaskNameWithGrid()

string SCR_TaskNotificationManagerComponent.GetTaskNameWithGrid	(	LocalizedString	taskKey,
		int	grid )

Parameters

[in]	taskKey
[in]	grid

Returns: task name with formatted grid coordinates

◆ GetTaskNotificationConfig()

SCR_TaskNotificationConfig SCR_TaskNotificationManagerComponent.GetTaskNotificationConfig ( SCR_ETaskNotification taskNotification )

Parameters

[in] taskNotification

Returns: task notification config

◆ GetTaskNotificationData()

SCR_BaseTaskNotificationData SCR_TaskNotificationManagerComponent.GetTaskNotificationData	(	SCR_ETaskNotification	taskNotification,
		SCR_ETaskNotificationMsg	taskNotificationMsg )

Parameters

[in]	taskNotification
[in]	taskNotificationMsg

Returns: task notification data

◆ OnPostInit()

override void SCR_TaskNotificationManagerComponent.OnPostInit ( IEntity owner )

◆ PlayTaskNotificationMsg()

void SCR_TaskNotificationManagerComponent.PlayTaskNotificationMsg	(	SCR_ETaskNotification	taskNotification,
		SCR_ETaskNotificationMsg	msg,
		int	factionId,
		int	baseCallsign,
		int	callerGroupId,
		int	calledGroupId,
		int	grid,
		float	quality )

Play task notification message.

Parameters

[in]	taskNotification
[in]	msg
[in]	factionId
[in]	baseCallsign
[in]	callerGroupId
[in]	calledGroupId
[in]	grid
[in]	quality

◆ PlayVONotification()

void SCR_TaskNotificationManagerComponent.PlayVONotification	(	string	soundEventName,
		int	factionId,
		int	baseCallsign = SCR_MilitaryBaseComponent::INVALID_BASE_CALLSIGN,
		int	callerGroupId = -1,
		int	calledGroupId = -1,
		int	grid = -1,
		float	quality = 0::5 )

protected

◆ PlayVOTaskNotification()

void SCR_TaskNotificationManagerComponent.PlayVOTaskNotification	(	string	soundEventName,
		int	factionId,
		int	baseCallsign,
		int	callerGroupId,
		int	calledGroupId,
		int	gridX,
		int	gridY,
		float	quality )

Play VO for task notification.

Parameters

[in]	soundEventName
[in]	factionId
[in]	baseCallsign
[in]	callerGroupId
[in]	calledGroupId
[in]	gridX
[in]	gridY
[in]	quality

◆ PopupMsg()

void SCR_TaskNotificationManagerComponent.PopupMsg	(	string	text,
		int	prio = -1,
		string	param1 = "",
		string	param2 = "",
		string	sound = "",
		bool	isFriendly = true )

protected

Member Data Documentation

◆ GRID_FORMAT

const string SCR_TaskNotificationManagerComponent.GRID_FORMAT = "%1 %2"

staticprotected

◆ m_CallsignManager

SCR_CallsignManagerComponent SCR_TaskNotificationManagerComponent.m_CallsignManager

protected

◆ m_Campaign

SCR_GameModeCampaign SCR_TaskNotificationManagerComponent.m_Campaign

protected

◆ m_FactionManager

SCR_FactionManager SCR_TaskNotificationManagerComponent.m_FactionManager

protected

◆ m_GroupsManager

SCR_GroupsManagerComponent SCR_TaskNotificationManagerComponent.m_GroupsManager

protected

◆ m_mNotificationIntervalMap

ref map<SCR_ETaskNotification, WorldTimestamp> SCR_TaskNotificationManagerComponent.m_mNotificationIntervalMap = new map<SCR_ETaskNotification, WorldTimestamp>()

protected

◆ m_SimpleSoundComponent

SimpleSoundComponent SCR_TaskNotificationManagerComponent.m_SimpleSoundComponent

protected

◆ m_TaskNotificationsConfig

ref SCR_TaskNotificationsRootConfig SCR_TaskNotificationManagerComponent.m_TaskNotificationsConfig

protected

◆ POPUP_DURATION

const int SCR_TaskNotificationManagerComponent.POPUP_DURATION = 6

staticprotected

◆ s_Instance

SCR_TaskNotificationManagerComponent SCR_TaskNotificationManagerComponent.s_Instance

staticprotected

◆ SHOW_ENEMY_MAJOR_TEXT_NOTIFICATION

const bool SCR_TaskNotificationManagerComponent.SHOW_ENEMY_MAJOR_TEXT_NOTIFICATION = false

staticprotected

◆ SHOW_ENEMY_MINOR_TEXT_NOTIFICATION

const bool SCR_TaskNotificationManagerComponent.SHOW_ENEMY_MINOR_TEXT_NOTIFICATION = false

staticprotected

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

Game/Tasks/Notifications/SCR_TaskNotificationManagerComponent.c

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Constructor & Destructor Documentation

◆ SCR_TaskNotificationManagerComponent()

Member Function Documentation

◆ EOnInit()

◆ GetInstance()

◆ GetTaskNameWithBase()

◆ GetTaskNameWithGrid()

◆ GetTaskNotificationConfig()

◆ GetTaskNotificationData()

◆ OnPostInit()

◆ PlayTaskNotificationMsg()

◆ PlayVONotification()

◆ PlayVOTaskNotification()

◆ PopupMsg()

Member Data Documentation

◆ GRID_FORMAT

◆ m_CallsignManager

◆ m_Campaign

◆ m_FactionManager

◆ m_GroupsManager

◆ m_mNotificationIntervalMap

◆ m_SimpleSoundComponent

◆ m_TaskNotificationsConfig

◆ POPUP_DURATION

◆ s_Instance

◆ SHOW_ENEMY_MAJOR_TEXT_NOTIFICATION

◆ SHOW_ENEMY_MINOR_TEXT_NOTIFICATION