SCR_AIGroupUtilityComponent.c File Reference

Go to the source code of this file.

Data Structures
class	SCR_AIGroupUtilityComponentClass

Typedefs
typedef func	ScriptInvoker_GroupMoveFailed_Callback
typedef ScriptInvokerBase< ScriptInvoker_GroupMoveFailed_Callback >	ScriptInvoker_GroupMoveFailed

Functions
void	ScriptInvoker_GroupMoveFailed_Callback (int moveResult, IEntity vehicleUsed, bool isWaypointRelated, vector moveLocation)
SCR_AIActionBase	EvaluateActivity (out bool restartActivity)
void	OnAgentAdded (AIAgent agent)
void	OnAgentRemoved (SCR_AIGroup group, AIAgent agent)
void	OnWaypointCompleted (AIWaypoint waypoint)
void	OnWaypointRemoved (AIWaypoint waypoint, bool isCurrentWaypoint)
void	OnCurrentWaypointChanged (AIWaypoint currentWp, AIWaypoint prevWp)
void	OnExecuteWaypointTree ()
void	OnEnemyDetectedFiltered (SCR_AIGroup group, SCR_AITargetInfo target, AIAgent reporter)
	Called from m_Perception. More...
void	OnTargetClusterStateChanged (SCR_AITargetClusterState state, EAITargetClusterState prevState, EAITargetClusterState newState)
void	CancelActivitiesRelatedToWaypoint (notnull AIWaypoint waypoint, typename activityType=typename.Empty)
protected bool	CanRebalanceFireteams ()
	Determines when we can rebalance fireteams. We don't want to do that when fighting for example. More...
void	OnMoveFailed (int moveResult, IEntity vehicleUsed, bool isWaypointReleated, vector moveLocation)
ScriptInvoker_GroupMoveFailed	GetOnMoveFailed ()
override void	EOnInit (IEntity owner)
override void	EOnDiag (IEntity owner, float timeSlice)
void	UpdateGroupControlMode (SCR_AIActionBase currentAction)
void	UpdateClustersState (float deltaTime_ms)
bool	IsPositionAllowed (vector pos)

Variables
SCR_AIGroupUtilityComponentClass	m_Owner
SCR_AIConfigComponent	m_ConfigComponent
SCR_AIGroupInfoComponent	m_GroupInfo
SCR_MailboxComponent	m_Mailbox
ref array< SCR_AIInfoComponent >	m_aInfoComponents = {}
ref ScriptInvoker_GroupMoveFailed	m_OnMoveFailed
protected float	m_fLastUpdateTime = -1.0
protected float	m_fPerceptionUpdateTimer_ms
const protected float	PERCEPTION_UPDATE_TIMER_MS = 2000.0
protected bool	m_bNewGroupMemberAdded
protected ref SCR_AIActionBase	m_CurrentActivity
protected ref SCR_AIWaypointState	m_WaypointState
ref SCR_AIGroupPerception	m_Perception
protected ref SCR_AIGroupTargetClusterProcessor	m_TargetClusterProcessor
ref SCR_AIGroupFireteamManager	m_FireteamMgr
int	m_iGetMemberByGoalNextIndex = 0

Typedef Documentation

ScriptInvoker_GroupMoveFailed

typedef ScriptInvokerBase<ScriptInvoker_GroupMoveFailed_Callback> ScriptInvoker_GroupMoveFailed

Definition at line 3 of file SCR_AIGroupUtilityComponent.c.

ScriptInvoker_GroupMoveFailed_Callback

typedef func ScriptInvoker_GroupMoveFailed_Callback

Definition at line 2 of file SCR_AIGroupUtilityComponent.c.

Function Documentation

CancelActivitiesRelatedToWaypoint()

void CancelActivitiesRelatedToWaypoint	(	notnull AIWaypoint	waypoint,
		typename activityType	= typename.Empty
	)

Parameters

[in]	waypoint
[in]	activityType

Definition at line 330 of file SCR_AIGroupUtilityComponent.c.

CanRebalanceFireteams()

protected bool CanRebalanceFireteams

(

)

Determines when we can rebalance fireteams. We don't want to do that when fighting for example.

Definition at line 349 of file SCR_AIGroupUtilityComponent.c.

EvaluateActivity()

SCR_AIActionBase EvaluateActivity

(

out bool

restartActivity

)

Parameters

[out]

restartActivity

Returns

Definition at line 47 of file SCR_AIGroupUtilityComponent.c.

GetOnMoveFailed()

ScriptInvoker_GroupMoveFailed GetOnMoveFailed

(

)

Definition at line 383 of file SCR_AIGroupUtilityComponent.c.

IsPositionAllowed()

bool IsPositionAllowed

(

vector

pos

)

Decides whether we are allowed to go to this position

Parameters

[in]

pos

Returns

Definition at line 472 of file SCR_AIGroupUtilityComponent.c.

OnAgentAdded()

void OnAgentAdded

(

AIAgent

agent

)

Updates info of group members to planner - should be called when adding or removing group member

Parameters

[in]

agent

Definition at line 170 of file SCR_AIGroupUtilityComponent.c.

OnAgentRemoved()

void OnAgentRemoved	(	SCR_AIGroup	group,
		AIAgent	agent
	)

Parameters

[in]	group
[in]	agent

Definition at line 194 of file SCR_AIGroupUtilityComponent.c.

OnCurrentWaypointChanged()

void OnCurrentWaypointChanged	(	AIWaypoint	currentWp,
		AIWaypoint	prevWp
	)

Parameters

[in]	currentWp
[in]	prevWp

Definition at line 242 of file SCR_AIGroupUtilityComponent.c.

OnEnemyDetectedFiltered()

void OnEnemyDetectedFiltered	(	SCR_AIGroup	group,
		SCR_AITargetInfo	target,
		AIAgent	reporter
	)

Called from m_Perception.

Definition at line 275 of file SCR_AIGroupUtilityComponent.c.

OnExecuteWaypointTree()

void OnExecuteWaypointTree

(

)

Definition at line 267 of file SCR_AIGroupUtilityComponent.c.

OnMoveFailed()

void OnMoveFailed	(	int	moveResult,
		IEntity	vehicleUsed,
		bool	isWaypointReleated,
		vector	moveLocation
	)

Definition at line 376 of file SCR_AIGroupUtilityComponent.c.

OnTargetClusterStateChanged()

void OnTargetClusterStateChanged	(	SCR_AITargetClusterState	state,
		EAITargetClusterState	prevState,
		EAITargetClusterState	newState
	)

Parameters

[in]	state
[in]	prevState
[in]	newState

Definition at line 296 of file SCR_AIGroupUtilityComponent.c.

OnWaypointCompleted()

void OnWaypointCompleted

(

AIWaypoint

waypoint

)

Parameters

[in]

waypoint

Definition at line 216 of file SCR_AIGroupUtilityComponent.c.

OnWaypointRemoved()

void OnWaypointRemoved	(	AIWaypoint	waypoint,
		bool	isCurrentWaypoint
	)

Parameters

[in]	waypoint
[in]	isCurrentWaypoint

Definition at line 227 of file SCR_AIGroupUtilityComponent.c.

ScriptInvoker_GroupMoveFailed_Callback()

void ScriptInvoker_GroupMoveFailed_Callback	(	int	moveResult,
		IEntity	vehicleUsed,
		bool	isWaypointRelated,
		vector	moveLocation
	)

UpdateClustersState()

void UpdateClustersState

(

float

deltaTime_ms

)

Iterates all clusters and updates their state

Parameters

[in]

deltaTime_ms

Definition at line 460 of file SCR_AIGroupUtilityComponent.c.

UpdateGroupControlMode()

void UpdateGroupControlMode

(

SCR_AIActionBase

currentAction

)

Parameters

[in]

currentAction

Definition at line 438 of file SCR_AIGroupUtilityComponent.c.

Variable Documentation

m_aInfoComponents

ref array<SCR_AIInfoComponent> m_aInfoComponents = {}

Definition at line 16 of file SCR_AIGroupUtilityComponent.c.

m_bNewGroupMemberAdded

protected bool m_bNewGroupMemberAdded

Definition at line 26 of file SCR_AIGroupUtilityComponent.c.

m_ConfigComponent

SCR_AIConfigComponent m_ConfigComponent

Definition at line 13 of file SCR_AIGroupUtilityComponent.c.

m_CurrentActivity

protected ref SCR_AIActionBase m_CurrentActivity

Definition at line 27 of file SCR_AIGroupUtilityComponent.c.

m_FireteamMgr

ref SCR_AIGroupFireteamManager m_FireteamMgr

Definition at line 38 of file SCR_AIGroupUtilityComponent.c.

m_fLastUpdateTime

protected float m_fLastUpdateTime = -1.0

Definition at line 20 of file SCR_AIGroupUtilityComponent.c.

m_fPerceptionUpdateTimer_ms

protected float m_fPerceptionUpdateTimer_ms

Definition at line 21 of file SCR_AIGroupUtilityComponent.c.

m_GroupInfo

SCR_AIGroupInfoComponent m_GroupInfo

Definition at line 14 of file SCR_AIGroupUtilityComponent.c.

m_iGetMemberByGoalNextIndex

int m_iGetMemberByGoalNextIndex = 0

Definition at line 41 of file SCR_AIGroupUtilityComponent.c.

m_Mailbox

SCR_MailboxComponent m_Mailbox

Definition at line 15 of file SCR_AIGroupUtilityComponent.c.

m_OnMoveFailed

ref ScriptInvoker_GroupMoveFailed m_OnMoveFailed

Definition at line 18 of file SCR_AIGroupUtilityComponent.c.

m_Owner

SCR_AIGroupUtilityComponentClass m_Owner

m_Perception

ref SCR_AIGroupPerception m_Perception

Definition at line 33 of file SCR_AIGroupUtilityComponent.c.

m_TargetClusterProcessor

protected ref SCR_AIGroupTargetClusterProcessor m_TargetClusterProcessor

Definition at line 35 of file SCR_AIGroupUtilityComponent.c.

m_WaypointState

protected ref SCR_AIWaypointState m_WaypointState

Definition at line 30 of file SCR_AIGroupUtilityComponent.c.

PERCEPTION_UPDATE_TIMER_MS

const protected float PERCEPTION_UPDATE_TIMER_MS = 2000.0

Definition at line 24 of file SCR_AIGroupUtilityComponent.c.