SCR_TaskNotificationComponent Interface Reference

Inheritance diagram for SCR_TaskNotificationComponent:

Public Member Functions
SCR_CampaignFaction	GetFaction ()
override void	OnPostInit (IEntity owner)
override void	EOnInit (IEntity owner)
override void	OnDelete (IEntity owner)

Protected Member Functions
bool	HasGroupTask (SCR_TaskExecutor executor)
string	GetTaskName (SCR_Task task)
bool	IsPlayerGroupLeader (int playerID, notnull array< SCR_AIGroup > playableGroups)
void	SetGrid ()
void	OnTaskCreated (SCR_Task task, int byPlayerID)
void	OnTaskAssigneeAdded (SCR_Task task, SCR_TaskExecutor executor, int requesterID)
void	OnTaskStateChanged (SCR_Task task, SCR_ETaskState newState)
void	OnGroupTaskSet (SCR_Task task, int byPlayerID)
BaseTransceiver	GetHQTransceiver (notnull SCR_CampaignFaction faction)
BaseTransceiver	GetPlayerTransceiver (int playerId)
SCR_AIGroup	GetFirstAssignedGroup (notnull SCR_Task task)
void	SendMessageToGroup (SCR_ETaskNotification notificationType, SCR_ETaskNotificationMsg msgType, int callerPlayerId, BaseTransceiver transmitter, SCR_AIGroup receiverGroup, int baseCallsign=SCR_MilitaryBaseComponent.INVALID_BASE_CALLSIGN, int callerGroupId=-1, int calledGroupId=-1, int gridX=-1, int gridY=-1)

Protected Attributes
SCR_ETaskNotification	m_eTaskNotification
SCR_TaskSystem	m_TaskSystem
SCR_GroupsManagerComponent	m_GroupsManager
RplComponent	m_RplComponent
SCR_Task	m_Task
SCR_GroupTaskManagerComponent	m_GroupTaskManager
SCR_TaskNotificationManagerComponent	m_TaskNotificationManager
SCR_FactionManager	m_FactionManager
SCR_GameModeCampaign m_Campaign int	m_iGridX
int	m_iGridY

Static Protected Attributes
const bool	ALLOW_SEND_TO_EMPTY_GROUP = false

Member Function Documentation

EOnInit()

override void SCR_TaskNotificationComponent.EOnInit

(

IEntity

owner

)

Implemented in SCR_RequestedTaskNotificationComponent.

GetFaction()

SCR_CampaignFaction SCR_TaskNotificationComponent.GetFaction

(

)

Returns

campaign faction

GetFirstAssignedGroup()

SCR_AIGroup SCR_TaskNotificationComponent.GetFirstAssignedGroup ( notnull SCR_Task task )

protected

GetHQTransceiver()

BaseTransceiver SCR_TaskNotificationComponent.GetHQTransceiver ( notnull SCR_CampaignFaction faction )

protected

GetPlayerTransceiver()

BaseTransceiver SCR_TaskNotificationComponent.GetPlayerTransceiver ( int playerId )

protected

GetTaskName()

string SCR_TaskNotificationComponent.GetTaskName ( SCR_Task task )

protected

HasGroupTask()

bool SCR_TaskNotificationComponent.HasGroupTask ( SCR_TaskExecutor executor )

protected

IsPlayerGroupLeader()

bool SCR_TaskNotificationComponent.IsPlayerGroupLeader ( int playerID, notnull array< SCR_AIGroup > playableGroups )

protected

OnDelete()

override void SCR_TaskNotificationComponent.OnDelete

(

IEntity

owner

)

Implemented in SCR_RequestedTaskNotificationComponent.

OnGroupTaskSet()

void SCR_TaskNotificationComponent.OnGroupTaskSet ( SCR_Task task, int byPlayerID )

protected

OnPostInit()

override void SCR_TaskNotificationComponent.OnPostInit

(

IEntity

owner

)

OnTaskAssigneeAdded()

void SCR_TaskNotificationComponent.OnTaskAssigneeAdded ( SCR_Task task, SCR_TaskExecutor executor, int requesterID )

protected

Implemented in SCR_RequestedTaskNotificationComponent.

OnTaskCreated()

void SCR_TaskNotificationComponent.OnTaskCreated ( SCR_Task task, int byPlayerID )

protected

Implemented in SCR_RequestedTaskNotificationComponent.

OnTaskStateChanged()

void SCR_TaskNotificationComponent.OnTaskStateChanged ( SCR_Task task, SCR_ETaskState newState )

protected

Implemented in SCR_RequestedTaskNotificationComponent.

SendMessageToGroup()

void SCR_TaskNotificationComponent.SendMessageToGroup ( SCR_ETaskNotification notificationType, SCR_ETaskNotificationMsg msgType, int callerPlayerId, BaseTransceiver transmitter, SCR_AIGroup receiverGroup, int baseCallsign = SCR_MilitaryBaseComponent::INVALID_BASE_CALLSIGN, int callerGroupId = -1, int calledGroupId = -1, int gridX = -1, int gridY = -1 )

protected

SetGrid()

void SCR_TaskNotificationComponent.SetGrid ( )

protected

Member Data Documentation

ALLOW_SEND_TO_EMPTY_GROUP

const bool SCR_TaskNotificationComponent.ALLOW_SEND_TO_EMPTY_GROUP = false

staticprotected

m_eTaskNotification

SCR_ETaskNotification SCR_TaskNotificationComponent.m_eTaskNotification

protected

m_FactionManager

SCR_FactionManager SCR_TaskNotificationComponent.m_FactionManager

protected

m_GroupsManager

SCR_GroupsManagerComponent SCR_TaskNotificationComponent.m_GroupsManager

protected

m_GroupTaskManager

SCR_GroupTaskManagerComponent SCR_TaskNotificationComponent.m_GroupTaskManager

protected

m_iGridX

SCR_GameModeCampaign m_Campaign int SCR_TaskNotificationComponent.m_iGridX

protected

m_iGridY

int SCR_TaskNotificationComponent.m_iGridY

protected

m_RplComponent

RplComponent SCR_TaskNotificationComponent.m_RplComponent

protected

m_Task

SCR_Task SCR_TaskNotificationComponent.m_Task

protected

m_TaskNotificationManager

SCR_TaskNotificationManagerComponent SCR_TaskNotificationComponent.m_TaskNotificationManager

protected

m_TaskSystem

SCR_TaskSystem SCR_TaskNotificationComponent.m_TaskSystem

protected

---

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

• Game/Tasks/Notifications/SCR_TaskNotificationComponent.c