Arma Reforger Script API
Loading...
Searching...
No Matches
SCR_GroupTaskManagerComponent Interface Reference
Inheritance diagram for SCR_GroupTaskManagerComponent:

Public Member Functions

bool IsEnabledAssigningFrequencies ()
 Check if the assigning frequencies is enabled.
 
bool IsAnyFrequencyFreeForFaction (notnull Faction faction)
 
bool CanCreateNewTaskWithResourceName (ResourceName taskPrefabResourceName, notnull Faction faction)
 
bool CanCreateNewTaskWithTypename (TypeName taskTypename, notnull Faction faction)
 
bool CanCreateNewTaskWithClassName (string taskClassName, notnull Faction faction)
 
bool CanAssignFrequencyToTask (notnull SCR_Task task)
 
int GetTaskFrequency (notnull SCR_Task task)
 
SCR_Task GetTaskByFrequency (notnull Faction faction, int frequency)
 
string GetTaskTranslatedName (notnull SCR_Task task)
 
Faction GetTaskFaction (notnull SCR_Task task)
 
ScriptInvokerGroupTaskSet GetOnGroupTaskSet ()
 
ScriptInvokerRequestedGroupTaskSet GetOnRequestedGroupTaskSet ()
 
SCR_GroupTaskRelevance GetGroupTaskRelevance (TypeName taskTypename)
 
void SetGroupTaskOwnership (notnull SCR_Task task)
 
void SetGroupTask (notnull SCR_Task task, int byPlayerID)
 
void SetRequestedGroupTaskOwnership (notnull SCR_Task task)
 
void SetRequestedGroupTask (notnull SCR_Task task, int byPlayerID, int requesterGroupId)
 
array< SCR_AIGroupGetPlayableGroupsSortedByRelevance (notnull SCR_Task task, notnull Faction faction)
 
override bool RplSave (ScriptBitWriter writer)
 
override bool RplLoad (ScriptBitReader reader)
 
override void EOnInit (IEntity owner)
 
override void OnPostInit (IEntity owner)
 
override void OnDelete (IEntity owner)
 
void SCR_GroupTaskManagerComponent (IEntityComponentSource src, IEntity ent, IEntity parent)
 

Static Public Member Functions

static SCR_GroupTaskManagerComponent GetInstance ()
 

Protected Member Functions

void RpcDo_AddTaskFrequency (RplId taskRplId, int frequency)
 
void RpcDo_RemoveTaskFrequency (RplId taskRplId)
 
void SetFreeFrequencyForFaction (notnull Faction faction, bool isFree)
 
string GetTaskPrefabClassName (ResourceName taskPrefabName)
 
RplId GetTaskRplId (SCR_Task task)
 
void AssignFrequency (notnull SCR_Task task)
 
void ClaimFrequency (SCR_Task task, int frequency, Faction faction)
 
int GetFreeFrequency (Faction faction)
 
void ReleaseFrequency (notnull SCR_Task task)
 
void OnGroupRoleChanged (int groupID, SCR_EGroupRole groupRole)
 
void OnPlayableGroupRemoved (SCR_AIGroup group)
 
void OnPlayerRemoved (SCR_AIGroup group, int playerID)
 
void OnTaskRemoved (SCR_Task task)
 
void CheckAndDeleteRequestedTasks (SCR_AIGroup group)
 

Protected Attributes

ref SCR_GroupTaskRelevanceConfig m_GroupTaskRelevanceConfig
 
bool m_bEnabledAssigningFrequencies
 
int m_iTaskFrequencyOffset
 
int m_iTaskFrequencyMin
 
int m_iTaskFrequencyMax
 
ref array< string > m_aAllowedTasksWithFrequencies
 
ref array< bool > m_aFreeFactionFrequency = {}
 
SCR_TaskSystem m_TaskSystem
 
SCR_GroupsManagerComponent m_GroupsManager
 
FactionManager m_FactionManager
 
RplComponent m_RplComponent
 
ref ScriptInvokerGroupTaskSet m_OnGroupTaskSet
 
ref ScriptInvokerRequestedGroupTaskSet m_OnRequestedGroupTaskSet
 
ref map< int, ref FactionHolder > m_mUsedFrequenciesByFactionMap = new map<int, ref FactionHolder>()
 
ref map< int, int > m_mUsedFrequenciesByTaskMap = new map<int, int>()
 

Static Protected Attributes

static SCR_GroupTaskManagerComponent s_Instance
 <TaskRplId, frequency>
 

Constructor & Destructor Documentation

◆ SCR_GroupTaskManagerComponent()

void SCR_GroupTaskManagerComponent.SCR_GroupTaskManagerComponent ( IEntityComponentSource src,
IEntity ent,
IEntity parent )
Parameters
[in]src
[in]ent
[in]parent

Member Function Documentation

◆ AssignFrequency()

void SCR_GroupTaskManagerComponent.AssignFrequency ( notnull SCR_Task task)
protected

◆ CanAssignFrequencyToTask()

bool SCR_GroupTaskManagerComponent.CanAssignFrequencyToTask ( notnull SCR_Task task)
Parameters
[in]task
Returns
true when the task can be assigned a frequency

◆ CanCreateNewTaskWithClassName()

bool SCR_GroupTaskManagerComponent.CanCreateNewTaskWithClassName ( string taskClassName,
notnull Faction faction )
Parameters
[in]taskClassName
[in]faction
Returns
true when a task can be created for a faction

◆ CanCreateNewTaskWithResourceName()

bool SCR_GroupTaskManagerComponent.CanCreateNewTaskWithResourceName ( ResourceName taskPrefabResourceName,
notnull Faction faction )
Parameters
[in]taskPrefabResourceName
[in]faction
Returns
true when a task can be created for a faction

◆ CanCreateNewTaskWithTypename()

bool SCR_GroupTaskManagerComponent.CanCreateNewTaskWithTypename ( TypeName taskTypename,
notnull Faction faction )
Parameters
[in]taskTypename
[in]faction
Returns
true when a task can be created for a faction

◆ CheckAndDeleteRequestedTasks()

void SCR_GroupTaskManagerComponent.CheckAndDeleteRequestedTasks ( SCR_AIGroup group)
protected

◆ ClaimFrequency()

void SCR_GroupTaskManagerComponent.ClaimFrequency ( SCR_Task task,
int frequency,
Faction faction )
protected

◆ EOnInit()

override void SCR_GroupTaskManagerComponent.EOnInit ( IEntity owner)

◆ GetFreeFrequency()

int SCR_GroupTaskManagerComponent.GetFreeFrequency ( Faction faction)
protected

◆ GetGroupTaskRelevance()

SCR_GroupTaskRelevance SCR_GroupTaskManagerComponent.GetGroupTaskRelevance ( TypeName taskTypename)
Parameters
[in]taskTypename
Returns
group task relevance

◆ GetInstance()

static SCR_GroupTaskManagerComponent SCR_GroupTaskManagerComponent.GetInstance ( )
static
Returns
instance of SCR_GroupTaskManagerComponent

◆ GetOnGroupTaskSet()

ScriptInvokerGroupTaskSet SCR_GroupTaskManagerComponent.GetOnGroupTaskSet ( )

◆ GetOnRequestedGroupTaskSet()

ScriptInvokerRequestedGroupTaskSet SCR_GroupTaskManagerComponent.GetOnRequestedGroupTaskSet ( )

◆ GetPlayableGroupsSortedByRelevance()

array< SCR_AIGroup > SCR_GroupTaskManagerComponent.GetPlayableGroupsSortedByRelevance ( notnull SCR_Task task,
notnull Faction faction )
Parameters
[in]task
[in]faction
Returns
Playable groups sorted by group task relevance

◆ GetTaskByFrequency()

SCR_Task SCR_GroupTaskManagerComponent.GetTaskByFrequency ( notnull Faction faction,
int frequency )
Parameters
[in]faction
[in]frequency
Returns
task

◆ GetTaskFaction()

Faction SCR_GroupTaskManagerComponent.GetTaskFaction ( notnull SCR_Task task)
Parameters
[in]task
Returns
task faction

◆ GetTaskFrequency()

int SCR_GroupTaskManagerComponent.GetTaskFrequency ( notnull SCR_Task task)
Parameters
[in]task
Returns
task frequency

◆ GetTaskPrefabClassName()

string SCR_GroupTaskManagerComponent.GetTaskPrefabClassName ( ResourceName taskPrefabName)
protected

◆ GetTaskRplId()

RplId SCR_GroupTaskManagerComponent.GetTaskRplId ( SCR_Task task)
protected

◆ GetTaskTranslatedName()

string SCR_GroupTaskManagerComponent.GetTaskTranslatedName ( notnull SCR_Task task)
Parameters
[in]task
Returns
task translated name

◆ IsAnyFrequencyFreeForFaction()

bool SCR_GroupTaskManagerComponent.IsAnyFrequencyFreeForFaction ( notnull Faction faction)
Parameters
[in]faction
Returns
true if any frequency is free for a faction

◆ IsEnabledAssigningFrequencies()

bool SCR_GroupTaskManagerComponent.IsEnabledAssigningFrequencies ( )

Check if the assigning frequencies is enabled.

Returns
true when enabled

◆ OnDelete()

override void SCR_GroupTaskManagerComponent.OnDelete ( IEntity owner)

◆ OnGroupRoleChanged()

void SCR_GroupTaskManagerComponent.OnGroupRoleChanged ( int groupID,
SCR_EGroupRole groupRole )
protected

◆ OnPlayableGroupRemoved()

void SCR_GroupTaskManagerComponent.OnPlayableGroupRemoved ( SCR_AIGroup group)
protected

◆ OnPlayerRemoved()

void SCR_GroupTaskManagerComponent.OnPlayerRemoved ( SCR_AIGroup group,
int playerID )
protected

◆ OnPostInit()

override void SCR_GroupTaskManagerComponent.OnPostInit ( IEntity owner)

◆ OnTaskRemoved()

void SCR_GroupTaskManagerComponent.OnTaskRemoved ( SCR_Task task)
protected

◆ ReleaseFrequency()

void SCR_GroupTaskManagerComponent.ReleaseFrequency ( notnull SCR_Task task)
protected

◆ RpcDo_AddTaskFrequency()

void SCR_GroupTaskManagerComponent.RpcDo_AddTaskFrequency ( RplId taskRplId,
int frequency )
protected

◆ RpcDo_RemoveTaskFrequency()

void SCR_GroupTaskManagerComponent.RpcDo_RemoveTaskFrequency ( RplId taskRplId)
protected

◆ RplLoad()

override bool SCR_GroupTaskManagerComponent.RplLoad ( ScriptBitReader reader)

◆ RplSave()

override bool SCR_GroupTaskManagerComponent.RplSave ( ScriptBitWriter writer)

◆ SetFreeFrequencyForFaction()

void SCR_GroupTaskManagerComponent.SetFreeFrequencyForFaction ( notnull Faction faction,
bool isFree )
protected

◆ SetGroupTask()

void SCR_GroupTaskManagerComponent.SetGroupTask ( notnull SCR_Task task,
int byPlayerID )
Parameters
[in]task
[in]byPlayerID

◆ SetGroupTaskOwnership()

void SCR_GroupTaskManagerComponent.SetGroupTaskOwnership ( notnull SCR_Task task)
Parameters
[in]task

◆ SetRequestedGroupTask()

void SCR_GroupTaskManagerComponent.SetRequestedGroupTask ( notnull SCR_Task task,
int byPlayerID,
int requesterGroupId )
Parameters
[in]task
[in]byPlayerID
[in]requesterGroupId

◆ SetRequestedGroupTaskOwnership()

void SCR_GroupTaskManagerComponent.SetRequestedGroupTaskOwnership ( notnull SCR_Task task)
Parameters
[in]task

Member Data Documentation

◆ m_aAllowedTasksWithFrequencies

ref array<string> SCR_GroupTaskManagerComponent.m_aAllowedTasksWithFrequencies
protected

◆ m_aFreeFactionFrequency

ref array<bool> SCR_GroupTaskManagerComponent.m_aFreeFactionFrequency = {}
protected

◆ m_bEnabledAssigningFrequencies

bool SCR_GroupTaskManagerComponent.m_bEnabledAssigningFrequencies
protected

◆ m_FactionManager

FactionManager SCR_GroupTaskManagerComponent.m_FactionManager
protected

◆ m_GroupsManager

SCR_GroupsManagerComponent SCR_GroupTaskManagerComponent.m_GroupsManager
protected

◆ m_GroupTaskRelevanceConfig

ref SCR_GroupTaskRelevanceConfig SCR_GroupTaskManagerComponent.m_GroupTaskRelevanceConfig
protected

◆ m_iTaskFrequencyMax

int SCR_GroupTaskManagerComponent.m_iTaskFrequencyMax
protected

◆ m_iTaskFrequencyMin

int SCR_GroupTaskManagerComponent.m_iTaskFrequencyMin
protected

◆ m_iTaskFrequencyOffset

int SCR_GroupTaskManagerComponent.m_iTaskFrequencyOffset
protected

◆ m_mUsedFrequenciesByFactionMap

ref map<int, ref FactionHolder> SCR_GroupTaskManagerComponent.m_mUsedFrequenciesByFactionMap = new map<int, ref FactionHolder>()
protected

◆ m_mUsedFrequenciesByTaskMap

ref map<int, int> SCR_GroupTaskManagerComponent.m_mUsedFrequenciesByTaskMap = new map<int, int>()
protected

◆ m_OnGroupTaskSet

ref ScriptInvokerGroupTaskSet SCR_GroupTaskManagerComponent.m_OnGroupTaskSet
protected

◆ m_OnRequestedGroupTaskSet

ref ScriptInvokerRequestedGroupTaskSet SCR_GroupTaskManagerComponent.m_OnRequestedGroupTaskSet
protected

◆ m_RplComponent

RplComponent SCR_GroupTaskManagerComponent.m_RplComponent
protected

◆ m_TaskSystem

SCR_TaskSystem SCR_GroupTaskManagerComponent.m_TaskSystem
protected

◆ s_Instance

SCR_GroupTaskManagerComponent SCR_GroupTaskManagerComponent.s_Instance
staticprotected

<TaskRplId, frequency>


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