Arma Reforger Explorer 1.7.0.54
Arma Reforger Code Explorer by Zeroy - Thanks to MisterOutofTime
Loading...
Searching...
No Matches
SCR_AIGroupUtilityComponent Class Reference
Inheritance diagram for SCR_AIGroupUtilityComponent:

Protected Member Functions

void UpdateThreatMeasure ()
void SetFireRateCoef (float coef=1, bool overridePersistent=false)
float GetFireRateCoef ()
float GetThreatMeasure ()
void SetMaxAutonomousDistance (float dist)
 Sets max distance for various autonomous behaviors.
float GetMaxAutonomousDistance ()
void SetCombatMode (EAIGroupCombatMode combatMode)
 Sets combat mode as desired by external means, such as scenario, or commanding, or game master.
EAIGroupCombatMode GetCombatModeExternal ()
 See SetCombatMode.
EAIGroupCombatMode GetCombatModeActual ()
 Returns actual combat mode. See comment to EvaluateCombatMode method.
SCR_AIActionBase EvaluateActivity (out bool restartActivity)
void EvaluateCombatMode ()
void EvaluateFlareUsage ()
SCR_AITargetClusterState GetCurrentSuppressClusterState ()
bool AnyMembersInsideBBox (vector bbMin, vector bbMax)
bool ShouldSuppressCluster (SCR_AITargetClusterState clusterState)
void UpdateSuppressCluster ()
void OnAgentAdded (AIAgent agent)
void OnAgentRemoved (SCR_AIGroup group, AIAgent agent)
void OnWaypointCompleted (AIWaypoint waypoint)
void OnWaypointToRemove (AIWaypoint waypoint, bool isCurrentWaypoint)
void OnAgentCompartmentEntered (AIAgent agent, IEntity targetEntity, BaseCompartmentManagerComponent manager, int mgrID, int slotID, bool move)
void JoinSubgroup (AIAgent agent, int handleId, bool isSubgroupLeader)
bool OnJoinGroupFromVehicle (AIAgent agent, bool isDriving)
int CreateNewSubgroup (AIAgent agent, bool isSubgroupLeader, SCR_AIGroupVehicle groupVehicle)
void LeaveSubgroup (AIAgent agent, SCR_AIGroupVehicle groupVehicle)
void OnAgentCompartmentLeft (AIAgent agent, IEntity targetEntity, BaseCompartmentManagerComponent manager, int mgrID, int slotID, bool move)
void OnAgentLifeStateChanged (AIAgent incapacitatedAgent, SCR_AIInfoComponent infoIncap, IEntity vehicle, ECharacterLifeState lifeState)
void OnCurrentWaypointChanged (AIWaypoint currentWp, AIWaypoint prevWp)
void OnExecuteWaypointTree ()
void OnEnemyDetectedFiltered (SCR_AIGroup group, SCR_AITargetInfo target, AIAgent reporter)
 Called from m_Perception.
void OnTargetClusterStateChanged (SCR_AITargetClusterState state, EAITargetClusterState prevState, EAITargetClusterState newState)
void CancelActivitiesRelatedToWaypoint (notnull AIWaypoint waypoint, typename activityType=typename.Empty, bool doNotCompleteWaypoint=false)
bool CanRebalanceFireteams ()
 Determines when we can rebalance fireteams. We don't want to do that when fighting for example.
void OnMoveFailed (int moveResult, IEntity vehicleUsed, bool isWaypointRelated, 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)
bool IsUsableVehicle (notnull SCR_AIVehicleUsageComponent vehicleUsageComp)
bool IsUsableVehicle (notnull IEntity vehicleEntity)
void AddUsableVehicle (notnull SCR_AIVehicleUsageComponent vehicleUsageComp)
void RemoveUsableVehicle (notnull SCR_AIVehicleUsageComponent vehicleUsageComp)
void OnVehicleDeleted (SCR_AIVehicleUsageComponent comp)
void OnVehicleDamageStateChanged (SCR_AIVehicleUsageComponent comp, EDamageState state)
bool IsMilitary ()
 Are we a military AI or not?

Protected Attributes

float m_fLastUpdateTime = -1.0
float m_fPerceptionUpdateTimer_ms
float m_fMaxAutonomousDistance = AUTONOMOUS_DISTANCE_MAX_DEFAULT
const float PERCEPTION_UPDATE_TIMER_MS = 2000.0
bool m_bNewGroupMemberAdded
ref SCR_AIActionBase m_CurrentActivity
ref SCR_AIWaypointState m_WaypointState
ref SCR_AIGroupPerception m_Perception
ref SCR_AIGroupTargetClusterProcessor m_TargetClusterProcessor
ref SCR_AIGroupFireteamManager m_FireteamMgr
ref SCR_AIGroupVehicleManager m_VehicleMgr
int m_iGetMemberByGoalNextIndex = 0
float m_fThreatMeasure
float m_fFireRateCoef = 1
ref SCR_AITargetClusterState m_CurrentSuppressClusterState
EAIGroupCombatMode m_eCombatModeExternal = EAIGroupCombatMode.FIRE_AT_WILL
EAIGroupCombatMode m_eCombatModeActual = EAIGroupCombatMode.FIRE_AT_WILL

Detailed Description

Definition at line 17 of file SCR_AIGroupUtilityComponent.c.

Member Function Documentation

◆ AddUsableVehicle()

void SCR_AIGroupUtilityComponent::AddUsableVehicle ( notnull SCR_AIVehicleUsageComponent vehicleUsageComp)
inlineprotected

Definition at line 959 of file SCR_AIGroupUtilityComponent.c.

◆ AnyMembersInsideBBox()

bool SCR_AIGroupUtilityComponent::AnyMembersInsideBBox ( vector bbMin,
vector bbMax )
inlineprotected

Definition at line 352 of file SCR_AIGroupUtilityComponent.c.

◆ CancelActivitiesRelatedToWaypoint()

void SCR_AIGroupUtilityComponent::CancelActivitiesRelatedToWaypoint ( notnull AIWaypoint waypoint,
typename activityType = typename.Empty,
bool doNotCompleteWaypoint = false )
inlineprotected
Parameters
[in]waypoint
[in]activityType
[in]doNotCompleteWaypoint

Definition at line 761 of file SCR_AIGroupUtilityComponent.c.

◆ CanRebalanceFireteams()

bool SCR_AIGroupUtilityComponent::CanRebalanceFireteams ( )
inlineprotected

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

Definition at line 785 of file SCR_AIGroupUtilityComponent.c.

◆ CreateNewSubgroup()

int SCR_AIGroupUtilityComponent::CreateNewSubgroup ( AIAgent agent,
bool isSubgroupLeader,
SCR_AIGroupVehicle groupVehicle )
inlineprotected

Definition at line 608 of file SCR_AIGroupUtilityComponent.c.

◆ EOnDiag()

override void SCR_AIGroupUtilityComponent::EOnDiag ( IEntity owner,
float timeSlice )
inlineprotected

Definition at line 868 of file SCR_AIGroupUtilityComponent.c.

◆ EOnInit()

override void SCR_AIGroupUtilityComponent::EOnInit ( IEntity owner)
inlineprotected

Definition at line 828 of file SCR_AIGroupUtilityComponent.c.

◆ EvaluateActivity()

SCR_AIActionBase SCR_AIGroupUtilityComponent::EvaluateActivity ( out bool restartActivity)
inlineprotected
Parameters
[out]restartActivity
Returns

Definition at line 163 of file SCR_AIGroupUtilityComponent.c.

◆ EvaluateCombatMode()

void SCR_AIGroupUtilityComponent::EvaluateCombatMode ( )
inlineprotected

Resolves which actual combat mode the group has now, based on external combat mode. Actual combat mode can be only either HOLD_FIRE or FIRE_AT_WILL, Depending on external combat mode value, and if gorup considers itself under attack or not.

Definition at line 304 of file SCR_AIGroupUtilityComponent.c.

◆ EvaluateFlareUsage()

void SCR_AIGroupUtilityComponent::EvaluateFlareUsage ( )
inlineprotected

Definition at line 330 of file SCR_AIGroupUtilityComponent.c.

◆ GetCombatModeActual()

EAIGroupCombatMode SCR_AIGroupUtilityComponent::GetCombatModeActual ( )
inlineprotected

Returns actual combat mode. See comment to EvaluateCombatMode method.

Definition at line 154 of file SCR_AIGroupUtilityComponent.c.

◆ GetCombatModeExternal()

EAIGroupCombatMode SCR_AIGroupUtilityComponent::GetCombatModeExternal ( )
inlineprotected

See SetCombatMode.

Definition at line 147 of file SCR_AIGroupUtilityComponent.c.

◆ GetCurrentSuppressClusterState()

SCR_AITargetClusterState SCR_AIGroupUtilityComponent::GetCurrentSuppressClusterState ( )
inlineprotected

Definition at line 346 of file SCR_AIGroupUtilityComponent.c.

◆ GetFireRateCoef()

float SCR_AIGroupUtilityComponent::GetFireRateCoef ( )
inlineprotected

Definition at line 113 of file SCR_AIGroupUtilityComponent.c.

◆ GetMaxAutonomousDistance()

float SCR_AIGroupUtilityComponent::GetMaxAutonomousDistance ( )
inlineprotected

Definition at line 133 of file SCR_AIGroupUtilityComponent.c.

◆ GetOnMoveFailed()

ScriptInvoker_GroupMoveFailed SCR_AIGroupUtilityComponent::GetOnMoveFailed ( )
inlineprotected

Definition at line 819 of file SCR_AIGroupUtilityComponent.c.

◆ GetThreatMeasure()

float SCR_AIGroupUtilityComponent::GetThreatMeasure ( )
inlineprotected

Definition at line 120 of file SCR_AIGroupUtilityComponent.c.

◆ IsMilitary()

bool SCR_AIGroupUtilityComponent::IsMilitary ( )
inlineprotected

Are we a military AI or not?

Definition at line 1016 of file SCR_AIGroupUtilityComponent.c.

◆ IsPositionAllowed()

bool SCR_AIGroupUtilityComponent::IsPositionAllowed ( vector pos)
inlineprotected

Decides whether we are allowed to go to this position

Parameters
[in]pos
Returns

Definition at line 917 of file SCR_AIGroupUtilityComponent.c.

◆ IsUsableVehicle() [1/2]

bool SCR_AIGroupUtilityComponent::IsUsableVehicle ( notnull IEntity vehicleEntity)
inlineprotected

Definition at line 950 of file SCR_AIGroupUtilityComponent.c.

◆ IsUsableVehicle() [2/2]

bool SCR_AIGroupUtilityComponent::IsUsableVehicle ( notnull SCR_AIVehicleUsageComponent vehicleUsageComp)
inlineprotected

Definition at line 941 of file SCR_AIGroupUtilityComponent.c.

◆ JoinSubgroup()

void SCR_AIGroupUtilityComponent::JoinSubgroup ( AIAgent agent,
int handleId,
bool isSubgroupLeader )
inlineprotected

Definition at line 573 of file SCR_AIGroupUtilityComponent.c.

◆ LeaveSubgroup()

void SCR_AIGroupUtilityComponent::LeaveSubgroup ( AIAgent agent,
SCR_AIGroupVehicle groupVehicle )
inlineprotected

Definition at line 625 of file SCR_AIGroupUtilityComponent.c.

◆ OnAgentAdded()

void SCR_AIGroupUtilityComponent::OnAgentAdded ( AIAgent agent)
inlineprotected

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

Parameters
[in]agent

Definition at line 442 of file SCR_AIGroupUtilityComponent.c.

◆ OnAgentCompartmentEntered()

void SCR_AIGroupUtilityComponent::OnAgentCompartmentEntered ( AIAgent agent,
IEntity targetEntity,
BaseCompartmentManagerComponent manager,
int mgrID,
int slotID,
bool move )
inlineprotected

Definition at line 532 of file SCR_AIGroupUtilityComponent.c.

◆ OnAgentCompartmentLeft()

void SCR_AIGroupUtilityComponent::OnAgentCompartmentLeft ( AIAgent agent,
IEntity targetEntity,
BaseCompartmentManagerComponent manager,
int mgrID,
int slotID,
bool move )
inlineprotected

Definition at line 639 of file SCR_AIGroupUtilityComponent.c.

◆ OnAgentLifeStateChanged()

void SCR_AIGroupUtilityComponent::OnAgentLifeStateChanged ( AIAgent incapacitatedAgent,
SCR_AIInfoComponent infoIncap,
IEntity vehicle,
ECharacterLifeState lifeState )
inlineprotected

Definition at line 664 of file SCR_AIGroupUtilityComponent.c.

◆ OnAgentRemoved()

void SCR_AIGroupUtilityComponent::OnAgentRemoved ( SCR_AIGroup group,
AIAgent agent )
inlineprotected
Parameters
[in]group
[in]agent

Definition at line 472 of file SCR_AIGroupUtilityComponent.c.

◆ OnCurrentWaypointChanged()

void SCR_AIGroupUtilityComponent::OnCurrentWaypointChanged ( AIWaypoint currentWp,
AIWaypoint prevWp )
inlineprotected
Parameters
[in]currentWp
[in]prevWp

Definition at line 672 of file SCR_AIGroupUtilityComponent.c.

◆ OnEnemyDetectedFiltered()

void SCR_AIGroupUtilityComponent::OnEnemyDetectedFiltered ( SCR_AIGroup group,
SCR_AITargetInfo target,
AIAgent reporter )
inlineprotected

Called from m_Perception.

Definition at line 705 of file SCR_AIGroupUtilityComponent.c.

◆ OnExecuteWaypointTree()

void SCR_AIGroupUtilityComponent::OnExecuteWaypointTree ( )
inlineprotected

Definition at line 697 of file SCR_AIGroupUtilityComponent.c.

◆ OnJoinGroupFromVehicle()

bool SCR_AIGroupUtilityComponent::OnJoinGroupFromVehicle ( AIAgent agent,
bool isDriving )
inlineprotected

Definition at line 584 of file SCR_AIGroupUtilityComponent.c.

◆ OnMoveFailed()

void SCR_AIGroupUtilityComponent::OnMoveFailed ( int moveResult,
IEntity vehicleUsed,
bool isWaypointRelated,
vector moveLocation )
inlineprotected

Definition at line 812 of file SCR_AIGroupUtilityComponent.c.

◆ OnTargetClusterStateChanged()

void SCR_AIGroupUtilityComponent::OnTargetClusterStateChanged ( SCR_AITargetClusterState state,
EAITargetClusterState prevState,
EAITargetClusterState newState )
inlineprotected
Parameters
[in]state
[in]prevState
[in]newState

Definition at line 726 of file SCR_AIGroupUtilityComponent.c.

◆ OnVehicleDamageStateChanged()

void SCR_AIGroupUtilityComponent::OnVehicleDamageStateChanged ( SCR_AIVehicleUsageComponent comp,
EDamageState state )
inlineprotected

Definition at line 1006 of file SCR_AIGroupUtilityComponent.c.

◆ OnVehicleDeleted()

void SCR_AIGroupUtilityComponent::OnVehicleDeleted ( SCR_AIVehicleUsageComponent comp)
inlineprotected

Definition at line 1000 of file SCR_AIGroupUtilityComponent.c.

◆ OnWaypointCompleted()

void SCR_AIGroupUtilityComponent::OnWaypointCompleted ( AIWaypoint waypoint)
inlineprotected
Parameters
[in]waypoint

Definition at line 507 of file SCR_AIGroupUtilityComponent.c.

◆ OnWaypointToRemove()

void SCR_AIGroupUtilityComponent::OnWaypointToRemove ( AIWaypoint waypoint,
bool isCurrentWaypoint )
inlineprotected
Parameters
[in]waypoint
[in]isCurrentWaypoint

Definition at line 519 of file SCR_AIGroupUtilityComponent.c.

◆ RemoveUsableVehicle()

void SCR_AIGroupUtilityComponent::RemoveUsableVehicle ( notnull SCR_AIVehicleUsageComponent vehicleUsageComp)
inlineprotected

Definition at line 978 of file SCR_AIGroupUtilityComponent.c.

◆ SetCombatMode()

void SCR_AIGroupUtilityComponent::SetCombatMode ( EAIGroupCombatMode combatMode)
inlineprotected

Sets combat mode as desired by external means, such as scenario, or commanding, or game master.

Definition at line 140 of file SCR_AIGroupUtilityComponent.c.

◆ SetFireRateCoef()

void SCR_AIGroupUtilityComponent::SetFireRateCoef ( float coef = 1,
bool overridePersistent = false )
inlineprotected

Definition at line 99 of file SCR_AIGroupUtilityComponent.c.

◆ SetMaxAutonomousDistance()

void SCR_AIGroupUtilityComponent::SetMaxAutonomousDistance ( float dist)
inlineprotected

Sets max distance for various autonomous behaviors.

Definition at line 127 of file SCR_AIGroupUtilityComponent.c.

◆ ShouldSuppressCluster()

bool SCR_AIGroupUtilityComponent::ShouldSuppressCluster ( SCR_AITargetClusterState clusterState)
inlineprotected

Definition at line 375 of file SCR_AIGroupUtilityComponent.c.

◆ UpdateClustersState()

void SCR_AIGroupUtilityComponent::UpdateClustersState ( float deltaTime_ms)
inlineprotected

Iterates all clusters and updates their state

Parameters
[in]deltaTime_ms

Definition at line 905 of file SCR_AIGroupUtilityComponent.c.

◆ UpdateGroupControlMode()

void SCR_AIGroupUtilityComponent::UpdateGroupControlMode ( SCR_AIActionBase currentAction)
inlineprotected
Parameters
[in]currentAction

Definition at line 883 of file SCR_AIGroupUtilityComponent.c.

◆ UpdateSuppressCluster()

void SCR_AIGroupUtilityComponent::UpdateSuppressCluster ( )
inlineprotected

Definition at line 412 of file SCR_AIGroupUtilityComponent.c.

◆ UpdateThreatMeasure()

void SCR_AIGroupUtilityComponent::UpdateThreatMeasure ( )
inlineprotected

Definition at line 82 of file SCR_AIGroupUtilityComponent.c.

Member Data Documentation

◆ m_bNewGroupMemberAdded

bool SCR_AIGroupUtilityComponent::m_bNewGroupMemberAdded
protected

Definition at line 48 of file SCR_AIGroupUtilityComponent.c.

◆ m_CurrentActivity

ref SCR_AIActionBase SCR_AIGroupUtilityComponent::m_CurrentActivity
protected

Definition at line 49 of file SCR_AIGroupUtilityComponent.c.

◆ m_CurrentSuppressClusterState

ref SCR_AITargetClusterState SCR_AIGroupUtilityComponent::m_CurrentSuppressClusterState
protected

Definition at line 75 of file SCR_AIGroupUtilityComponent.c.

◆ m_eCombatModeActual

EAIGroupCombatMode SCR_AIGroupUtilityComponent::m_eCombatModeActual = EAIGroupCombatMode.FIRE_AT_WILL
protected

Definition at line 79 of file SCR_AIGroupUtilityComponent.c.

◆ m_eCombatModeExternal

EAIGroupCombatMode SCR_AIGroupUtilityComponent::m_eCombatModeExternal = EAIGroupCombatMode.FIRE_AT_WILL
protected

Definition at line 78 of file SCR_AIGroupUtilityComponent.c.

◆ m_fFireRateCoef

float SCR_AIGroupUtilityComponent::m_fFireRateCoef = 1
protected

Definition at line 72 of file SCR_AIGroupUtilityComponent.c.

◆ m_FireteamMgr

ref SCR_AIGroupFireteamManager SCR_AIGroupUtilityComponent::m_FireteamMgr
protected

Definition at line 60 of file SCR_AIGroupUtilityComponent.c.

◆ m_fLastUpdateTime

float SCR_AIGroupUtilityComponent::m_fLastUpdateTime = -1.0
protected

Definition at line 39 of file SCR_AIGroupUtilityComponent.c.

◆ m_fMaxAutonomousDistance

float SCR_AIGroupUtilityComponent::m_fMaxAutonomousDistance = AUTONOMOUS_DISTANCE_MAX_DEFAULT
protected

Definition at line 43 of file SCR_AIGroupUtilityComponent.c.

◆ m_fPerceptionUpdateTimer_ms

float SCR_AIGroupUtilityComponent::m_fPerceptionUpdateTimer_ms
protected

Definition at line 40 of file SCR_AIGroupUtilityComponent.c.

◆ m_fThreatMeasure

float SCR_AIGroupUtilityComponent::m_fThreatMeasure
protected

Definition at line 69 of file SCR_AIGroupUtilityComponent.c.

◆ m_iGetMemberByGoalNextIndex

int SCR_AIGroupUtilityComponent::m_iGetMemberByGoalNextIndex = 0
protected

Definition at line 66 of file SCR_AIGroupUtilityComponent.c.

◆ m_Perception

ref SCR_AIGroupPerception SCR_AIGroupUtilityComponent::m_Perception
protected

Definition at line 55 of file SCR_AIGroupUtilityComponent.c.

◆ m_TargetClusterProcessor

ref SCR_AIGroupTargetClusterProcessor SCR_AIGroupUtilityComponent::m_TargetClusterProcessor
protected

Definition at line 57 of file SCR_AIGroupUtilityComponent.c.

◆ m_VehicleMgr

ref SCR_AIGroupVehicleManager SCR_AIGroupUtilityComponent::m_VehicleMgr
protected

Definition at line 63 of file SCR_AIGroupUtilityComponent.c.

◆ m_WaypointState

ref SCR_AIWaypointState SCR_AIGroupUtilityComponent::m_WaypointState
protected

Definition at line 52 of file SCR_AIGroupUtilityComponent.c.

◆ PERCEPTION_UPDATE_TIMER_MS

const float SCR_AIGroupUtilityComponent::PERCEPTION_UPDATE_TIMER_MS = 2000.0
protected

Definition at line 46 of file SCR_AIGroupUtilityComponent.c.

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