Arma Reforger Explorer 1.7.0.54
Arma Reforger Code Explorer by Zeroy - Thanks to MisterOutofTime
Loading...
Searching...
No Matches
SCR_AIGroup.c File Reference

Go to the source code of this file.

Classes

class  SCR_AIGroupClass
class  SCR_AIGroup

Typedefs

typedef func ScriptInvokerAIGroup
typedef func ScriptInvokerGroupRoleMethod
typedef ScriptInvokerBase< ScriptInvokerGroupRoleMethod > ScriptInvokerGroupRole
typedef func ScriptInvoker_AIGroupOnEmpty_Callback
typedef ScriptInvokerBase< ScriptInvoker_AIGroupOnEmpty_Callback > ScriptInvoker_AIGroupOnEmpty

Functions

void ScriptInvokerAIGroup (SCR_AIGroup group)
void ScriptInvokerGroupRoleMethod (int groupID, SCR_EGroupRole groupRole)
void ScriptInvoker_AIGroupOnEmpty_Callback (AIGroup group)
SCR_AIGroup ChimeraAIGroup BaseContainerProps (namingConvention:NamingConvention.NC_MUST_HAVE_NAME)] class SCR_WaypointPrefabLocation
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 ()

Variables

SCR_AIGroupClass snapToTerrain
int index
ResourceName resourceName
bool editMode
SCR_AIGroup IDLE = 0
SCR_AIGroup ATTACKING = 1
SCR_AIGroup MOVING = 2
SCR_AIGroup INVESTIGATING = 3
SCR_AIGroup RETREATING = 4
SCR_AIGroup DEFENDING = 5
SCR_AIGroup MANEUVERING = 6
SCR_AIGroup REQ_SUPPORT = 7
SCR_AIGroup REQ_ORDERS = 8
SCR_AIGroup FOLLOW = 9
SCR_AIGroup Wedge = 9
 Names of enum values must match formation names in AIWorld.
SCR_AIGroup Line = 9
SCR_AIGroup Column = 9
string m_faction
ref array< ResourceName > m_aUnitPrefabSlots
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

Typedef Documentation

◆ ScriptInvoker_AIGroupOnEmpty

typedef ScriptInvokerBase<ScriptInvoker_AIGroupOnEmpty_Callback> ScriptInvoker_AIGroupOnEmpty

Definition at line 72 of file SCR_AIGroup.c.

◆ ScriptInvoker_AIGroupOnEmpty_Callback

typedef func ScriptInvoker_AIGroupOnEmpty_Callback

Definition at line 71 of file SCR_AIGroup.c.

◆ ScriptInvokerAIGroup

typedef func ScriptInvokerAIGroup

Definition at line 4 of file SCR_AIGroup.c.

◆ ScriptInvokerGroupRole

typedef ScriptInvokerBase<ScriptInvokerGroupRoleMethod> ScriptInvokerGroupRole

Definition at line 8 of file SCR_AIGroup.c.

◆ ScriptInvokerGroupRoleMethod

typedef func ScriptInvokerGroupRoleMethod

Definition at line 7 of file SCR_AIGroup.c.

Function Documentation

◆ AddAgentFromControlledEntity()

void BaseContainerProps::AddAgentFromControlledEntity ( notnull IEntity controlledEntity)
protected

Definition at line 3994 of file SCR_AIGroup.c.

◆ AddAIEntityToGroup()

bool BaseContainerProps::AddAIEntityToGroup ( IEntity entity)
protected

Definition at line 4777 of file SCR_AIGroup.c.

◆ AddDeniedRequester()

void BaseContainerProps::AddDeniedRequester ( int playerID)
protected

Definition at line 3240 of file SCR_AIGroup.c.

◆ AddOnGadgetsLoadedListener()

void BaseContainerProps::AddOnGadgetsLoadedListener ( int playerID,
notnull IEntity controlledEntity )
protected

Definition at line 4097 of file SCR_AIGroup.c.

◆ AddPlayer()

void BaseContainerProps::AddPlayer ( int playerID)
protected

Called on the server (authority).

Definition at line 4272 of file SCR_AIGroup.c.

◆ AddRequester()

void BaseContainerProps::AddRequester ( int playerID)
protected

Definition at line 3270 of file SCR_AIGroup.c.

◆ AddVehiclesStatic()

void BaseContainerProps::AddVehiclesStatic ( array< string > aVehicleNames)
protected

Definition at line 4697 of file SCR_AIGroup.c.

◆ AddWaypointsDynamic()

void BaseContainerProps::AddWaypointsDynamic ( out array< IEntity > entityInstanceList,
array< ref SCR_WaypointPrefabLocation > prefabs )
protected

Definition at line 4636 of file SCR_AIGroup.c.

◆ AddWaypointsStatic()

void BaseContainerProps::AddWaypointsStatic ( array< string > aWaypointNames)
protected

Definition at line 4676 of file SCR_AIGroup.c.

◆ AddWaypointToGroup()

void BaseContainerProps::AddWaypointToGroup ( AIWaypoint waypoint)
protected

Definition at line 4818 of file SCR_AIGroup.c.

◆ AllocateCompartment()

void BaseContainerProps::AllocateCompartment ( BaseCompartmentSlot compartment)
protected

Definition at line 4866 of file SCR_AIGroup.c.

◆ AllocateSmartActions()

void BaseContainerProps::AllocateSmartActions ( array< AISmartActionComponent > components)
protected

Definition at line 4848 of file SCR_AIGroup.c.

◆ BaseContainerProps()

SCR_AIGroup ChimeraAIGroup BaseContainerProps ( namingConvention:NamingConvention. NC_MUST_HAVE_NAME)

Definition at line 72 of file SCR_AIGroup.c.

◆ BeginDelayedSpawn()

void BaseContainerProps::BeginDelayedSpawn ( )
protected

Definition at line 3186 of file SCR_AIGroup.c.

◆ BroadCastSetFaction()

void BaseContainerProps::BroadCastSetFaction ( int factionIndex)
protected

Definition at line 5000 of file SCR_AIGroup.c.

◆ CheckForLeader()

void BaseContainerProps::CheckForLeader ( int playerID,
bool noLeaderAllowed )
protected

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 4157 of file SCR_AIGroup.c.

◆ ClearDeniedRequester()

void BaseContainerProps::ClearDeniedRequester ( )
protected

Definition at line 3257 of file SCR_AIGroup.c.

◆ ClearRefs()

void BaseContainerProps::ClearRefs ( out array< IEntity > entityList)
protected

Definition at line 4769 of file SCR_AIGroup.c.

◆ ClearRequesters()

void BaseContainerProps::ClearRequesters ( )
protected

Definition at line 3250 of file SCR_AIGroup.c.

◆ CompleteAllWaypoints()

void BaseContainerProps::CompleteAllWaypoints ( )
protected

Definition at line 5752 of file SCR_AIGroup.c.

◆ CreateUnitEntities()

void BaseContainerProps::CreateUnitEntities ( bool editMode,
array< ResourceName > entityResourceNames )
protected

Definition at line 4457 of file SCR_AIGroup.c.

◆ DecreaseDeployedRadioCount()

void BaseContainerProps::DecreaseDeployedRadioCount ( )
protected

Definition at line 5730 of file SCR_AIGroup.c.

◆ DestroyEntities()

void BaseContainerProps::DestroyEntities ( out array< IEntity > entityList)
protected

Definition at line 4727 of file SCR_AIGroup.c.

◆ EndDelayedSpawn()

void BaseContainerProps::EndDelayedSpawn ( )
protected

Definition at line 3198 of file SCR_AIGroup.c.

◆ EOnFrame()

override void BaseContainerProps::EOnFrame ( IEntity owner,
float timeSlice )
protected

Definition at line 3134 of file SCR_AIGroup.c.

◆ GetAgentCountIncludingMasterAndSlaves()

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

Definition at line 3517 of file SCR_AIGroup.c.

◆ GetAIMembers()

array< SCR_ChimeraCharacter > BaseContainerProps::GetAIMembers ( )
protected

Definition at line 5521 of file SCR_AIGroup.c.

◆ GetAllocatedCompartments()

void BaseContainerProps::GetAllocatedCompartments ( out array< BaseCompartmentSlot > allocatedCompartments)
protected

Definition at line 4836 of file SCR_AIGroup.c.

◆ GetAllocatedSmartActions()

void BaseContainerProps::GetAllocatedSmartActions ( out array< AISmartActionComponent > allocatedComponents)
protected

Definition at line 4842 of file SCR_AIGroup.c.

◆ GetCallsigns()

void BaseContainerProps::GetCallsigns ( out string company,
out string platoon,
out string squad,
out string character,
out string format )
protected

Definition at line 4417 of file SCR_AIGroup.c.

◆ GetCustomDescription()

string BaseContainerProps::GetCustomDescription ( )
protected

Definition at line 3744 of file SCR_AIGroup.c.

◆ GetCustomName()

string BaseContainerProps::GetCustomName ( )
protected

Definition at line 3758 of file SCR_AIGroup.c.

◆ GetCustomNameWithOriginal()

string BaseContainerProps::GetCustomNameWithOriginal ( )
protected

Definition at line 3784 of file SCR_AIGroup.c.

◆ GetDefaultActiveRadioChannel()

int BaseContainerProps::GetDefaultActiveRadioChannel ( )
protected

Definition at line 3390 of file SCR_AIGroup.c.

◆ GetDeleteIfNoPlayer()

bool BaseContainerProps::GetDeleteIfNoPlayer ( )
protected

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

Definition at line 3472 of file SCR_AIGroup.c.

◆ GetDeniedRequesters()

int BaseContainerProps::GetDeniedRequesters ( out array< int > valueArray)
protected

Definition at line 3234 of file SCR_AIGroup.c.

◆ GetDeployedRadioCount()

int BaseContainerProps::GetDeployedRadioCount ( )
protected

Definition at line 5740 of file SCR_AIGroup.c.

◆ GetDescriptionAuthorID()

int BaseContainerProps::GetDescriptionAuthorID ( )
protected

Definition at line 3772 of file SCR_AIGroup.c.

◆ GetFaction()

Faction BaseContainerProps::GetFaction ( )
protected

Get group's faction from FactionManager

Returns
Faction (or null when faction is not found)

Definition at line 5027 of file SCR_AIGroup.c.

◆ GetFactionIndex()

int BaseContainerProps::GetFactionIndex ( )
protected

Get group's faction index from FactionManager

Returns
faction index

Definition at line 5047 of file SCR_AIGroup.c.

◆ GetFactionName()

string BaseContainerProps::GetFactionName ( )
protected

Get name of group's faction.

Returns
Faction name (search for it in FactionManager)

Definition at line 5017 of file SCR_AIGroup.c.

◆ GetFirstPlayerLeaderID()

int BaseContainerProps::GetFirstPlayerLeaderID ( )
protected

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 3378 of file SCR_AIGroup.c.

◆ GetFlagIsFromImageSet()

bool BaseContainerProps::GetFlagIsFromImageSet ( )
protected

Definition at line 3305 of file SCR_AIGroup.c.

◆ GetGroupFlag()

ResourceName BaseContainerProps::GetGroupFlag ( )
protected

Definition at line 3315 of file SCR_AIGroup.c.

◆ GetGroupID()

int BaseContainerProps::GetGroupID ( )
protected

Definition at line 3806 of file SCR_AIGroup.c.

◆ GetGroupRole()

SCR_EGroupRole BaseContainerProps::GetGroupRole ( )
protected

Definition at line 3439 of file SCR_AIGroup.c.

◆ GetGroupRoleName()

string BaseContainerProps::GetGroupRoleName ( )
protected
Returns
localized group role

Definition at line 3446 of file SCR_AIGroup.c.

◆ GetGroupUtilityComponent()

SCR_AIGroupUtilityComponent BaseContainerProps::GetGroupUtilityComponent ( )
protected

Definition at line 3079 of file SCR_AIGroup.c.

◆ GetLeaderID()

int BaseContainerProps::GetLeaderID ( )
protected

Definition at line 3370 of file SCR_AIGroup.c.

◆ GetMaster()

SCR_AIGroup BaseContainerProps::GetMaster ( )
protected

Get master group that gives orders to this slave subgroup

Definition at line 5500 of file SCR_AIGroup.c.

◆ GetMaxMembers()

int BaseContainerProps::GetMaxMembers ( )
protected

Definition at line 3818 of file SCR_AIGroup.c.

◆ GetNameAuthorID()

int BaseContainerProps::GetNameAuthorID ( )
protected

Definition at line 3778 of file SCR_AIGroup.c.

◆ GetNumberOfMembersToSpawn()

int BaseContainerProps::GetNumberOfMembersToSpawn ( )
protected

Definition at line 3085 of file SCR_AIGroup.c.

◆ GetOnAgentAdded()

ScriptInvoker BaseContainerProps::GetOnAgentAdded ( )
protected

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 5114 of file SCR_AIGroup.c.

◆ GetOnAgentRemoved()

ScriptInvoker BaseContainerProps::GetOnAgentRemoved ( )
protected

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 5129 of file SCR_AIGroup.c.

◆ GetOnAllDelayedEntitySpawned()

ScriptInvokerBase< ScriptInvokerAIGroup > BaseContainerProps::GetOnAllDelayedEntitySpawned ( )
protected

Definition at line 5241 of file SCR_AIGroup.c.

◆ GetOnCurrentWaypointChanged()

ScriptInvoker BaseContainerProps::GetOnCurrentWaypointChanged ( )
protected

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 5159 of file SCR_AIGroup.c.

◆ GetOnEmpty()

ScriptInvoker_AIGroupOnEmpty BaseContainerProps::GetOnEmpty ( )
protected

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

Returns
Script invoker

Definition at line 5099 of file SCR_AIGroup.c.

◆ GetOnFactionChanged()

ScriptInvoker BaseContainerProps::GetOnFactionChanged ( )
protected

Get event called when faction of group is changed

Returns
Script invoker

Definition at line 5232 of file SCR_AIGroup.c.

◆ GetOnInit()

ScriptInvoker BaseContainerProps::GetOnInit ( )
protected

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

Returns
Script invoker

Definition at line 5085 of file SCR_AIGroup.c.

◆ GetOnLeaderChanged()

ScriptInvoker BaseContainerProps::GetOnLeaderChanged ( )
protected

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 5144 of file SCR_AIGroup.c.

◆ GetOnMemberStateChange()

ScriptInvoker BaseContainerProps::GetOnMemberStateChange ( )
protected

Definition at line 3934 of file SCR_AIGroup.c.

◆ GetOnWaypointAdded()

ScriptInvoker BaseContainerProps::GetOnWaypointAdded ( )
protected

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 5189 of file SCR_AIGroup.c.

◆ GetOnWaypointCompleted()

ScriptInvoker BaseContainerProps::GetOnWaypointCompleted ( )
protected

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 5174 of file SCR_AIGroup.c.

◆ GetOnWaypointRemoved()

ScriptInvoker BaseContainerProps::GetOnWaypointRemoved ( )
protected

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 5204 of file SCR_AIGroup.c.

◆ GetOnWaypointToRemove()

ScriptInvoker BaseContainerProps::GetOnWaypointToRemove ( )
protected

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 5219 of file SCR_AIGroup.c.

◆ GetPlayerAndAgentCount()

int BaseContainerProps::GetPlayerAndAgentCount ( bool checkMasterAndSlaves = false)
protected

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 3504 of file SCR_AIGroup.c.

◆ GetPlayerCount()

int BaseContainerProps::GetPlayerCount ( bool checkMasterAndSlaves = false)
protected

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 3860 of file SCR_AIGroup.c.

◆ GetPlayerIDs()

array< int > BaseContainerProps::GetPlayerIDs ( )
protected

Definition at line 3849 of file SCR_AIGroup.c.

◆ GetPresetResource()

ResourceName BaseContainerProps::GetPresetResource ( )
protected

Definition at line 3915 of file SCR_AIGroup.c.

◆ GetRadioFrequency()

int BaseContainerProps::GetRadioFrequency ( )
protected

Definition at line 4445 of file SCR_AIGroup.c.

◆ GetRallyPointId()

int BaseContainerProps::GetRallyPointId ( )
protected
Returns
Rally Point callsign ID

Definition at line 3121 of file SCR_AIGroup.c.

◆ GetRequesterIDs()

int BaseContainerProps::GetRequesterIDs ( out array< int > valueArray)
protected

Definition at line 3264 of file SCR_AIGroup.c.

◆ GetRequiredRank()

SCR_ECharacterRank BaseContainerProps::GetRequiredRank ( )
protected
Returns
required character rank

Definition at line 3879 of file SCR_AIGroup.c.

◆ GetSlave()

SCR_AIGroup BaseContainerProps::GetSlave ( )
protected

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

Definition at line 5475 of file SCR_AIGroup.c.

◆ GetSpawnImmediately()

bool BaseContainerProps::GetSpawnImmediately ( )
protected

Definition at line 5423 of file SCR_AIGroup.c.

◆ GetSpawnQueueSize()

int BaseContainerProps::GetSpawnQueueSize ( )
protected

Definition at line 3073 of file SCR_AIGroup.c.

◆ GetTotalAgentCount()

int BaseContainerProps::GetTotalAgentCount ( )
protected

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 3537 of file SCR_AIGroup.c.

◆ GetTotalPlayerCount()

int BaseContainerProps::GetTotalPlayerCount ( )
protected

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 3557 of file SCR_AIGroup.c.

◆ HasRequesterID()

bool BaseContainerProps::HasRequesterID ( int id)
protected

Definition at line 3212 of file SCR_AIGroup.c.

◆ IncreaseDeployedRadioCount()

void BaseContainerProps::IncreaseDeployedRadioCount ( )
protected

Definition at line 5723 of file SCR_AIGroup.c.

◆ InitFactionKey()

bool BaseContainerProps::InitFactionKey ( string factionKey)
protected

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 4932 of file SCR_AIGroup.c.

◆ InvokeSubagentsOnWaypointChanged()

void BaseContainerProps::InvokeSubagentsOnWaypointChanged ( AIWaypoint newWaypoint)
protected

Invokes OnGroupWaypointChanged on all soldiers newWaypoint can be null

Definition at line 5349 of file SCR_AIGroup.c.

◆ IsAIControlledCharacterMember()

bool BaseContainerProps::IsAIControlledCharacterMember ( SCR_ChimeraCharacter character)
protected

Definition at line 5530 of file SCR_AIGroup.c.

◆ IsCreatedByCommander()

bool BaseContainerProps::IsCreatedByCommander ( )
protected

Definition at line 3903 of file SCR_AIGroup.c.

◆ IsFull()

bool BaseContainerProps::IsFull ( )
protected

Definition at line 3485 of file SCR_AIGroup.c.

◆ IsInitializing()

bool BaseContainerProps::IsInitializing ( )
protected

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

Definition at line 3180 of file SCR_AIGroup.c.

◆ IsLoadoutInGroup()

bool BaseContainerProps::IsLoadoutInGroup ( SCR_FactionPlayerLoadout loadout)
protected

Definition at line 5541 of file SCR_AIGroup.c.

◆ IsMaxMembersLimited()

bool BaseContainerProps::IsMaxMembersLimited ( )
protected

Definition at line 3824 of file SCR_AIGroup.c.

◆ IsPlayable()

bool BaseContainerProps::IsPlayable ( )
protected

Definition at line 4451 of file SCR_AIGroup.c.

◆ IsPlayerInGroup()

bool BaseContainerProps::IsPlayerInGroup ( int playerID)
protected

Definition at line 3358 of file SCR_AIGroup.c.

◆ IsPlayerLeader()

bool BaseContainerProps::IsPlayerLeader ( int playerID)
protected

Definition at line 3364 of file SCR_AIGroup.c.

◆ IsPrivacyChangeable()

bool BaseContainerProps::IsPrivacyChangeable ( )
protected

Definition at line 3426 of file SCR_AIGroup.c.

◆ IsPrivate()

bool BaseContainerProps::IsPrivate ( )
protected

Definition at line 3413 of file SCR_AIGroup.c.

◆ IsRallyPointForced()

bool BaseContainerProps::IsRallyPointForced ( )
protected
Returns
Rally Point force state

Definition at line 3128 of file SCR_AIGroup.c.

◆ IsSlave()

bool BaseContainerProps::IsSlave ( )
protected

Definition at line 3491 of file SCR_AIGroup.c.

◆ LeaderLifeStateChanged()

void BaseContainerProps::LeaderLifeStateChanged ( ECharacterLifeState previousLifeState,
ECharacterLifeState newLifeState )
protected

Definition at line 5692 of file SCR_AIGroup.c.

◆ ListenToMemberDeath()

void BaseContainerProps::ListenToMemberDeath ( notnull IEntity groupMember)
protected

Definition at line 4087 of file SCR_AIGroup.c.

◆ NotificateGroupAIChange()

void BaseContainerProps::NotificateGroupAIChange ( IEntity controlledEntity,
ENotification notificationType )
protected

Definition at line 4033 of file SCR_AIGroup.c.

◆ OnControllableEntitySpawned()

void BaseContainerProps::OnControllableEntitySpawned ( IEntity controlledEntity,
notnull SCR_GadgetManagerComponent gadgetManager )
protected

Definition at line 4107 of file SCR_AIGroup.c.

◆ OnDescFilteredCallback()

void BaseContainerProps::OnDescFilteredCallback ( array< string > resultText)
protected

Definition at line 3733 of file SCR_AIGroup.c.

◆ OnGroupMemberStateChange()

void BaseContainerProps::OnGroupMemberStateChange ( )
protected

Should only be called on the server (authority).

Definition at line 4070 of file SCR_AIGroup.c.

◆ OnMemberDeath()

void BaseContainerProps::OnMemberDeath ( notnull SCR_CharacterControllerComponent memberController,
IEntity killerEntity,
Instigator killer )
protected

Definition at line 4077 of file SCR_AIGroup.c.

◆ OnNameFilteredCallback()

void BaseContainerProps::OnNameFilteredCallback ( array< string > resultText)
protected

Definition at line 3648 of file SCR_AIGroup.c.

◆ OnPlayerDisconnected()

void BaseContainerProps::OnPlayerDisconnected ( int playerID)
protected

Should be only called on the server.

Definition at line 4046 of file SCR_AIGroup.c.

◆ OnPlayerLeftGame()

void BaseContainerProps::OnPlayerLeftGame ( int playerId)
protected

Callback triggered when any player leaves the game

Parameters
[in]playerId

Definition at line 4329 of file SCR_AIGroup.c.

◆ OnSpawnPointFinalizeSpawn()

void BaseContainerProps::OnSpawnPointFinalizeSpawn ( SCR_SpawnRequestComponent requestComponent,
SCR_SpawnData data,
IEntity entity )
protected

Definition at line 5398 of file SCR_AIGroup.c.

◆ QueueAddAgent()

void BaseContainerProps::QueueAddAgent ( int playerID)
protected

Definition at line 4131 of file SCR_AIGroup.c.

◆ ReleaseCompartment()

void BaseContainerProps::ReleaseCompartment ( BaseCompartmentSlot compartment)
protected

Definition at line 4885 of file SCR_AIGroup.c.

◆ ReleaseCompartments()

void BaseContainerProps::ReleaseCompartments ( )
protected

Definition at line 4895 of file SCR_AIGroup.c.

◆ ReleaseSmartAction()

void BaseContainerProps::ReleaseSmartAction ( AISmartActionComponent component)
protected

Definition at line 4906 of file SCR_AIGroup.c.

◆ ReleaseSmartActions()

void BaseContainerProps::ReleaseSmartActions ( )
protected

Definition at line 4916 of file SCR_AIGroup.c.

◆ RemoveAgentFromControlledEntity()

void BaseContainerProps::RemoveAgentFromControlledEntity ( notnull IEntity controlledEntity)
protected

Definition at line 4014 of file SCR_AIGroup.c.

◆ RemoveAIEntityFromGroup()

bool BaseContainerProps::RemoveAIEntityFromGroup ( IEntity entity)
protected

Definition at line 4796 of file SCR_AIGroup.c.

◆ RemovePlayer()

void BaseContainerProps::RemovePlayer ( int playerID)
protected

Called on the server (authority).

Definition at line 4397 of file SCR_AIGroup.c.

◆ RemovePlayerAgent()

void BaseContainerProps::RemovePlayerAgent ( int playerID)
protected

Definition at line 4378 of file SCR_AIGroup.c.

◆ RemoveRallyPoint()

void BaseContainerProps::RemoveRallyPoint ( )
protected

Removes current group Rally Point.

Definition at line 3113 of file SCR_AIGroup.c.

◆ RemoveRequester()

void BaseContainerProps::RemoveRequester ( int playerID)
protected

Definition at line 3218 of file SCR_AIGroup.c.

◆ RemoveStaticWaypointRefs()

void BaseContainerProps::RemoveStaticWaypointRefs ( array< string > aWaypointNames)
protected

Definition at line 4745 of file SCR_AIGroup.c.

◆ RemoveWaypointFromGroup()

void BaseContainerProps::RemoveWaypointFromGroup ( AIWaypoint waypoint)
protected

Definition at line 4827 of file SCR_AIGroup.c.

◆ RPC_DoAddDeniedRequester()

void BaseContainerProps::RPC_DoAddDeniedRequester ( int playerID)
protected

Definition at line 4360 of file SCR_AIGroup.c.

◆ RPC_DoAddPlayer()

void BaseContainerProps::RPC_DoAddPlayer ( int playerID)
protected

Definition at line 4148 of file SCR_AIGroup.c.

◆ RPC_DoAddRequester()

void BaseContainerProps::RPC_DoAddRequester ( int playerID)
protected

Definition at line 4305 of file SCR_AIGroup.c.

◆ RPC_DoClearDeniedRequester()

void BaseContainerProps::RPC_DoClearDeniedRequester ( )
protected

Definition at line 4346 of file SCR_AIGroup.c.

◆ RPC_DoClearRequesterIDs()

void BaseContainerProps::RPC_DoClearRequesterIDs ( )
protected

Definition at line 4353 of file SCR_AIGroup.c.

◆ RPC_DoOnGroupMemberStateChange()

void BaseContainerProps::RPC_DoOnGroupMemberStateChange ( )
protected

Definition at line 4062 of file SCR_AIGroup.c.

◆ RPC_DoRemoveLeavingPlayer()

void BaseContainerProps::RPC_DoRemoveLeavingPlayer ( int playerID)
protected

Definition at line 4320 of file SCR_AIGroup.c.

◆ RPC_DoRemovePlayer()

void BaseContainerProps::RPC_DoRemovePlayer ( int playerID)
protected

Definition at line 4368 of file SCR_AIGroup.c.

◆ RPC_DoRemoveRequester()

void BaseContainerProps::RPC_DoRemoveRequester ( int playerID)
protected

Definition at line 4313 of file SCR_AIGroup.c.

◆ RPC_DoSetCustomDescription()

void BaseContainerProps::RPC_DoSetCustomDescription ( string desc,
int authorID )
protected

Definition at line 3711 of file SCR_AIGroup.c.

◆ RPC_DoSetCustomName()

void BaseContainerProps::RPC_DoSetCustomName ( string name,
int authorID )
protected

Definition at line 3623 of file SCR_AIGroup.c.

◆ RPC_DoSetFrequency()

void BaseContainerProps::RPC_DoSetFrequency ( int frequency)
protected

Definition at line 4438 of file SCR_AIGroup.c.

◆ RPC_DoSetGroupFlag()

void BaseContainerProps::RPC_DoSetGroupFlag ( int flagIndex,
bool isFromImageset )
protected

Definition at line 3585 of file SCR_AIGroup.c.

◆ RPC_DoSetMaxGroupMembers()

void BaseContainerProps::RPC_DoSetMaxGroupMembers ( int value)
protected

Definition at line 3704 of file SCR_AIGroup.c.

◆ RPC_DoSetMaxMembers()

void BaseContainerProps::RPC_DoSetMaxMembers ( int maxMembers)
protected

Definition at line 3842 of file SCR_AIGroup.c.

◆ RPC_DoSetPrivacyChangeable()

void BaseContainerProps::RPC_DoSetPrivacyChangeable ( bool IsPrivacyChangeable)
protected

Definition at line 4227 of file SCR_AIGroup.c.

◆ RPC_SetLeaderID()

void BaseContainerProps::RPC_SetLeaderID ( int playerID)
protected

Definition at line 4203 of file SCR_AIGroup.c.

◆ RPC_SetPrivate()

void BaseContainerProps::RPC_SetPrivate ( bool isPrivate)
protected

Definition at line 4213 of file SCR_AIGroup.c.

◆ RpcDo_RemoveRallyPoint()

void BaseContainerProps::RpcDo_RemoveRallyPoint ( )
protected

Definition at line 4261 of file SCR_AIGroup.c.

◆ RpcDo_SetCreatedByCommander()

void BaseContainerProps::RpcDo_SetCreatedByCommander ( bool isCreatedByCommander)
protected

Definition at line 3928 of file SCR_AIGroup.c.

◆ RpcDo_SetGroupRole()

void BaseContainerProps::RpcDo_SetGroupRole ( SCR_EGroupRole groupRole)
protected

Definition at line 4234 of file SCR_AIGroup.c.

◆ RpcDo_SetRallyPoint()

void BaseContainerProps::RpcDo_SetRallyPoint ( int callsignId,
bool force )
protected

Definition at line 4244 of file SCR_AIGroup.c.

◆ RpcDo_SetRequiredRank()

void BaseContainerProps::RpcDo_SetRequiredRank ( SCR_ECharacterRank rank)
protected

Definition at line 3897 of file SCR_AIGroup.c.

◆ RplLoad()

override bool BaseContainerProps::RplLoad ( ScriptBitReader reader)
protected

Definition at line 5616 of file SCR_AIGroup.c.

◆ RplSave()

override bool BaseContainerProps::RplSave ( ScriptBitWriter writer)
protected

Definition at line 5561 of file SCR_AIGroup.c.

◆ SCR_AIGroup()

void BaseContainerProps::SCR_AIGroup ( IEntitySource src,
IEntity parent )
protected

Definition at line 5764 of file SCR_AIGroup.c.

◆ ScriptInvoker_AIGroupOnEmpty_Callback()

void ScriptInvoker_AIGroupOnEmpty_Callback ( AIGroup group)

◆ ScriptInvokerAIGroup()

void ScriptInvokerAIGroup ( SCR_AIGroup group)

◆ ScriptInvokerGroupRoleMethod()

void ScriptInvokerGroupRoleMethod ( int groupID,
SCR_EGroupRole groupRole )

◆ SetCanDeleteIfNoPlayer()

void BaseContainerProps::SetCanDeleteIfNoPlayer ( bool deleteEmpty)
protected

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

Definition at line 3479 of file SCR_AIGroup.c.

◆ SetCreatedByCommander()

void BaseContainerProps::SetCreatedByCommander ( bool isCreatedByCommander)
protected

Definition at line 3909 of file SCR_AIGroup.c.

◆ SetCustomDescription()

void BaseContainerProps::SetCustomDescription ( string desc,
int authorID )
protected

called on server only

Definition at line 3689 of file SCR_AIGroup.c.

◆ SetCustomGroupFlag()

void BaseContainerProps::SetCustomGroupFlag ( ResourceName flag)
protected

Definition at line 3296 of file SCR_AIGroup.c.

◆ SetCustomName()

void BaseContainerProps::SetCustomName ( string name,
int authorID )
protected

Definition at line 3615 of file SCR_AIGroup.c.

◆ SetDefaultActiveRadioChannel()

void BaseContainerProps::SetDefaultActiveRadioChannel ( int id)
protected

Definition at line 3396 of file SCR_AIGroup.c.

◆ SetDeleteWhenEmpty()

void BaseContainerProps::SetDeleteWhenEmpty ( bool deleteWhenEmpty)
protected

Definition at line 5746 of file SCR_AIGroup.c.

◆ SetFaction()

bool BaseContainerProps::SetFaction ( Faction faction)
protected

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 4946 of file SCR_AIGroup.c.

◆ SetFactionDelayed()

void BaseContainerProps::SetFactionDelayed ( int factionIndex)
protected

Definition at line 4992 of file SCR_AIGroup.c.

◆ SetFlagIsFromImageSet()

void BaseContainerProps::SetFlagIsFromImageSet ( bool value)
protected

Definition at line 3287 of file SCR_AIGroup.c.

◆ SetGroupFlag()

void BaseContainerProps::SetGroupFlag ( int flagIndex,
bool isFromImageset )
protected

called on server only

Definition at line 3574 of file SCR_AIGroup.c.

◆ SetGroupID()

void BaseContainerProps::SetGroupID ( int id)
protected

Definition at line 3812 of file SCR_AIGroup.c.

◆ SetGroupLeader()

void BaseContainerProps::SetGroupLeader ( int playerID)
protected

Called on the server (authority).

Definition at line 4187 of file SCR_AIGroup.c.

◆ SetGroupRole()

void BaseContainerProps::SetGroupRole ( SCR_EGroupRole groupRole)
protected

Definition at line 3432 of file SCR_AIGroup.c.

◆ SetMaster()

void BaseContainerProps::SetMaster ( SCR_AIGroup group)
protected

Set master group that gives orders to this slave subgroup

Definition at line 5515 of file SCR_AIGroup.c.

◆ SetMaxGroupMembers()

void BaseContainerProps::SetMaxGroupMembers ( int value)
protected

Definition at line 3696 of file SCR_AIGroup.c.

◆ SetMaxMembers()

void BaseContainerProps::SetMaxMembers ( int maxMembers)
protected

called on server only

Definition at line 3831 of file SCR_AIGroup.c.

◆ SetMaxUnitsToSpawn()

void BaseContainerProps::SetMaxUnitsToSpawn ( int cnt)
protected

Definition at line 5435 of file SCR_AIGroup.c.

◆ SetMemberSpawnDelay()

void BaseContainerProps::SetMemberSpawnDelay ( int memberSpawnDelay)
protected

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

Parameters
memberSpawnDelayDelay

Definition at line 5446 of file SCR_AIGroup.c.

◆ SetNewConsciousLeader()

void BaseContainerProps::SetNewConsciousLeader ( )
protected

Definition at line 5699 of file SCR_AIGroup.c.

◆ SetNumberOfMembersToSpawn()

void BaseContainerProps::SetNumberOfMembersToSpawn ( int number)
protected

Definition at line 3091 of file SCR_AIGroup.c.

◆ SetPresetResource()

void BaseContainerProps::SetPresetResource ( ResourceName preset)
protected

Definition at line 3921 of file SCR_AIGroup.c.

◆ SetPrivacyChangeable()

void BaseContainerProps::SetPrivacyChangeable ( bool IsPrivacyChangeable)
protected

Definition at line 3419 of file SCR_AIGroup.c.

◆ SetPrivate()

void BaseContainerProps::SetPrivate ( bool isPrivate)
protected

Called on the server (authority).

Definition at line 3406 of file SCR_AIGroup.c.

◆ SetRadioFrequency()

void BaseContainerProps::SetRadioFrequency ( int frequency)
protected

Definition at line 4427 of file SCR_AIGroup.c.

◆ SetRallyPoint()

void BaseContainerProps::SetRallyPoint ( notnull SCR_MilitaryBaseComponent base,
bool force = false )
protected

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 3100 of file SCR_AIGroup.c.

◆ SetRequiredRank()

void BaseContainerProps::SetRequiredRank ( SCR_ECharacterRank rank)
protected
Parameters
[in]rank

Definition at line 3886 of file SCR_AIGroup.c.

◆ SetSlave()

void BaseContainerProps::SetSlave ( SCR_AIGroup group)
protected

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

Definition at line 5490 of file SCR_AIGroup.c.

◆ SetSpawnImmediately()

void BaseContainerProps::SetSpawnImmediately ( bool spawnImmediately)
protected

Definition at line 5429 of file SCR_AIGroup.c.

◆ SetWaypointParams()

void BaseContainerProps::SetWaypointParams ( out AIWaypoint wp,
SCR_WaypointPrefabLocation prefabParams )
protected

Definition at line 4626 of file SCR_AIGroup.c.

◆ SpawnAllImmediately()

void BaseContainerProps::SpawnAllImmediately ( )
protected

Definition at line 3170 of file SCR_AIGroup.c.

◆ SpawnDelayedGroupMember()

bool BaseContainerProps::SpawnDelayedGroupMember ( int spawnIndex)
protected

Definition at line 3158 of file SCR_AIGroup.c.

◆ SpawnGroupMember()

bool BaseContainerProps::SpawnGroupMember ( bool snapToTerrain,
int index,
ResourceName res,
bool editMode,
bool isLast )
protected

Definition at line 4528 of file SCR_AIGroup.c.

◆ SpawnUnits()

void BaseContainerProps::SpawnUnits ( )
protected

Definition at line 5452 of file SCR_AIGroup.c.

◆ ~SCR_AIGroup()

void BaseContainerProps::~SCR_AIGroup ( )
protected

Definition at line 5770 of file SCR_AIGroup.c.

Variable Documentation

◆ ATTACKING

SCR_AIGroup ATTACKING = 1

◆ Column

SCR_AIGroup Column = 9

◆ DEFENDING

SCR_AIGroup DEFENDING = 5

◆ editMode

bool editMode

Definition at line 67 of file SCR_AIGroup.c.

◆ Event_OnAgentAdded

ref ScriptInvoker Event_OnAgentAdded
protected

Definition at line 2985 of file SCR_AIGroup.c.

◆ Event_OnAgentRemoved

ref ScriptInvoker Event_OnAgentRemoved
protected

Definition at line 2986 of file SCR_AIGroup.c.

◆ Event_OnAllDelayedEntitySpawned

ref ScriptInvokerBase<ScriptInvokerAIGroup> Event_OnAllDelayedEntitySpawned
protected

Definition at line 3067 of file SCR_AIGroup.c.

◆ Event_OnCurrentWaypointChanged

ref ScriptInvoker Event_OnCurrentWaypointChanged
protected

Definition at line 2988 of file SCR_AIGroup.c.

◆ Event_OnEmpty

ref ScriptInvoker_AIGroupOnEmpty Event_OnEmpty
protected

Definition at line 2984 of file SCR_AIGroup.c.

◆ Event_OnFactionChanged

ref ScriptInvoker Event_OnFactionChanged
protected

Definition at line 2993 of file SCR_AIGroup.c.

◆ Event_OnGroupMemberStateChange

ref ScriptInvoker Event_OnGroupMemberStateChange
protected

Definition at line 2995 of file SCR_AIGroup.c.

◆ Event_OnInit

ref ScriptInvoker Event_OnInit
protected

Definition at line 2983 of file SCR_AIGroup.c.

◆ Event_OnLeaderChanged

ref ScriptInvoker Event_OnLeaderChanged
protected

Definition at line 2987 of file SCR_AIGroup.c.

◆ Event_OnWaypointAdded

ref ScriptInvoker Event_OnWaypointAdded
protected

Definition at line 2990 of file SCR_AIGroup.c.

◆ Event_OnWaypointCompleted

ref ScriptInvoker Event_OnWaypointCompleted
protected

Definition at line 2989 of file SCR_AIGroup.c.

◆ Event_OnWaypointRemoved

ref ScriptInvoker Event_OnWaypointRemoved
protected

Definition at line 2991 of file SCR_AIGroup.c.

◆ Event_OnWaypointToRemove

ref ScriptInvoker Event_OnWaypointToRemove
protected

Definition at line 2992 of file SCR_AIGroup.c.

◆ FOLLOW

SCR_AIGroup FOLLOW = 9

◆ IDLE

SCR_AIGroup IDLE = 0

◆ index

int index

Definition at line 65 of file SCR_AIGroup.c.

◆ INVESTIGATING

SCR_AIGroup INVESTIGATING = 3

◆ Line

SCR_AIGroup Line = 9

◆ m_aAgentIDQueue

ref array<int> m_aAgentIDQueue = {}
protected

Definition at line 2999 of file SCR_AIGroup.c.

◆ m_aAIMembers

ref array<SCR_ChimeraCharacter> m_aAIMembers = {}
protected

Definition at line 3060 of file SCR_AIGroup.c.

◆ m_aAllocatedCompartments

ref array<BaseCompartmentSlot> m_aAllocatedCompartments = {}
protected

Definition at line 2979 of file SCR_AIGroup.c.

◆ m_aAllocatedComponents

ref array<AISmartActionComponent> m_aAllocatedComponents = {}
protected

Definition at line 2980 of file SCR_AIGroup.c.

◆ m_aDeniedRequesters

ref array<int> m_aDeniedRequesters = {}
protected

Definition at line 3049 of file SCR_AIGroup.c.

◆ m_aPlayerIDs

ref array<int> m_aPlayerIDs = {}
protected

Definition at line 3029 of file SCR_AIGroup.c.

◆ m_aRequesterIDs

ref array<int> m_aRequesterIDs = {}
protected

Definition at line 3048 of file SCR_AIGroup.c.

◆ m_aSceneGroupUnitInstances

ref array<IEntity> m_aSceneGroupUnitInstances
protected

Definition at line 2977 of file SCR_AIGroup.c.

◆ m_aSceneWaypointInstances

ref array<IEntity> m_aSceneWaypointInstances
protected

Definition at line 2978 of file SCR_AIGroup.c.

◆ m_aUnitPrefabSlots

ref array<ResourceName> m_aUnitPrefabSlots

Definition at line 2951 of file SCR_AIGroup.c.

◆ m_bDeleteIfNoPlayer

bool m_bDeleteIfNoPlayer
protected

Definition at line 3012 of file SCR_AIGroup.c.

◆ m_bDeleteWhenEmpty

bool m_bDeleteWhenEmpty
protected

Definition at line 2972 of file SCR_AIGroup.c.

◆ m_bForcedRallyPoint

bool m_bForcedRallyPoint
protected

Definition at line 3055 of file SCR_AIGroup.c.

◆ m_bIsCreatedByCommander

bool m_bIsCreatedByCommander
protected

Definition at line 3019 of file SCR_AIGroup.c.

◆ m_bIsPrivacyChangeable

bool m_bIsPrivacyChangeable = 1
protected

Definition at line 3018 of file SCR_AIGroup.c.

◆ m_bPlayable

bool m_bPlayable
protected

Definition at line 3009 of file SCR_AIGroup.c.

◆ m_bPrivate

bool m_bPrivate
protected

Definition at line 3009 of file SCR_AIGroup.c.

◆ m_delayedSpawnList

ref array<ref SCR_AIGroup_DelayedSpawn> m_delayedSpawnList = {}
protected

Definition at line 3066 of file SCR_AIGroup.c.

◆ m_eGroupRole

SCR_EGroupRole m_eGroupRole
protected

Definition at line 3017 of file SCR_AIGroup.c.

◆ m_eRequiredRank

SCR_ECharacterRank m_eRequiredRank
protected

Definition at line 3069 of file SCR_AIGroup.c.

◆ m_faction

string m_faction

Definition at line 2948 of file SCR_AIGroup.c.

◆ m_fMemberSpawnDelay

int m_fMemberSpawnDelay
protected

Definition at line 2969 of file SCR_AIGroup.c.

◆ m_GroupUtilityComponent

SCR_AIGroupUtilityComponent m_GroupUtilityComponent
protected

Definition at line 3061 of file SCR_AIGroup.c.

◆ m_iDefaultActiveRadioChannel

int m_iDefaultActiveRadioChannel
protected

Definition at line 3025 of file SCR_AIGroup.c.

◆ m_iDeployedRadioCount

int m_iDeployedRadioCount = 0
protected

Definition at line 3052 of file SCR_AIGroup.c.

◆ m_iDescriptionAuthorID

int m_iDescriptionAuthorID = 0
protected

Definition at line 3023 of file SCR_AIGroup.c.

◆ m_iGroupID

int m_iGroupID = -1
protected

Definition at line 3014 of file SCR_AIGroup.c.

◆ m_iGroupRadioFrequency

int m_iGroupRadioFrequency
protected

Definition at line 3003 of file SCR_AIGroup.c.

◆ m_iLeaderID

int m_iLeaderID = -1
protected

Definition at line 3015 of file SCR_AIGroup.c.

◆ m_iMaxMembers

int m_iMaxMembers
protected

Definition at line 3006 of file SCR_AIGroup.c.

◆ m_iMaxUnitsToSpawn

int m_iMaxUnitsToSpawn = int.MAX
protected

Definition at line 2982 of file SCR_AIGroup.c.

◆ m_iNameAuthorID

int m_iNameAuthorID = 0
protected

Definition at line 3024 of file SCR_AIGroup.c.

◆ m_iNumOfMembersToSpawn

int m_iNumOfMembersToSpawn
protected

Definition at line 2997 of file SCR_AIGroup.c.

◆ m_MasterGroup

SCR_AIGroup m_MasterGroup
protected

Definition at line 3059 of file SCR_AIGroup.c.

◆ m_MasterGroupID

RplId m_MasterGroupID
protected

Definition at line 3062 of file SCR_AIGroup.c.

◆ m_ProfanityCallbackDesc

ref SCR_ScriptProfanityFilterRequestCallback m_ProfanityCallbackDesc
protected

Definition at line 3046 of file SCR_AIGroup.c.

◆ m_ProfanityCallbackName

ref SCR_ScriptProfanityFilterRequestCallback m_ProfanityCallbackName
protected

Definition at line 3045 of file SCR_AIGroup.c.

◆ m_RallyPointId

int m_RallyPointId = -1
protected

Definition at line 3054 of file SCR_AIGroup.c.

◆ m_rPreset

ResourceName m_rPreset
protected

Definition at line 3020 of file SCR_AIGroup.c.

◆ m_sCustomDescription

string m_sCustomDescription = ""
protected

Definition at line 3028 of file SCR_AIGroup.c.

◆ m_sCustomName

string m_sCustomName = ""
protected

Definition at line 3027 of file SCR_AIGroup.c.

◆ m_SlaveGroup

SCR_AIGroup m_SlaveGroup
protected

Definition at line 3058 of file SCR_AIGroup.c.

◆ m_SlaveGroupID

RplId m_SlaveGroupID
protected

Definition at line 3063 of file SCR_AIGroup.c.

◆ m_UiInfo

ref SCR_AIGroupUIInfo m_UiInfo
protected

Definition at line 3016 of file SCR_AIGroup.c.

◆ MANEUVERING

SCR_AIGroup MANEUVERING = 6

◆ MOVING

SCR_AIGroup MOVING = 2

◆ REQ_ORDERS

SCR_AIGroup REQ_ORDERS = 8

◆ REQ_SUPPORT

SCR_AIGroup REQ_SUPPORT = 7

◆ resourceName

ResourceName resourceName

Definition at line 66 of file SCR_AIGroup.c.

◆ RETREATING

SCR_AIGroup RETREATING = 4

◆ snapToTerrain

SCR_AIGroupClass snapToTerrain

◆ Wedge

SCR_AIGroup Wedge = 9

Names of enum values must match formation names in AIWorld.