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

Protected Member Functions

int GetSpawnQueueSize ()
SCR_AIGroupUtilityComponent GetGroupUtilityComponent ()
int GetNumberOfMembersToSpawn ()
void SetNumberOfMembersToSpawn (int number)
void SetRallyPoint (notnull SCR_MilitaryBaseComponent base, bool force=false)
void RemoveRallyPoint ()
 Removes current group Rally Point.
int GetRallyPointId ()
bool IsRallyPointForced ()
override void EOnFrame (IEntity owner, float timeSlice)
bool SpawnDelayedGroupMember (int spawnIndex)
void SpawnAllImmediately ()
bool IsInitializing ()
 Returns true if group is in initialization state, for instance while still spawning its members.
void BeginDelayedSpawn ()
void EndDelayedSpawn ()
bool HasRequesterID (int id)
void RemoveRequester (int playerID)
int GetDeniedRequesters (out array< int > valueArray)
void AddDeniedRequester (int playerID)
void ClearRequesters ()
void ClearDeniedRequester ()
int GetRequesterIDs (out array< int > valueArray)
void AddRequester (int playerID)
void SetFlagIsFromImageSet (bool value)
void SetCustomGroupFlag (ResourceName flag)
bool GetFlagIsFromImageSet ()
ResourceName GetGroupFlag ()
bool IsPlayerInGroup (int playerID)
bool IsPlayerLeader (int playerID)
int GetLeaderID ()
int GetFirstPlayerLeaderID ()
int GetDefaultActiveRadioChannel ()
void SetDefaultActiveRadioChannel (int id)
void SetPrivate (bool isPrivate)
 Called on the server (authority).
bool IsPrivate ()
void SetPrivacyChangeable (bool IsPrivacyChangeable)
bool IsPrivacyChangeable ()
void SetGroupRole (SCR_EGroupRole groupRole)
SCR_EGroupRole GetGroupRole ()
string GetGroupRoleName ()
bool GetDeleteIfNoPlayer ()
 Returns true if the group is set to be deleted when all players leave.
void SetCanDeleteIfNoPlayer (bool deleteEmpty)
 Sets if the group should be deleted when all players leave.
bool IsFull ()
bool IsSlave ()
int GetPlayerAndAgentCount (bool checkMasterAndSlaves=false)
int GetAgentCountIncludingMasterAndSlaves ()
int GetTotalAgentCount ()
int GetTotalPlayerCount ()
void SetGroupFlag (int flagIndex, bool isFromImageset)
 called on server only
void RPC_DoSetGroupFlag (int flagIndex, bool isFromImageset)
void SetCustomName (string name, int authorID)
void RPC_DoSetCustomName (string name, int authorID)
void OnNameFilteredCallback (array< string > resultText)
void SetCustomDescription (string desc, int authorID)
 called on server only
void SetMaxGroupMembers (int value)
void RPC_DoSetMaxGroupMembers (int value)
void RPC_DoSetCustomDescription (string desc, int authorID)
void OnDescFilteredCallback (array< string > resultText)
string GetCustomDescription ()
string GetCustomName ()
int GetDescriptionAuthorID ()
int GetNameAuthorID ()
string GetCustomNameWithOriginal ()
int GetGroupID ()
void SetGroupID (int id)
int GetMaxMembers ()
bool IsMaxMembersLimited ()
void SetMaxMembers (int maxMembers)
 called on server only
void RPC_DoSetMaxMembers (int maxMembers)
array< int > GetPlayerIDs ()
int GetPlayerCount (bool checkMasterAndSlaves=false)
SCR_ECharacterRank GetRequiredRank ()
void SetRequiredRank (SCR_ECharacterRank rank)
void RpcDo_SetRequiredRank (SCR_ECharacterRank rank)
bool IsCreatedByCommander ()
void SetCreatedByCommander (bool isCreatedByCommander)
ResourceName GetPresetResource ()
void SetPresetResource (ResourceName preset)
void RpcDo_SetCreatedByCommander (bool isCreatedByCommander)
ScriptInvoker GetOnMemberStateChange ()
void AddAgentFromControlledEntity (notnull IEntity controlledEntity)
void RemoveAgentFromControlledEntity (notnull IEntity controlledEntity)
void NotificateGroupAIChange (IEntity controlledEntity, ENotification notificationType)
void OnPlayerDisconnected (int playerID)
 Should be only called on the server.
void RPC_DoOnGroupMemberStateChange ()
void OnGroupMemberStateChange ()
 Should only be called on the server (authority).
void OnMemberDeath (notnull SCR_CharacterControllerComponent memberController, IEntity killerEntity, Instigator killer)
void ListenToMemberDeath (notnull IEntity groupMember)
void AddOnGadgetsLoadedListener (int playerID, notnull IEntity controlledEntity)
void OnControllableEntitySpawned (IEntity controlledEntity, notnull SCR_GadgetManagerComponent gadgetManager)
void QueueAddAgent (int playerID)
void RPC_DoAddPlayer (int playerID)
void CheckForLeader (int playerID, bool noLeaderAllowed)
void SetGroupLeader (int playerID)
 Called on the server (authority).
void RPC_SetLeaderID (int playerID)
void RPC_SetPrivate (bool isPrivate)
void RPC_DoSetPrivacyChangeable (bool IsPrivacyChangeable)
void RpcDo_SetGroupRole (SCR_EGroupRole groupRole)
void RpcDo_SetRallyPoint (int callsignId, bool force)
void RpcDo_RemoveRallyPoint ()
void AddPlayer (int playerID)
 Called on the server (authority).
void RPC_DoAddRequester (int playerID)
void RPC_DoRemoveRequester (int playerID)
void RPC_DoRemoveLeavingPlayer (int playerID)
void OnPlayerLeftGame (int playerId)
void RPC_DoClearDeniedRequester ()
void RPC_DoClearRequesterIDs ()
void RPC_DoAddDeniedRequester (int playerID)
void RPC_DoRemovePlayer (int playerID)
void RemovePlayerAgent (int playerID)
void RemovePlayer (int playerID)
 Called on the server (authority).
void GetCallsigns (out string company, out string platoon, out string squad, out string character, out string format)
void SetRadioFrequency (int frequency)
void RPC_DoSetFrequency (int frequency)
int GetRadioFrequency ()
bool IsPlayable ()
void CreateUnitEntities (bool editMode, array< ResourceName > entityResourceNames)
bool SpawnGroupMember (bool snapToTerrain, int index, ResourceName res, bool editMode, bool isLast)
void SetWaypointParams (out AIWaypoint wp, SCR_WaypointPrefabLocation prefabParams)
void AddWaypointsDynamic (out array< IEntity > entityInstanceList, array< ref SCR_WaypointPrefabLocation > prefabs)
void AddWaypointsStatic (array< string > aWaypointNames)
void AddVehiclesStatic (array< string > aVehicleNames)
void DestroyEntities (out array< IEntity > entityList)
void RemoveStaticWaypointRefs (array< string > aWaypointNames)
void ClearRefs (out array< IEntity > entityList)
bool AddAIEntityToGroup (IEntity entity)
bool RemoveAIEntityFromGroup (IEntity entity)
void AddWaypointToGroup (AIWaypoint waypoint)
void RemoveWaypointFromGroup (AIWaypoint waypoint)
void GetAllocatedCompartments (out array< BaseCompartmentSlot > allocatedCompartments)
void GetAllocatedSmartActions (out array< AISmartActionComponent > allocatedComponents)
void AllocateSmartActions (array< AISmartActionComponent > components)
void AllocateCompartment (BaseCompartmentSlot compartment)
void ReleaseCompartment (BaseCompartmentSlot compartment)
void ReleaseCompartments ()
void ReleaseSmartAction (AISmartActionComponent component)
void ReleaseSmartActions ()
bool InitFactionKey (string factionKey)
bool SetFaction (Faction faction)
void SetFactionDelayed (int factionIndex)
void BroadCastSetFaction (int factionIndex)
string GetFactionName ()
Faction GetFaction ()
int GetFactionIndex ()
ScriptInvoker GetOnInit ()
ScriptInvoker_AIGroupOnEmpty GetOnEmpty ()
ScriptInvoker GetOnAgentAdded ()
ScriptInvoker GetOnAgentRemoved ()
ScriptInvoker GetOnLeaderChanged ()
ScriptInvoker GetOnCurrentWaypointChanged ()
ScriptInvoker GetOnWaypointCompleted ()
ScriptInvoker GetOnWaypointAdded ()
ScriptInvoker GetOnWaypointRemoved ()
ScriptInvoker GetOnWaypointToRemove ()
ScriptInvoker GetOnFactionChanged ()
ScriptInvokerBase< ScriptInvokerAIGroup > GetOnAllDelayedEntitySpawned ()
override void OnEmpty ()
override void OnAgentAdded (AIAgent child)
override void OnAgentRemoved (AIAgent child)
override void OnLeaderChanged (AIAgent currentLeader, AIAgent prevLeader)
override void OnCurrentWaypointChanged (AIWaypoint currentWP, AIWaypoint prevWP)
override void OnWaypointCompleted (AIWaypoint wp)
override void OnWaypointAdded (AIWaypoint wp)
override void OnWaypointRemoved (AIWaypoint wp, bool isCurrentWaypoint)
void InvokeSubagentsOnWaypointChanged (AIWaypoint newWaypoint)
override void EOnInit (IEntity owner)
void OnSpawnPointFinalizeSpawn (SCR_SpawnRequestComponent requestComponent, SCR_SpawnData data, IEntity entity)
bool GetSpawnImmediately ()
void SetSpawnImmediately (bool spawnImmediately)
void SetMaxUnitsToSpawn (int cnt)
void SetMemberSpawnDelay (int memberSpawnDelay)
void SpawnUnits ()
SCR_AIGroup GetSlave ()
void SetSlave (SCR_AIGroup group)
SCR_AIGroup GetMaster ()
void SetMaster (SCR_AIGroup group)
array< SCR_ChimeraCharacter > GetAIMembers ()
bool IsAIControlledCharacterMember (SCR_ChimeraCharacter character)
bool IsLoadoutInGroup (SCR_FactionPlayerLoadout loadout)
override bool RplSave (ScriptBitWriter writer)
override bool RplLoad (ScriptBitReader reader)
void LeaderLifeStateChanged (ECharacterLifeState previousLifeState, ECharacterLifeState newLifeState)
void SetNewConsciousLeader ()
void IncreaseDeployedRadioCount ()
void DecreaseDeployedRadioCount ()
int GetDeployedRadioCount ()
void SetDeleteWhenEmpty (bool deleteWhenEmpty)
void CompleteAllWaypoints ()
void SCR_AIGroup (IEntitySource src, IEntity parent)
void ~SCR_AIGroup ()

Static Protected Member Functions

static ScriptInvoker GetOnFlagSelected ()
static ScriptInvoker GetOnJoinPrivateGroupRequest ()
static ScriptInvoker GetOnJoinPrivateGroupConfirm ()
static ScriptInvoker GetOnJoinPrivateGroupCancel ()
static ScriptInvokerBase< ScriptInvokerAIGroup > GetOnGroupRallyPointChanged ()
static bool DeLocalizeText (out string input)
static ScriptInvoker GetOnPlayerAdded ()
static ScriptInvoker GetOnPlayerRemoved ()
static ScriptInvoker GetOnPlayerLeaderChanged ()
static ScriptInvoker GetOnPrivateGroupChanged ()
static ScriptInvoker GetOnCustomNameChanged ()
static ScriptInvoker GetOnFrequencyChanged ()
static ScriptInvoker GetOnCustomDescriptionChanged ()
static ScriptInvokerGroupRole GetOnGroupRoleChanged ()
static void IgnoreSnapToTerrain (bool ignore)
static void IgnoreSpawning (bool ignore)

Protected Attributes

int m_fMemberSpawnDelay
bool m_bDeleteWhenEmpty
ref array< IEntity > m_aSceneGroupUnitInstances
ref array< IEntity > m_aSceneWaypointInstances
ref array< BaseCompartmentSlot > m_aAllocatedCompartments = {}
ref array< AISmartActionComponent > m_aAllocatedComponents = {}
int m_iMaxUnitsToSpawn = int.MAX
ref ScriptInvoker Event_OnInit
ref ScriptInvoker_AIGroupOnEmpty Event_OnEmpty
ref ScriptInvoker Event_OnAgentAdded
ref ScriptInvoker Event_OnAgentRemoved
ref ScriptInvoker Event_OnLeaderChanged
ref ScriptInvoker Event_OnCurrentWaypointChanged
ref ScriptInvoker Event_OnWaypointCompleted
ref ScriptInvoker Event_OnWaypointAdded
ref ScriptInvoker Event_OnWaypointRemoved
ref ScriptInvoker Event_OnWaypointToRemove
ref ScriptInvoker Event_OnFactionChanged
ref ScriptInvoker Event_OnGroupMemberStateChange
int m_iNumOfMembersToSpawn
ref array< int > m_aAgentIDQueue = {}
int m_iGroupRadioFrequency
int m_iMaxMembers
bool m_bPlayable
bool m_bPrivate
bool m_bDeleteIfNoPlayer
int m_iGroupID = -1
int m_iLeaderID = -1
ref SCR_AIGroupUIInfo m_UiInfo
SCR_EGroupRole m_eGroupRole
bool m_bIsPrivacyChangeable = 1
bool m_bIsCreatedByCommander
ResourceName m_rPreset
int m_iDescriptionAuthorID = 0
int m_iNameAuthorID = 0
int m_iDefaultActiveRadioChannel
string m_sCustomName = ""
string m_sCustomDescription = ""
ref array< int > m_aPlayerIDs = {}
ref SCR_ScriptProfanityFilterRequestCallback m_ProfanityCallbackName
ref SCR_ScriptProfanityFilterRequestCallback m_ProfanityCallbackDesc
ref array< int > m_aRequesterIDs = {}
ref array< int > m_aDeniedRequesters = {}
int m_iDeployedRadioCount = 0
int m_RallyPointId = -1
bool m_bForcedRallyPoint
SCR_AIGroup m_SlaveGroup
SCR_AIGroup m_MasterGroup
ref array< SCR_ChimeraCharacter > m_aAIMembers = {}
SCR_AIGroupUtilityComponent m_GroupUtilityComponent
RplId m_MasterGroupID
RplId m_SlaveGroupID
ref array< ref SCR_AIGroup_DelayedSpawn > m_delayedSpawnList = {}
ref ScriptInvokerBase< ScriptInvokerAIGroup > Event_OnAllDelayedEntitySpawned
SCR_ECharacterRank m_eRequiredRank

Static Protected Attributes

static bool s_bIgnoreSnapToTerrain
static bool s_bIgnoreSpawning
static ref ScriptInvoker s_OnPlayerAdded = new ScriptInvoker()
static ref ScriptInvoker s_OnPlayerRemoved = new ScriptInvoker()
static ref ScriptInvoker< int, int > s_OnPlayerLeaderChanged = new ScriptInvoker()
static ref ScriptInvoker s_OnPrivateGroupChanged = new ScriptInvoker()
static ref ScriptInvoker< SCR_AIGroup > s_OnCustomNameChanged = new ScriptInvoker()
static ref ScriptInvoker s_OnFrequencyChanged = new ScriptInvoker()
static ref ScriptInvoker s_OnMaxMembersChanged = new ScriptInvoker()
static ref ScriptInvoker s_OnCustomDescChanged = new ScriptInvoker()
static ref ScriptInvoker s_OnFlagSelected = new ScriptInvoker()
static ref ScriptInvoker s_OnJoinPrivateGroupRequest = new ScriptInvoker()
static ref ScriptInvoker s_OnJoinPrivateGroupConfirm = new ScriptInvoker()
static ref ScriptInvoker s_OnJoinPrivateGroupCancel = new ScriptInvoker()
static ref ScriptInvokerGroupRole s_OnGroupRoleChanged
static ref ScriptInvokerBase< ScriptInvokerAIGroup > s_OnGroupRallyPointChanged

Detailed Description

Definition at line 74 of file SCR_AIGroup.c.

Constructor & Destructor Documentation

◆ SCR_AIGroup()

void SCR_AIGroup::SCR_AIGroup ( IEntitySource src,
IEntity parent )
inlineprotected

Definition at line 2893 of file SCR_AIGroup.c.

◆ ~SCR_AIGroup()

void SCR_AIGroup::~SCR_AIGroup ( )
inlineprotected

Definition at line 2899 of file SCR_AIGroup.c.

Member Function Documentation

◆ AddAgentFromControlledEntity()

void SCR_AIGroup::AddAgentFromControlledEntity ( notnull IEntity controlledEntity)
inlineprotected

Definition at line 1123 of file SCR_AIGroup.c.

◆ AddAIEntityToGroup()

bool SCR_AIGroup::AddAIEntityToGroup ( IEntity entity)
inlineprotected

Definition at line 1906 of file SCR_AIGroup.c.

◆ AddDeniedRequester()

void SCR_AIGroup::AddDeniedRequester ( int playerID)
inlineprotected

Definition at line 369 of file SCR_AIGroup.c.

◆ AddOnGadgetsLoadedListener()

void SCR_AIGroup::AddOnGadgetsLoadedListener ( int playerID,
notnull IEntity controlledEntity )
inlineprotected

Definition at line 1226 of file SCR_AIGroup.c.

◆ AddPlayer()

void SCR_AIGroup::AddPlayer ( int playerID)
inlineprotected

Called on the server (authority).

Definition at line 1401 of file SCR_AIGroup.c.

◆ AddRequester()

void SCR_AIGroup::AddRequester ( int playerID)
inlineprotected

Definition at line 399 of file SCR_AIGroup.c.

◆ AddVehiclesStatic()

void SCR_AIGroup::AddVehiclesStatic ( array< string > aVehicleNames)
inlineprotected

Definition at line 1826 of file SCR_AIGroup.c.

◆ AddWaypointsDynamic()

void SCR_AIGroup::AddWaypointsDynamic ( out array< IEntity > entityInstanceList,
array< ref SCR_WaypointPrefabLocation > prefabs )
inlineprotected

Definition at line 1765 of file SCR_AIGroup.c.

◆ AddWaypointsStatic()

void SCR_AIGroup::AddWaypointsStatic ( array< string > aWaypointNames)
inlineprotected

Definition at line 1805 of file SCR_AIGroup.c.

◆ AddWaypointToGroup()

void SCR_AIGroup::AddWaypointToGroup ( AIWaypoint waypoint)
inlineprotected

Definition at line 1947 of file SCR_AIGroup.c.

◆ AllocateCompartment()

void SCR_AIGroup::AllocateCompartment ( BaseCompartmentSlot compartment)
inlineprotected

Definition at line 1995 of file SCR_AIGroup.c.

◆ AllocateSmartActions()

void SCR_AIGroup::AllocateSmartActions ( array< AISmartActionComponent > components)
inlineprotected

Definition at line 1977 of file SCR_AIGroup.c.

◆ BeginDelayedSpawn()

void SCR_AIGroup::BeginDelayedSpawn ( )
inlineprotected

Definition at line 315 of file SCR_AIGroup.c.

◆ BroadCastSetFaction()

void SCR_AIGroup::BroadCastSetFaction ( int factionIndex)
inlineprotected

Definition at line 2129 of file SCR_AIGroup.c.

◆ CheckForLeader()

void SCR_AIGroup::CheckForLeader ( int playerID,
bool noLeaderAllowed )
inlineprotected

checks for a leader, if there is none, it will either use provided player as leader, or appoints next player in group as leader Called on the server (authority)

Definition at line 1286 of file SCR_AIGroup.c.

◆ ClearDeniedRequester()

void SCR_AIGroup::ClearDeniedRequester ( )
inlineprotected

Definition at line 386 of file SCR_AIGroup.c.

◆ ClearRefs()

void SCR_AIGroup::ClearRefs ( out array< IEntity > entityList)
inlineprotected

Definition at line 1898 of file SCR_AIGroup.c.

◆ ClearRequesters()

void SCR_AIGroup::ClearRequesters ( )
inlineprotected

Definition at line 379 of file SCR_AIGroup.c.

◆ CompleteAllWaypoints()

void SCR_AIGroup::CompleteAllWaypoints ( )
inlineprotected

Definition at line 2881 of file SCR_AIGroup.c.

◆ CreateUnitEntities()

void SCR_AIGroup::CreateUnitEntities ( bool editMode,
array< ResourceName > entityResourceNames )
inlineprotected

Definition at line 1586 of file SCR_AIGroup.c.

◆ DecreaseDeployedRadioCount()

void SCR_AIGroup::DecreaseDeployedRadioCount ( )
inlineprotected

Definition at line 2859 of file SCR_AIGroup.c.

◆ DeLocalizeText()

bool SCR_AIGroup::DeLocalizeText ( out string input)
inlinestaticprotected

Definition at line 788 of file SCR_AIGroup.c.

◆ DestroyEntities()

void SCR_AIGroup::DestroyEntities ( out array< IEntity > entityList)
inlineprotected

Definition at line 1856 of file SCR_AIGroup.c.

◆ EndDelayedSpawn()

void SCR_AIGroup::EndDelayedSpawn ( )
inlineprotected

Definition at line 327 of file SCR_AIGroup.c.

◆ EOnFrame()

override void SCR_AIGroup::EOnFrame ( IEntity owner,
float timeSlice )
inlineprotected

Definition at line 263 of file SCR_AIGroup.c.

◆ EOnInit()

override void SCR_AIGroup::EOnInit ( IEntity owner)
inlineprotected

Definition at line 2504 of file SCR_AIGroup.c.

◆ GetAgentCountIncludingMasterAndSlaves()

int SCR_AIGroup::GetAgentCountIncludingMasterAndSlaves ( )
inlineprotected
Returns
Get the count of all AI in the group as well as any attached Master and slave groups

Definition at line 646 of file SCR_AIGroup.c.

◆ GetAIMembers()

array< SCR_ChimeraCharacter > SCR_AIGroup::GetAIMembers ( )
inlineprotected

Definition at line 2650 of file SCR_AIGroup.c.

◆ GetAllocatedCompartments()

void SCR_AIGroup::GetAllocatedCompartments ( out array< BaseCompartmentSlot > allocatedCompartments)
inlineprotected

Definition at line 1965 of file SCR_AIGroup.c.

◆ GetAllocatedSmartActions()

void SCR_AIGroup::GetAllocatedSmartActions ( out array< AISmartActionComponent > allocatedComponents)
inlineprotected

Definition at line 1971 of file SCR_AIGroup.c.

◆ GetCallsigns()

void SCR_AIGroup::GetCallsigns ( out string company,
out string platoon,
out string squad,
out string character,
out string format )
inlineprotected

Definition at line 1546 of file SCR_AIGroup.c.

◆ GetCustomDescription()

string SCR_AIGroup::GetCustomDescription ( )
inlineprotected

Definition at line 873 of file SCR_AIGroup.c.

◆ GetCustomName()

string SCR_AIGroup::GetCustomName ( )
inlineprotected

Definition at line 887 of file SCR_AIGroup.c.

◆ GetCustomNameWithOriginal()

string SCR_AIGroup::GetCustomNameWithOriginal ( )
inlineprotected

Definition at line 913 of file SCR_AIGroup.c.

◆ GetDefaultActiveRadioChannel()

int SCR_AIGroup::GetDefaultActiveRadioChannel ( )
inlineprotected

Definition at line 519 of file SCR_AIGroup.c.

◆ GetDeleteIfNoPlayer()

bool SCR_AIGroup::GetDeleteIfNoPlayer ( )
inlineprotected

Returns true if the group is set to be deleted when all players leave.

Definition at line 601 of file SCR_AIGroup.c.

◆ GetDeniedRequesters()

int SCR_AIGroup::GetDeniedRequesters ( out array< int > valueArray)
inlineprotected

Definition at line 363 of file SCR_AIGroup.c.

◆ GetDeployedRadioCount()

int SCR_AIGroup::GetDeployedRadioCount ( )
inlineprotected

Definition at line 2869 of file SCR_AIGroup.c.

◆ GetDescriptionAuthorID()

int SCR_AIGroup::GetDescriptionAuthorID ( )
inlineprotected

Definition at line 901 of file SCR_AIGroup.c.

◆ GetFaction()

Faction SCR_AIGroup::GetFaction ( )
inlineprotected

Get group's faction from FactionManager

Returns
Faction (or null when faction is not found)

Definition at line 2156 of file SCR_AIGroup.c.

◆ GetFactionIndex()

int SCR_AIGroup::GetFactionIndex ( )
inlineprotected

Get group's faction index from FactionManager

Returns
faction index

Definition at line 2176 of file SCR_AIGroup.c.

◆ GetFactionName()

string SCR_AIGroup::GetFactionName ( )
inlineprotected

Get name of group's faction.

Returns
Faction name (search for it in FactionManager)

Definition at line 2146 of file SCR_AIGroup.c.

◆ GetFirstPlayerLeaderID()

int SCR_AIGroup::GetFirstPlayerLeaderID ( )
inlineprotected

Recursively searches through the group hierarchy to find the first leader who is a player

Returns
player ID that is used f.e. by PlayerManager, or -1 when there is no player leader in the group hierarchy

Definition at line 507 of file SCR_AIGroup.c.

◆ GetFlagIsFromImageSet()

bool SCR_AIGroup::GetFlagIsFromImageSet ( )
inlineprotected

Definition at line 434 of file SCR_AIGroup.c.

◆ GetGroupFlag()

ResourceName SCR_AIGroup::GetGroupFlag ( )
inlineprotected

Definition at line 444 of file SCR_AIGroup.c.

◆ GetGroupID()

int SCR_AIGroup::GetGroupID ( )
inlineprotected

Definition at line 935 of file SCR_AIGroup.c.

◆ GetGroupRole()

SCR_EGroupRole SCR_AIGroup::GetGroupRole ( )
inlineprotected

Definition at line 568 of file SCR_AIGroup.c.

◆ GetGroupRoleName()

string SCR_AIGroup::GetGroupRoleName ( )
inlineprotected
Returns
localized group role

Definition at line 575 of file SCR_AIGroup.c.

◆ GetGroupUtilityComponent()

SCR_AIGroupUtilityComponent SCR_AIGroup::GetGroupUtilityComponent ( )
inlineprotected

Definition at line 208 of file SCR_AIGroup.c.

◆ GetLeaderID()

int SCR_AIGroup::GetLeaderID ( )
inlineprotected

Definition at line 499 of file SCR_AIGroup.c.

◆ GetMaster()

SCR_AIGroup SCR_AIGroup::GetMaster ( )
inlineprotected

Get master group that gives orders to this slave subgroup

Definition at line 2629 of file SCR_AIGroup.c.

◆ GetMaxMembers()

int SCR_AIGroup::GetMaxMembers ( )
inlineprotected

Definition at line 947 of file SCR_AIGroup.c.

◆ GetNameAuthorID()

int SCR_AIGroup::GetNameAuthorID ( )
inlineprotected

Definition at line 907 of file SCR_AIGroup.c.

◆ GetNumberOfMembersToSpawn()

int SCR_AIGroup::GetNumberOfMembersToSpawn ( )
inlineprotected

Definition at line 214 of file SCR_AIGroup.c.

◆ GetOnAgentAdded()

ScriptInvoker SCR_AIGroup::GetOnAgentAdded ( )
inlineprotected

Get event called every time an agent is called to a group. Called only on server. Invoker params are: AIGroup group, AIAgent agent

Returns
Script invoker

Definition at line 2243 of file SCR_AIGroup.c.

◆ GetOnAgentRemoved()

ScriptInvoker SCR_AIGroup::GetOnAgentRemoved ( )
inlineprotected

Get event called every time an agent is removed from a group. Called only on server. Invoker params are: AIGroup group, AIAgent agent

Returns
Script invoker

Definition at line 2258 of file SCR_AIGroup.c.

◆ GetOnAllDelayedEntitySpawned()

ScriptInvokerBase< ScriptInvokerAIGroup > SCR_AIGroup::GetOnAllDelayedEntitySpawned ( )
inlineprotected

Definition at line 2370 of file SCR_AIGroup.c.

◆ GetOnCurrentWaypointChanged()

ScriptInvoker SCR_AIGroup::GetOnCurrentWaypointChanged ( )
inlineprotected

Get event called when current waypoint of the group changes. Called only on server. Invoker params are: AIWaypoint currentWP, AIWaypoint prevWP

Returns
Script invoker

Definition at line 2288 of file SCR_AIGroup.c.

◆ GetOnCustomDescriptionChanged()

ScriptInvoker SCR_AIGroup::GetOnCustomDescriptionChanged ( )
inlinestaticprotected

Definition at line 1108 of file SCR_AIGroup.c.

◆ GetOnCustomNameChanged()

ScriptInvoker SCR_AIGroup::GetOnCustomNameChanged ( )
inlinestaticprotected

Definition at line 1096 of file SCR_AIGroup.c.

◆ GetOnEmpty()

ScriptInvoker_AIGroupOnEmpty SCR_AIGroup::GetOnEmpty ( )
inlineprotected

Get event called when the group becomes empty. Called only on server. No invoker params are passed.

Returns
Script invoker

Definition at line 2228 of file SCR_AIGroup.c.

◆ GetOnFactionChanged()

ScriptInvoker SCR_AIGroup::GetOnFactionChanged ( )
inlineprotected

Get event called when faction of group is changed

Returns
Script invoker

Definition at line 2361 of file SCR_AIGroup.c.

◆ GetOnFlagSelected()

ScriptInvoker SCR_AIGroup::GetOnFlagSelected ( )
inlinestaticprotected

Definition at line 454 of file SCR_AIGroup.c.

◆ GetOnFrequencyChanged()

ScriptInvoker SCR_AIGroup::GetOnFrequencyChanged ( )
inlinestaticprotected

Definition at line 1102 of file SCR_AIGroup.c.

◆ GetOnGroupRallyPointChanged()

ScriptInvokerBase< ScriptInvokerAIGroup > SCR_AIGroup::GetOnGroupRallyPointChanged ( )
inlinestaticprotected

Definition at line 478 of file SCR_AIGroup.c.

◆ GetOnGroupRoleChanged()

ScriptInvokerGroupRole SCR_AIGroup::GetOnGroupRoleChanged ( )
inlinestaticprotected

Definition at line 1114 of file SCR_AIGroup.c.

◆ GetOnInit()

ScriptInvoker SCR_AIGroup::GetOnInit ( )
inlineprotected

Get event called when all initial group members were spawned. Called only on server. Param is this aiGroup

Returns
Script invoker

Definition at line 2214 of file SCR_AIGroup.c.

◆ GetOnJoinPrivateGroupCancel()

ScriptInvoker SCR_AIGroup::GetOnJoinPrivateGroupCancel ( )
inlinestaticprotected

Definition at line 472 of file SCR_AIGroup.c.

◆ GetOnJoinPrivateGroupConfirm()

ScriptInvoker SCR_AIGroup::GetOnJoinPrivateGroupConfirm ( )
inlinestaticprotected

Definition at line 466 of file SCR_AIGroup.c.

◆ GetOnJoinPrivateGroupRequest()

ScriptInvoker SCR_AIGroup::GetOnJoinPrivateGroupRequest ( )
inlinestaticprotected

Definition at line 460 of file SCR_AIGroup.c.

◆ GetOnLeaderChanged()

ScriptInvoker SCR_AIGroup::GetOnLeaderChanged ( )
inlineprotected

Get event called every time a group leader changes. Called only on server. Invoker params are: AIGroup group, AIAgent currentLeader, AIAgent prevLeader

Returns
Script invoker

Definition at line 2273 of file SCR_AIGroup.c.

◆ GetOnMemberStateChange()

ScriptInvoker SCR_AIGroup::GetOnMemberStateChange ( )
inlineprotected

Definition at line 1063 of file SCR_AIGroup.c.

◆ GetOnPlayerAdded()

ScriptInvoker SCR_AIGroup::GetOnPlayerAdded ( )
inlinestaticprotected

Definition at line 1072 of file SCR_AIGroup.c.

◆ GetOnPlayerLeaderChanged()

ScriptInvoker SCR_AIGroup::GetOnPlayerLeaderChanged ( )
inlinestaticprotected

Definition at line 1084 of file SCR_AIGroup.c.

◆ GetOnPlayerRemoved()

ScriptInvoker SCR_AIGroup::GetOnPlayerRemoved ( )
inlinestaticprotected

Definition at line 1078 of file SCR_AIGroup.c.

◆ GetOnPrivateGroupChanged()

ScriptInvoker SCR_AIGroup::GetOnPrivateGroupChanged ( )
inlinestaticprotected

Definition at line 1090 of file SCR_AIGroup.c.

◆ GetOnWaypointAdded()

ScriptInvoker SCR_AIGroup::GetOnWaypointAdded ( )
inlineprotected

Get event called when a new waypoint is added to the group. Called only on server. Invoker params are: AIWaypoint wp

Returns
Script invoker

Definition at line 2318 of file SCR_AIGroup.c.

◆ GetOnWaypointCompleted()

ScriptInvoker SCR_AIGroup::GetOnWaypointCompleted ( )
inlineprotected

Get event called when current waypoint of the group is completed. Called only on server. Invoker params are: AIWaypoint wp

Returns
Script invoker

Definition at line 2303 of file SCR_AIGroup.c.

◆ GetOnWaypointRemoved()

ScriptInvoker SCR_AIGroup::GetOnWaypointRemoved ( )
inlineprotected

Get event called when a waypoint is going to be removed from the group. Warning: the wp may be null - listener deletes it in EditableGroupComponent! Called only on server. Invoker params are: AIWaypoint wp

Returns
Script invoker

Definition at line 2333 of file SCR_AIGroup.c.

◆ GetOnWaypointToRemove()

ScriptInvoker SCR_AIGroup::GetOnWaypointToRemove ( )
inlineprotected

Get event called when a waypoint is planned for removal but not removed from the group, yet. Called only on server. Invoker params are: AIWaypoint wp

Returns
Script invoker

Definition at line 2348 of file SCR_AIGroup.c.

◆ GetPlayerAndAgentCount()

int SCR_AIGroup::GetPlayerAndAgentCount ( bool checkMasterAndSlaves = false)
inlineprotected

Get the count of all players and AI in the group

Parameters
checkMasterAndSlavesIf true then it will also check any attached Master and/or slave group
Returns
Total group count of all AI and player member

Definition at line 633 of file SCR_AIGroup.c.

◆ GetPlayerCount()

int SCR_AIGroup::GetPlayerCount ( bool checkMasterAndSlaves = false)
inlineprotected

Get the count of all players in the group

Parameters
checkMasterAndSlavesIf true then it will also check any attached Master and/or slave groups
Returns
Total count of players

Definition at line 989 of file SCR_AIGroup.c.

◆ GetPlayerIDs()

array< int > SCR_AIGroup::GetPlayerIDs ( )
inlineprotected

Definition at line 978 of file SCR_AIGroup.c.

◆ GetPresetResource()

ResourceName SCR_AIGroup::GetPresetResource ( )
inlineprotected

Definition at line 1044 of file SCR_AIGroup.c.

◆ GetRadioFrequency()

int SCR_AIGroup::GetRadioFrequency ( )
inlineprotected

Definition at line 1574 of file SCR_AIGroup.c.

◆ GetRallyPointId()

int SCR_AIGroup::GetRallyPointId ( )
inlineprotected
Returns
Rally Point callsign ID

Definition at line 250 of file SCR_AIGroup.c.

◆ GetRequesterIDs()

int SCR_AIGroup::GetRequesterIDs ( out array< int > valueArray)
inlineprotected

Definition at line 393 of file SCR_AIGroup.c.

◆ GetRequiredRank()

SCR_ECharacterRank SCR_AIGroup::GetRequiredRank ( )
inlineprotected
Returns
required character rank

Definition at line 1008 of file SCR_AIGroup.c.

◆ GetSlave()

SCR_AIGroup SCR_AIGroup::GetSlave ( )
inlineprotected

Get slave subgroup that is used for AI characters when invited by players into this playable SCR_AIGroup.

Definition at line 2604 of file SCR_AIGroup.c.

◆ GetSpawnImmediately()

bool SCR_AIGroup::GetSpawnImmediately ( )
inlineprotected

Definition at line 2552 of file SCR_AIGroup.c.

◆ GetSpawnQueueSize()

int SCR_AIGroup::GetSpawnQueueSize ( )
inlineprotected

Definition at line 202 of file SCR_AIGroup.c.

◆ GetTotalAgentCount()

int SCR_AIGroup::GetTotalAgentCount ( )
inlineprotected

Get the count of all players and AI in both the group itself as well as the slave/master group(s)

Returns
Total group count of all AI and player member

Definition at line 666 of file SCR_AIGroup.c.

◆ GetTotalPlayerCount()

int SCR_AIGroup::GetTotalPlayerCount ( )
inlineprotected

Get the count of all players and AI in both the group itself as well as the slave/master group(s)

Returns
Total group count of all AI and player member

Definition at line 686 of file SCR_AIGroup.c.

◆ HasRequesterID()

bool SCR_AIGroup::HasRequesterID ( int id)
inlineprotected

Definition at line 341 of file SCR_AIGroup.c.

◆ IgnoreSnapToTerrain()

void SCR_AIGroup::IgnoreSnapToTerrain ( bool ignore)
inlinestaticprotected

Ignore snapping to terrain in the next spawned group. Used when some other system handles it and group's functionality would interfere with it. Has to be set before spawning a group, is reset to false afterwards.

Parameters
ignoreTrue to ignore terrain snap

Definition at line 2192 of file SCR_AIGroup.c.

◆ IgnoreSpawning()

void SCR_AIGroup::IgnoreSpawning ( bool ignore)
inlinestaticprotected

Ignore spawning group members in the next spawned group. Used when some other system handles it and group's functionality would interfere with it. Has to be set before spawning a group, is reset to false afterwards.

Parameters
ignoreTrue to ignore spawning

Definition at line 2202 of file SCR_AIGroup.c.

◆ IncreaseDeployedRadioCount()

void SCR_AIGroup::IncreaseDeployedRadioCount ( )
inlineprotected

Definition at line 2852 of file SCR_AIGroup.c.

◆ InitFactionKey()

bool SCR_AIGroup::InitFactionKey ( string factionKey)
inlineprotected

Set name of group's faction (only if it's not set yet)

Parameters
factionKey,Factionkey to set faction to
Returns
True if the faction was set

Definition at line 2061 of file SCR_AIGroup.c.

◆ InvokeSubagentsOnWaypointChanged()

void SCR_AIGroup::InvokeSubagentsOnWaypointChanged ( AIWaypoint newWaypoint)
inlineprotected

Invokes OnGroupWaypointChanged on all soldiers newWaypoint can be null

Definition at line 2478 of file SCR_AIGroup.c.

◆ IsAIControlledCharacterMember()

bool SCR_AIGroup::IsAIControlledCharacterMember ( SCR_ChimeraCharacter character)
inlineprotected

Definition at line 2659 of file SCR_AIGroup.c.

◆ IsCreatedByCommander()

bool SCR_AIGroup::IsCreatedByCommander ( )
inlineprotected

Definition at line 1032 of file SCR_AIGroup.c.

◆ IsFull()

bool SCR_AIGroup::IsFull ( )
inlineprotected

Definition at line 614 of file SCR_AIGroup.c.

◆ IsInitializing()

bool SCR_AIGroup::IsInitializing ( )
inlineprotected

Returns true if group is in initialization state, for instance while still spawning its members.

Definition at line 309 of file SCR_AIGroup.c.

◆ IsLoadoutInGroup()

bool SCR_AIGroup::IsLoadoutInGroup ( SCR_FactionPlayerLoadout loadout)
inlineprotected

Definition at line 2670 of file SCR_AIGroup.c.

◆ IsMaxMembersLimited()

bool SCR_AIGroup::IsMaxMembersLimited ( )
inlineprotected

Definition at line 953 of file SCR_AIGroup.c.

◆ IsPlayable()

bool SCR_AIGroup::IsPlayable ( )
inlineprotected

Definition at line 1580 of file SCR_AIGroup.c.

◆ IsPlayerInGroup()

bool SCR_AIGroup::IsPlayerInGroup ( int playerID)
inlineprotected

Definition at line 487 of file SCR_AIGroup.c.

◆ IsPlayerLeader()

bool SCR_AIGroup::IsPlayerLeader ( int playerID)
inlineprotected

Definition at line 493 of file SCR_AIGroup.c.

◆ IsPrivacyChangeable()

bool SCR_AIGroup::IsPrivacyChangeable ( )
inlineprotected

Definition at line 555 of file SCR_AIGroup.c.

◆ IsPrivate()

bool SCR_AIGroup::IsPrivate ( )
inlineprotected

Definition at line 542 of file SCR_AIGroup.c.

◆ IsRallyPointForced()

bool SCR_AIGroup::IsRallyPointForced ( )
inlineprotected
Returns
Rally Point force state

Definition at line 257 of file SCR_AIGroup.c.

◆ IsSlave()

bool SCR_AIGroup::IsSlave ( )
inlineprotected

Definition at line 620 of file SCR_AIGroup.c.

◆ LeaderLifeStateChanged()

void SCR_AIGroup::LeaderLifeStateChanged ( ECharacterLifeState previousLifeState,
ECharacterLifeState newLifeState )
inlineprotected

Definition at line 2821 of file SCR_AIGroup.c.

◆ ListenToMemberDeath()

void SCR_AIGroup::ListenToMemberDeath ( notnull IEntity groupMember)
inlineprotected

Definition at line 1216 of file SCR_AIGroup.c.

◆ NotificateGroupAIChange()

void SCR_AIGroup::NotificateGroupAIChange ( IEntity controlledEntity,
ENotification notificationType )
inlineprotected

Definition at line 1162 of file SCR_AIGroup.c.

◆ OnAgentAdded()

override void SCR_AIGroup::OnAgentAdded ( AIAgent child)
inlineprotected

Definition at line 2390 of file SCR_AIGroup.c.

◆ OnAgentRemoved()

override void SCR_AIGroup::OnAgentRemoved ( AIAgent child)
inlineprotected

Definition at line 2403 of file SCR_AIGroup.c.

◆ OnControllableEntitySpawned()

void SCR_AIGroup::OnControllableEntitySpawned ( IEntity controlledEntity,
notnull SCR_GadgetManagerComponent gadgetManager )
inlineprotected

Definition at line 1236 of file SCR_AIGroup.c.

◆ OnCurrentWaypointChanged()

override void SCR_AIGroup::OnCurrentWaypointChanged ( AIWaypoint currentWP,
AIWaypoint prevWP )
inlineprotected

Definition at line 2439 of file SCR_AIGroup.c.

◆ OnDescFilteredCallback()

void SCR_AIGroup::OnDescFilteredCallback ( array< string > resultText)
inlineprotected

Definition at line 862 of file SCR_AIGroup.c.

◆ OnEmpty()

override void SCR_AIGroup::OnEmpty ( )
inlineprotected

Definition at line 2379 of file SCR_AIGroup.c.

◆ OnGroupMemberStateChange()

void SCR_AIGroup::OnGroupMemberStateChange ( )
inlineprotected

Should only be called on the server (authority).

Definition at line 1199 of file SCR_AIGroup.c.

◆ OnLeaderChanged()

override void SCR_AIGroup::OnLeaderChanged ( AIAgent currentLeader,
AIAgent prevLeader )
inlineprotected

Definition at line 2410 of file SCR_AIGroup.c.

◆ OnMemberDeath()

void SCR_AIGroup::OnMemberDeath ( notnull SCR_CharacterControllerComponent memberController,
IEntity killerEntity,
Instigator killer )
inlineprotected

Definition at line 1206 of file SCR_AIGroup.c.

◆ OnNameFilteredCallback()

void SCR_AIGroup::OnNameFilteredCallback ( array< string > resultText)
inlineprotected

Definition at line 777 of file SCR_AIGroup.c.

◆ OnPlayerDisconnected()

void SCR_AIGroup::OnPlayerDisconnected ( int playerID)
inlineprotected

Should be only called on the server.

Definition at line 1175 of file SCR_AIGroup.c.

◆ OnPlayerLeftGame()

void SCR_AIGroup::OnPlayerLeftGame ( int playerId)
inlineprotected

Callback triggered when any player leaves the game

Parameters
[in]playerId

Definition at line 1458 of file SCR_AIGroup.c.

◆ OnSpawnPointFinalizeSpawn()

void SCR_AIGroup::OnSpawnPointFinalizeSpawn ( SCR_SpawnRequestComponent requestComponent,
SCR_SpawnData data,
IEntity entity )
inlineprotected

Definition at line 2527 of file SCR_AIGroup.c.

◆ OnWaypointAdded()

override void SCR_AIGroup::OnWaypointAdded ( AIWaypoint wp)
inlineprotected

Definition at line 2457 of file SCR_AIGroup.c.

◆ OnWaypointCompleted()

override void SCR_AIGroup::OnWaypointCompleted ( AIWaypoint wp)
inlineprotected

Definition at line 2448 of file SCR_AIGroup.c.

◆ OnWaypointRemoved()

override void SCR_AIGroup::OnWaypointRemoved ( AIWaypoint wp,
bool isCurrentWaypoint )
inlineprotected

Definition at line 2464 of file SCR_AIGroup.c.

◆ QueueAddAgent()

void SCR_AIGroup::QueueAddAgent ( int playerID)
inlineprotected

Definition at line 1260 of file SCR_AIGroup.c.

◆ ReleaseCompartment()

void SCR_AIGroup::ReleaseCompartment ( BaseCompartmentSlot compartment)
inlineprotected

Definition at line 2014 of file SCR_AIGroup.c.

◆ ReleaseCompartments()

void SCR_AIGroup::ReleaseCompartments ( )
inlineprotected

Definition at line 2024 of file SCR_AIGroup.c.

◆ ReleaseSmartAction()

void SCR_AIGroup::ReleaseSmartAction ( AISmartActionComponent component)
inlineprotected

Definition at line 2035 of file SCR_AIGroup.c.

◆ ReleaseSmartActions()

void SCR_AIGroup::ReleaseSmartActions ( )
inlineprotected

Definition at line 2045 of file SCR_AIGroup.c.

◆ RemoveAgentFromControlledEntity()

void SCR_AIGroup::RemoveAgentFromControlledEntity ( notnull IEntity controlledEntity)
inlineprotected

Definition at line 1143 of file SCR_AIGroup.c.

◆ RemoveAIEntityFromGroup()

bool SCR_AIGroup::RemoveAIEntityFromGroup ( IEntity entity)
inlineprotected

Definition at line 1925 of file SCR_AIGroup.c.

◆ RemovePlayer()

void SCR_AIGroup::RemovePlayer ( int playerID)
inlineprotected

Called on the server (authority).

Definition at line 1526 of file SCR_AIGroup.c.

◆ RemovePlayerAgent()

void SCR_AIGroup::RemovePlayerAgent ( int playerID)
inlineprotected

Definition at line 1507 of file SCR_AIGroup.c.

◆ RemoveRallyPoint()

void SCR_AIGroup::RemoveRallyPoint ( )
inlineprotected

Removes current group Rally Point.

Definition at line 242 of file SCR_AIGroup.c.

◆ RemoveRequester()

void SCR_AIGroup::RemoveRequester ( int playerID)
inlineprotected

Definition at line 347 of file SCR_AIGroup.c.

◆ RemoveStaticWaypointRefs()

void SCR_AIGroup::RemoveStaticWaypointRefs ( array< string > aWaypointNames)
inlineprotected

Definition at line 1874 of file SCR_AIGroup.c.

◆ RemoveWaypointFromGroup()

void SCR_AIGroup::RemoveWaypointFromGroup ( AIWaypoint waypoint)
inlineprotected

Definition at line 1956 of file SCR_AIGroup.c.

◆ RPC_DoAddDeniedRequester()

void SCR_AIGroup::RPC_DoAddDeniedRequester ( int playerID)
inlineprotected

Definition at line 1489 of file SCR_AIGroup.c.

◆ RPC_DoAddPlayer()

void SCR_AIGroup::RPC_DoAddPlayer ( int playerID)
inlineprotected

Definition at line 1277 of file SCR_AIGroup.c.

◆ RPC_DoAddRequester()

void SCR_AIGroup::RPC_DoAddRequester ( int playerID)
inlineprotected

Definition at line 1434 of file SCR_AIGroup.c.

◆ RPC_DoClearDeniedRequester()

void SCR_AIGroup::RPC_DoClearDeniedRequester ( )
inlineprotected

Definition at line 1475 of file SCR_AIGroup.c.

◆ RPC_DoClearRequesterIDs()

void SCR_AIGroup::RPC_DoClearRequesterIDs ( )
inlineprotected

Definition at line 1482 of file SCR_AIGroup.c.

◆ RPC_DoOnGroupMemberStateChange()

void SCR_AIGroup::RPC_DoOnGroupMemberStateChange ( )
inlineprotected

Definition at line 1191 of file SCR_AIGroup.c.

◆ RPC_DoRemoveLeavingPlayer()

void SCR_AIGroup::RPC_DoRemoveLeavingPlayer ( int playerID)
inlineprotected

Definition at line 1449 of file SCR_AIGroup.c.

◆ RPC_DoRemovePlayer()

void SCR_AIGroup::RPC_DoRemovePlayer ( int playerID)
inlineprotected

Definition at line 1497 of file SCR_AIGroup.c.

◆ RPC_DoRemoveRequester()

void SCR_AIGroup::RPC_DoRemoveRequester ( int playerID)
inlineprotected

Definition at line 1442 of file SCR_AIGroup.c.

◆ RPC_DoSetCustomDescription()

void SCR_AIGroup::RPC_DoSetCustomDescription ( string desc,
int authorID )
inlineprotected

Definition at line 840 of file SCR_AIGroup.c.

◆ RPC_DoSetCustomName()

void SCR_AIGroup::RPC_DoSetCustomName ( string name,
int authorID )
inlineprotected

Definition at line 752 of file SCR_AIGroup.c.

◆ RPC_DoSetFrequency()

void SCR_AIGroup::RPC_DoSetFrequency ( int frequency)
inlineprotected

Definition at line 1567 of file SCR_AIGroup.c.

◆ RPC_DoSetGroupFlag()

void SCR_AIGroup::RPC_DoSetGroupFlag ( int flagIndex,
bool isFromImageset )
inlineprotected

Definition at line 714 of file SCR_AIGroup.c.

◆ RPC_DoSetMaxGroupMembers()

void SCR_AIGroup::RPC_DoSetMaxGroupMembers ( int value)
inlineprotected

Definition at line 833 of file SCR_AIGroup.c.

◆ RPC_DoSetMaxMembers()

void SCR_AIGroup::RPC_DoSetMaxMembers ( int maxMembers)
inlineprotected

Definition at line 971 of file SCR_AIGroup.c.

◆ RPC_DoSetPrivacyChangeable()

void SCR_AIGroup::RPC_DoSetPrivacyChangeable ( bool IsPrivacyChangeable)
inlineprotected

Definition at line 1356 of file SCR_AIGroup.c.

◆ RPC_SetLeaderID()

void SCR_AIGroup::RPC_SetLeaderID ( int playerID)
inlineprotected

Definition at line 1332 of file SCR_AIGroup.c.

◆ RPC_SetPrivate()

void SCR_AIGroup::RPC_SetPrivate ( bool isPrivate)
inlineprotected

Definition at line 1342 of file SCR_AIGroup.c.

◆ RpcDo_RemoveRallyPoint()

void SCR_AIGroup::RpcDo_RemoveRallyPoint ( )
inlineprotected

Definition at line 1390 of file SCR_AIGroup.c.

◆ RpcDo_SetCreatedByCommander()

void SCR_AIGroup::RpcDo_SetCreatedByCommander ( bool isCreatedByCommander)
inlineprotected

Definition at line 1057 of file SCR_AIGroup.c.

◆ RpcDo_SetGroupRole()

void SCR_AIGroup::RpcDo_SetGroupRole ( SCR_EGroupRole groupRole)
inlineprotected

Definition at line 1363 of file SCR_AIGroup.c.

◆ RpcDo_SetRallyPoint()

void SCR_AIGroup::RpcDo_SetRallyPoint ( int callsignId,
bool force )
inlineprotected

Definition at line 1373 of file SCR_AIGroup.c.

◆ RpcDo_SetRequiredRank()

void SCR_AIGroup::RpcDo_SetRequiredRank ( SCR_ECharacterRank rank)
inlineprotected

Definition at line 1026 of file SCR_AIGroup.c.

◆ RplLoad()

override bool SCR_AIGroup::RplLoad ( ScriptBitReader reader)
inlineprotected

Definition at line 2745 of file SCR_AIGroup.c.

◆ RplSave()

override bool SCR_AIGroup::RplSave ( ScriptBitWriter writer)
inlineprotected

Definition at line 2690 of file SCR_AIGroup.c.

◆ SetCanDeleteIfNoPlayer()

void SCR_AIGroup::SetCanDeleteIfNoPlayer ( bool deleteEmpty)
inlineprotected

Sets if the group should be deleted when all players leave.

Definition at line 608 of file SCR_AIGroup.c.

◆ SetCreatedByCommander()

void SCR_AIGroup::SetCreatedByCommander ( bool isCreatedByCommander)
inlineprotected

Definition at line 1038 of file SCR_AIGroup.c.

◆ SetCustomDescription()

void SCR_AIGroup::SetCustomDescription ( string desc,
int authorID )
inlineprotected

called on server only

Definition at line 818 of file SCR_AIGroup.c.

◆ SetCustomGroupFlag()

void SCR_AIGroup::SetCustomGroupFlag ( ResourceName flag)
inlineprotected

Definition at line 425 of file SCR_AIGroup.c.

◆ SetCustomName()

void SCR_AIGroup::SetCustomName ( string name,
int authorID )
inlineprotected

Definition at line 744 of file SCR_AIGroup.c.

◆ SetDefaultActiveRadioChannel()

void SCR_AIGroup::SetDefaultActiveRadioChannel ( int id)
inlineprotected

Definition at line 525 of file SCR_AIGroup.c.

◆ SetDeleteWhenEmpty()

void SCR_AIGroup::SetDeleteWhenEmpty ( bool deleteWhenEmpty)
inlineprotected

Definition at line 2875 of file SCR_AIGroup.c.

◆ SetFaction()

bool SCR_AIGroup::SetFaction ( Faction faction)
inlineprotected

If Faction is set change faction to given faction Server Only

Parameters
faction,Factionto set
Returns
True if the faction was set

Definition at line 2075 of file SCR_AIGroup.c.

◆ SetFactionDelayed()

void SCR_AIGroup::SetFactionDelayed ( int factionIndex)
inlineprotected

Definition at line 2121 of file SCR_AIGroup.c.

◆ SetFlagIsFromImageSet()

void SCR_AIGroup::SetFlagIsFromImageSet ( bool value)
inlineprotected

Definition at line 416 of file SCR_AIGroup.c.

◆ SetGroupFlag()

void SCR_AIGroup::SetGroupFlag ( int flagIndex,
bool isFromImageset )
inlineprotected

called on server only

Definition at line 703 of file SCR_AIGroup.c.

◆ SetGroupID()

void SCR_AIGroup::SetGroupID ( int id)
inlineprotected

Definition at line 941 of file SCR_AIGroup.c.

◆ SetGroupLeader()

void SCR_AIGroup::SetGroupLeader ( int playerID)
inlineprotected

Called on the server (authority).

Definition at line 1316 of file SCR_AIGroup.c.

◆ SetGroupRole()

void SCR_AIGroup::SetGroupRole ( SCR_EGroupRole groupRole)
inlineprotected

Definition at line 561 of file SCR_AIGroup.c.

◆ SetMaster()

void SCR_AIGroup::SetMaster ( SCR_AIGroup group)
inlineprotected

Set master group that gives orders to this slave subgroup

Definition at line 2644 of file SCR_AIGroup.c.

◆ SetMaxGroupMembers()

void SCR_AIGroup::SetMaxGroupMembers ( int value)
inlineprotected

Definition at line 825 of file SCR_AIGroup.c.

◆ SetMaxMembers()

void SCR_AIGroup::SetMaxMembers ( int maxMembers)
inlineprotected

called on server only

Definition at line 960 of file SCR_AIGroup.c.

◆ SetMaxUnitsToSpawn()

void SCR_AIGroup::SetMaxUnitsToSpawn ( int cnt)
inlineprotected

Definition at line 2564 of file SCR_AIGroup.c.

◆ SetMemberSpawnDelay()

void SCR_AIGroup::SetMemberSpawnDelay ( int memberSpawnDelay)
inlineprotected

Set delay (ms) between spawning of individual group members. Can be used only before they are spawned.

Parameters
memberSpawnDelayDelay

Definition at line 2575 of file SCR_AIGroup.c.

◆ SetNewConsciousLeader()

void SCR_AIGroup::SetNewConsciousLeader ( )
inlineprotected

Definition at line 2828 of file SCR_AIGroup.c.

◆ SetNumberOfMembersToSpawn()

void SCR_AIGroup::SetNumberOfMembersToSpawn ( int number)
inlineprotected

Definition at line 220 of file SCR_AIGroup.c.

◆ SetPresetResource()

void SCR_AIGroup::SetPresetResource ( ResourceName preset)
inlineprotected

Definition at line 1050 of file SCR_AIGroup.c.

◆ SetPrivacyChangeable()

void SCR_AIGroup::SetPrivacyChangeable ( bool IsPrivacyChangeable)
inlineprotected

Definition at line 548 of file SCR_AIGroup.c.

◆ SetPrivate()

void SCR_AIGroup::SetPrivate ( bool isPrivate)
inlineprotected

Called on the server (authority).

Definition at line 535 of file SCR_AIGroup.c.

◆ SetRadioFrequency()

void SCR_AIGroup::SetRadioFrequency ( int frequency)
inlineprotected

Definition at line 1556 of file SCR_AIGroup.c.

◆ SetRallyPoint()

void SCR_AIGroup::SetRallyPoint ( notnull SCR_MilitaryBaseComponent base,
bool force = false )
inlineprotected

Sets the group Rally Point to the input base

Parameters
[in]baseto set rally point to
[in]ifrally point should be force set or not

Definition at line 229 of file SCR_AIGroup.c.

◆ SetRequiredRank()

void SCR_AIGroup::SetRequiredRank ( SCR_ECharacterRank rank)
inlineprotected
Parameters
[in]rank

Definition at line 1015 of file SCR_AIGroup.c.

◆ SetSlave()

void SCR_AIGroup::SetSlave ( SCR_AIGroup group)
inlineprotected

Set slave subgroup that is used for AI characters when invited by players into this playable SCR_AIGroup.

Definition at line 2619 of file SCR_AIGroup.c.

◆ SetSpawnImmediately()

void SCR_AIGroup::SetSpawnImmediately ( bool spawnImmediately)
inlineprotected

Definition at line 2558 of file SCR_AIGroup.c.

◆ SetWaypointParams()

void SCR_AIGroup::SetWaypointParams ( out AIWaypoint wp,
SCR_WaypointPrefabLocation prefabParams )
inlineprotected

Definition at line 1755 of file SCR_AIGroup.c.

◆ SpawnAllImmediately()

void SCR_AIGroup::SpawnAllImmediately ( )
inlineprotected

Definition at line 299 of file SCR_AIGroup.c.

◆ SpawnDelayedGroupMember()

bool SCR_AIGroup::SpawnDelayedGroupMember ( int spawnIndex)
inlineprotected

Definition at line 287 of file SCR_AIGroup.c.

◆ SpawnGroupMember()

bool SCR_AIGroup::SpawnGroupMember ( bool snapToTerrain,
int index,
ResourceName res,
bool editMode,
bool isLast )
inlineprotected

Definition at line 1657 of file SCR_AIGroup.c.

◆ SpawnUnits()

void SCR_AIGroup::SpawnUnits ( )
inlineprotected

Definition at line 2581 of file SCR_AIGroup.c.

Member Data Documentation

◆ Event_OnAgentAdded

ref ScriptInvoker SCR_AIGroup::Event_OnAgentAdded
protected

Definition at line 114 of file SCR_AIGroup.c.

◆ Event_OnAgentRemoved

ref ScriptInvoker SCR_AIGroup::Event_OnAgentRemoved
protected

Definition at line 115 of file SCR_AIGroup.c.

◆ Event_OnAllDelayedEntitySpawned

ref ScriptInvokerBase<ScriptInvokerAIGroup> SCR_AIGroup::Event_OnAllDelayedEntitySpawned
protected

Definition at line 196 of file SCR_AIGroup.c.

◆ Event_OnCurrentWaypointChanged

ref ScriptInvoker SCR_AIGroup::Event_OnCurrentWaypointChanged
protected

Definition at line 117 of file SCR_AIGroup.c.

◆ Event_OnEmpty

ref ScriptInvoker_AIGroupOnEmpty SCR_AIGroup::Event_OnEmpty
protected

Definition at line 113 of file SCR_AIGroup.c.

◆ Event_OnFactionChanged

ref ScriptInvoker SCR_AIGroup::Event_OnFactionChanged
protected

Definition at line 122 of file SCR_AIGroup.c.

◆ Event_OnGroupMemberStateChange

ref ScriptInvoker SCR_AIGroup::Event_OnGroupMemberStateChange
protected

Definition at line 124 of file SCR_AIGroup.c.

◆ Event_OnInit

ref ScriptInvoker SCR_AIGroup::Event_OnInit
protected

Definition at line 112 of file SCR_AIGroup.c.

◆ Event_OnLeaderChanged

ref ScriptInvoker SCR_AIGroup::Event_OnLeaderChanged
protected

Definition at line 116 of file SCR_AIGroup.c.

◆ Event_OnWaypointAdded

ref ScriptInvoker SCR_AIGroup::Event_OnWaypointAdded
protected

Definition at line 119 of file SCR_AIGroup.c.

◆ Event_OnWaypointCompleted

ref ScriptInvoker SCR_AIGroup::Event_OnWaypointCompleted
protected

Definition at line 118 of file SCR_AIGroup.c.

◆ Event_OnWaypointRemoved

ref ScriptInvoker SCR_AIGroup::Event_OnWaypointRemoved
protected

Definition at line 120 of file SCR_AIGroup.c.

◆ Event_OnWaypointToRemove

ref ScriptInvoker SCR_AIGroup::Event_OnWaypointToRemove
protected

Definition at line 121 of file SCR_AIGroup.c.

◆ m_aAgentIDQueue

ref array<int> SCR_AIGroup::m_aAgentIDQueue = {}
protected

Definition at line 128 of file SCR_AIGroup.c.

◆ m_aAIMembers

ref array<SCR_ChimeraCharacter> SCR_AIGroup::m_aAIMembers = {}
protected

Definition at line 189 of file SCR_AIGroup.c.

◆ m_aAllocatedCompartments

ref array<BaseCompartmentSlot> SCR_AIGroup::m_aAllocatedCompartments = {}
protected

Definition at line 108 of file SCR_AIGroup.c.

◆ m_aAllocatedComponents

ref array<AISmartActionComponent> SCR_AIGroup::m_aAllocatedComponents = {}
protected

Definition at line 109 of file SCR_AIGroup.c.

◆ m_aDeniedRequesters

ref array<int> SCR_AIGroup::m_aDeniedRequesters = {}
protected

Definition at line 178 of file SCR_AIGroup.c.

◆ m_aPlayerIDs

ref array<int> SCR_AIGroup::m_aPlayerIDs = {}
protected

Definition at line 158 of file SCR_AIGroup.c.

◆ m_aRequesterIDs

ref array<int> SCR_AIGroup::m_aRequesterIDs = {}
protected

Definition at line 177 of file SCR_AIGroup.c.

◆ m_aSceneGroupUnitInstances

ref array<IEntity> SCR_AIGroup::m_aSceneGroupUnitInstances
protected

Definition at line 106 of file SCR_AIGroup.c.

◆ m_aSceneWaypointInstances

ref array<IEntity> SCR_AIGroup::m_aSceneWaypointInstances
protected

Definition at line 107 of file SCR_AIGroup.c.

◆ m_bDeleteIfNoPlayer

bool SCR_AIGroup::m_bDeleteIfNoPlayer
protected

Definition at line 141 of file SCR_AIGroup.c.

◆ m_bDeleteWhenEmpty

bool SCR_AIGroup::m_bDeleteWhenEmpty
protected

Definition at line 101 of file SCR_AIGroup.c.

◆ m_bForcedRallyPoint

bool SCR_AIGroup::m_bForcedRallyPoint
protected

Definition at line 184 of file SCR_AIGroup.c.

◆ m_bIsCreatedByCommander

bool SCR_AIGroup::m_bIsCreatedByCommander
protected

Definition at line 148 of file SCR_AIGroup.c.

◆ m_bIsPrivacyChangeable

bool SCR_AIGroup::m_bIsPrivacyChangeable = 1
protected

Definition at line 147 of file SCR_AIGroup.c.

◆ m_bPlayable

bool SCR_AIGroup::m_bPlayable
protected

Definition at line 138 of file SCR_AIGroup.c.

◆ m_bPrivate

bool SCR_AIGroup::m_bPrivate
protected

Definition at line 138 of file SCR_AIGroup.c.

◆ m_delayedSpawnList

ref array<ref SCR_AIGroup_DelayedSpawn> SCR_AIGroup::m_delayedSpawnList = {}
protected

Definition at line 195 of file SCR_AIGroup.c.

◆ m_eGroupRole

SCR_EGroupRole SCR_AIGroup::m_eGroupRole
protected

Definition at line 146 of file SCR_AIGroup.c.

◆ m_eRequiredRank

SCR_ECharacterRank SCR_AIGroup::m_eRequiredRank
protected

Definition at line 198 of file SCR_AIGroup.c.

◆ m_fMemberSpawnDelay

int SCR_AIGroup::m_fMemberSpawnDelay
protected

Definition at line 98 of file SCR_AIGroup.c.

◆ m_GroupUtilityComponent

SCR_AIGroupUtilityComponent SCR_AIGroup::m_GroupUtilityComponent
protected

Definition at line 190 of file SCR_AIGroup.c.

◆ m_iDefaultActiveRadioChannel

int SCR_AIGroup::m_iDefaultActiveRadioChannel
protected

Definition at line 154 of file SCR_AIGroup.c.

◆ m_iDeployedRadioCount

int SCR_AIGroup::m_iDeployedRadioCount = 0
protected

Definition at line 181 of file SCR_AIGroup.c.

◆ m_iDescriptionAuthorID

int SCR_AIGroup::m_iDescriptionAuthorID = 0
protected

Definition at line 152 of file SCR_AIGroup.c.

◆ m_iGroupID

int SCR_AIGroup::m_iGroupID = -1
protected

Definition at line 143 of file SCR_AIGroup.c.

◆ m_iGroupRadioFrequency

int SCR_AIGroup::m_iGroupRadioFrequency
protected

Definition at line 132 of file SCR_AIGroup.c.

◆ m_iLeaderID

int SCR_AIGroup::m_iLeaderID = -1
protected

Definition at line 144 of file SCR_AIGroup.c.

◆ m_iMaxMembers

int SCR_AIGroup::m_iMaxMembers
protected

Definition at line 135 of file SCR_AIGroup.c.

◆ m_iMaxUnitsToSpawn

int SCR_AIGroup::m_iMaxUnitsToSpawn = int.MAX
protected

Definition at line 111 of file SCR_AIGroup.c.

◆ m_iNameAuthorID

int SCR_AIGroup::m_iNameAuthorID = 0
protected

Definition at line 153 of file SCR_AIGroup.c.

◆ m_iNumOfMembersToSpawn

int SCR_AIGroup::m_iNumOfMembersToSpawn
protected

Definition at line 126 of file SCR_AIGroup.c.

◆ m_MasterGroup

SCR_AIGroup SCR_AIGroup::m_MasterGroup
protected

Definition at line 188 of file SCR_AIGroup.c.

◆ m_MasterGroupID

RplId SCR_AIGroup::m_MasterGroupID
protected

Definition at line 191 of file SCR_AIGroup.c.

◆ m_ProfanityCallbackDesc

ref SCR_ScriptProfanityFilterRequestCallback SCR_AIGroup::m_ProfanityCallbackDesc
protected

Definition at line 175 of file SCR_AIGroup.c.

◆ m_ProfanityCallbackName

ref SCR_ScriptProfanityFilterRequestCallback SCR_AIGroup::m_ProfanityCallbackName
protected

Definition at line 174 of file SCR_AIGroup.c.

◆ m_RallyPointId

int SCR_AIGroup::m_RallyPointId = -1
protected

Definition at line 183 of file SCR_AIGroup.c.

◆ m_rPreset

ResourceName SCR_AIGroup::m_rPreset
protected

Definition at line 149 of file SCR_AIGroup.c.

◆ m_sCustomDescription

string SCR_AIGroup::m_sCustomDescription = ""
protected

Definition at line 157 of file SCR_AIGroup.c.

◆ m_sCustomName

string SCR_AIGroup::m_sCustomName = ""
protected

Definition at line 156 of file SCR_AIGroup.c.

◆ m_SlaveGroup

SCR_AIGroup SCR_AIGroup::m_SlaveGroup
protected

Definition at line 187 of file SCR_AIGroup.c.

◆ m_SlaveGroupID

RplId SCR_AIGroup::m_SlaveGroupID
protected

Definition at line 192 of file SCR_AIGroup.c.

◆ m_UiInfo

ref SCR_AIGroupUIInfo SCR_AIGroup::m_UiInfo
protected

Definition at line 145 of file SCR_AIGroup.c.

◆ s_bIgnoreSnapToTerrain

bool SCR_AIGroup::s_bIgnoreSnapToTerrain
staticprotected

Definition at line 103 of file SCR_AIGroup.c.

◆ s_bIgnoreSpawning

bool SCR_AIGroup::s_bIgnoreSpawning
staticprotected

Definition at line 104 of file SCR_AIGroup.c.

◆ s_OnCustomDescChanged

ref ScriptInvoker SCR_AIGroup::s_OnCustomDescChanged = new ScriptInvoker()
staticprotected

Definition at line 166 of file SCR_AIGroup.c.

◆ s_OnCustomNameChanged

ref ScriptInvoker<SCR_AIGroup> SCR_AIGroup::s_OnCustomNameChanged = new ScriptInvoker()
staticprotected

Definition at line 163 of file SCR_AIGroup.c.

◆ s_OnFlagSelected

ref ScriptInvoker SCR_AIGroup::s_OnFlagSelected = new ScriptInvoker()
staticprotected

Definition at line 167 of file SCR_AIGroup.c.

◆ s_OnFrequencyChanged

ref ScriptInvoker SCR_AIGroup::s_OnFrequencyChanged = new ScriptInvoker()
staticprotected

Definition at line 164 of file SCR_AIGroup.c.

◆ s_OnGroupRallyPointChanged

ref ScriptInvokerBase<ScriptInvokerAIGroup> SCR_AIGroup::s_OnGroupRallyPointChanged
staticprotected

Definition at line 172 of file SCR_AIGroup.c.

◆ s_OnGroupRoleChanged

ref ScriptInvokerGroupRole SCR_AIGroup::s_OnGroupRoleChanged
staticprotected

Definition at line 171 of file SCR_AIGroup.c.

◆ s_OnJoinPrivateGroupCancel

ref ScriptInvoker SCR_AIGroup::s_OnJoinPrivateGroupCancel = new ScriptInvoker()
staticprotected

Definition at line 170 of file SCR_AIGroup.c.

◆ s_OnJoinPrivateGroupConfirm

ref ScriptInvoker SCR_AIGroup::s_OnJoinPrivateGroupConfirm = new ScriptInvoker()
staticprotected

Definition at line 169 of file SCR_AIGroup.c.

◆ s_OnJoinPrivateGroupRequest

ref ScriptInvoker SCR_AIGroup::s_OnJoinPrivateGroupRequest = new ScriptInvoker()
staticprotected

Definition at line 168 of file SCR_AIGroup.c.

◆ s_OnMaxMembersChanged

ref ScriptInvoker SCR_AIGroup::s_OnMaxMembersChanged = new ScriptInvoker()
staticprotected

Definition at line 165 of file SCR_AIGroup.c.

◆ s_OnPlayerAdded

ref ScriptInvoker SCR_AIGroup::s_OnPlayerAdded = new ScriptInvoker()
staticprotected

Definition at line 159 of file SCR_AIGroup.c.

◆ s_OnPlayerLeaderChanged

ref ScriptInvoker<int, int> SCR_AIGroup::s_OnPlayerLeaderChanged = new ScriptInvoker()
staticprotected

Definition at line 161 of file SCR_AIGroup.c.

◆ s_OnPlayerRemoved

ref ScriptInvoker SCR_AIGroup::s_OnPlayerRemoved = new ScriptInvoker()
staticprotected

Definition at line 160 of file SCR_AIGroup.c.

◆ s_OnPrivateGroupChanged

ref ScriptInvoker SCR_AIGroup::s_OnPrivateGroupChanged = new ScriptInvoker()
staticprotected

Definition at line 162 of file SCR_AIGroup.c.

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