Arma Reforger Script API
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
SCR_CampaignTask Interface Reference
Inheritance diagram for SCR_CampaignTask:
[legend]

Public Member Functions

override string GetIconSuffix ()
 
override void DoNotifyAssignment (int assigneeID)
 
override string GetTitle ()
 Return the title of this task.
 
override void SetIsPriority (bool isPrio)
 
override string GetDescription ()
 Return the description of this task.
 
override void Finish (bool showMsg=true)
 Marks the task as finished.
 
override void Fail (bool showMsg=true)
 Fails the task.
 
override string GetFinishText ()
 Returns a text informing about the task being finished.
 
void GetFinishTextData (out string text="", out string param1="", out string param2="", out string param3="", out string param4="", out string param5="")
 Returns text data informing about the task being finished.
 
override string GetMapDescriptorText ()
 
override void SetTitleWidgetText (notnull TextWidget textWidget, string taskText)
 
override string GetTitleText ()
 
override void SetDescriptionWidgetText (notnull TextWidget textWidget, string taskText)
 
SCR_CampaignTaskType GetType ()
 Returns the type of this task.
 
void SetType (SCR_CampaignTaskType type)
 Sets the type of this task.
 
override void Deserialize (ScriptBitReader reader)
 
override void Serialize (ScriptBitWriter writer)
 
override void SetTargetBase (notnull SCR_CampaignMilitaryBaseComponent targetBase)
 Sets the base that is marked as the target of this task.
 
void OnTargetBaseCaptured (SCR_MilitaryBaseComponent base, Faction faction)
 
void OnCampaignBaseSignalChanged (SCR_CampaignMilitaryBaseComponent base)
 
void SCR_CampaignTask (IEntitySource src, IEntity parent)
 
void ~SCR_CampaignTask ()
 
- Public Member Functions inherited from SCR_CampaignBaseTask
int GetTargetBaseId ()
 
void SetTargetBase (notnull SCR_CampaignMilitaryBaseComponent targetBase)
 Sets the base that is marked as the target of this task.
 
void OnMapOpenCallback (MapConfiguration config)
 
void OnMapZoom (float pixelPerUnit)
 
void SetOffset ()
 
float CalculateOffset ()
 
string GetBaseNameWithCallsign ()
 
SCR_CampaignMilitaryBaseComponent GetTargetBase ()
 Returns the base that is marked as target of this task.
 
override void Deserialize (ScriptBitReader reader)
 
override void Serialize (ScriptBitWriter writer)
 
- Public Member Functions inherited from SCR_BaseTask
void OnDelete ()
 
bool NotifyAssignment ()
 
bool NotifyUnassign ()
 
void DoNotifyAssignment (int assigneeID)
 
void DoNotifyUnassign (int assigneeID)
 
SCR_ERadioMsg GetAssignMessage ()
 
SCR_ERadioMsg GetUnassignMessage ()
 
ResourceName GetMapUIElementResourceName ()
 
string GetMapDescriptorText ()
 
void OnMapOpen (MapConfiguration config)
 
void OnHoverItem (MapItem item)
 
string GetTaskMapIconName ()
 
string GetTaskListIconName ()
 
string GetTaskListTaskTitle ()
 
string GetMajorModifier ()
 
string GetTaskListTaskText ()
 
Widget GetParentWidget (notnull Widget rootWidget)
 
ResourceName GetIconImageset ()
 
void SetHUDIcon ()
 
void SetWidgetIcon (ImageWidget image)
 
void ClearWidgetIcon ()
 Remove icon assigned to this task.
 
void UpdateMapTaskIcon ()
 
void UpdatePriorityMapTaskIcon ()
 
bool AssignTaskToAI (AIAgent agent)
 
string GetIconName ()
 
ResourceName GetImageSetName ()
 
string GetIconSuffix ()
 
string GetTitleIconString ()
 
void SetTitleWidgetText (notnull TextWidget textWidget, string taskText)
 
string GetTitleText ()
 
void SetDescriptionWidgetText (notnull TextWidget textWidget, string taskText)
 
Widget GenerateTaskDescriptionUI (notnull Widget rootWidget, array< Widget > widgets)
 
void UpdateTaskListAssignee ()
 
void OnAssigneeKilled ()
 
void CreateMapUIIcon ()
 
Faction GetTargetFaction ()
 Returns the faction that should complete this task.
 
void SetTargetFaction (Faction targetFaction)
 Sets the faction that should complete this task.
 
string GetFinishText ()
 Returns a text informing about the task being finished.
 
bool IsAssigned ()
 Returns whether the task is assigned to someone or not.
 
string GetAllAssigneeNamesString ()
 Returns a string with all the assignees on this task in following format: "PlayerA, PlayerB, ..., PlayerN".
 
void CheckAssigneeTimeout ()
 Checks all the assignees for timeout, if their time is up, they get unassigned.
 
void SetLastAssigneeAddedTimestamp (float timestamp)
 
void SetIndividual (bool individual)
 Set this task as task for an individual.
 
bool IsIndividual ()
 Returns whether this task is for an individual or not.
 
void SetIsPriority (bool isPrio)
 
bool IsPriority ()
 
bool IsAssignable ()
 
bool CanBeAssigned (out SCR_ECannotAssignReasons reason, int playerID=-1)
 Returns whether this task can be assigned to the player with the given player ID If playerID == -1, the local player is used as the target.
 
float GetLastAssigneeAddedTimestamp ()
 Returns the timestamp of last add assignee event.
 
float GetAssigneeTimeLeft ()
 Returns time left the assignee of this task has to finish it, after that they get automatically unassigned.
 
void SetTaskID (int taskID)
 Sets an ID of this task.
 
int GetTaskID ()
 Returns an ID of this task.
 
SCR_TaskState GetTaskState ()
 Returns the state of this task.
 
void SetTitle (string title)
 
string GetTitle ()
 Return the title of this task.
 
void SetDescription (string description)
 
string GetDescription ()
 Return the description of this task.
 
SCR_BaseTaskExecutor GetAssignee ()
 Returns the first assignee of this task.
 
int GetAssignees (out array< SCR_BaseTaskExecutor > assignees)
 Returns assignees of this task.
 
int GetAssigneeCount ()
 
void Cancel (bool showMsg=true)
 
void Remove ()
 Marks the task as removed.
 
void Create (bool showMsg=true)
 When the task is created.
 
void Finish (bool showMsg=true)
 Marks the task as finished.
 
void Fail (bool showMsg=true)
 Fails the task.
 
void RemoveAllAssignees ()
 Removes every assignee from this task.
 
void RemoveAssignee (SCR_BaseTaskExecutor assignee, SCR_EUnassignReason reason)
 Removes an assignee, specified as a parameter, from this task.
 
void AddAssignee (SCR_BaseTaskExecutor assignee, float timestamp)
 Adds a new assignee, specified as a parameter, to this task.
 
void InitOnSpawn (int pid, IEntity ent)
 
void ToggleHUDIcon (bool show, bool fade=true)
 
void UpdateHUDIcon ()
 
Widget GetTaskIconkWidget ()
 
void SetTaskIconWidget (Widget w)
 
void SetState (SCR_TaskState state)
 Changes the state of this task to the parameter.
 
void RegisterTaskUpdate (SCR_ETaskEventMask TaskEventMask)
 Registers task event mask for OnTaskUpdate.
 
void Serialize (ScriptBitWriter writer)
 
void Deserialize (ScriptBitReader reader)
 
override void EOnInit (IEntity owner)
 
void SCR_BaseTask (IEntitySource src, IEntity parent)
 
void ~SCR_BaseTask ()
 

Static Public Attributes

static const string CAMPAIGN_TASK_RECONFIGURED_TEXT = "#AR-CampaignTasks_Reconfigured-UC"
 
static const string CAMPAIGN_TASK_RECONFIGURED_BY_TEXT = "#AR-CampaignTasks_ReconfiguredBy-UC"
 
- Static Public Attributes inherited from SCR_CampaignBaseTask
const int MIN_OFFSET = 3
 
const int MAX_OFFSET = 80
 
- Static Public Attributes inherited from SCR_BaseTask
static const string TASK_AMOUNT_COMPLETED_TEXT = "#AR-Tasks_AmountCompleted"
 
static const string TASK_PROGRESS_TEXT = "#AR-Tasks_StatusProgress-UC"
 
static const string TASK_FINISHED_TEXT = "#AR-Tasks_StatusFinished-UC"
 
static const string TASK_AVAILABLE_TEXT = "#AR-Tasks_StatusNew-UC"
 
static const string TASK_HINT_TEXT = "#AR-Tasks_Hint"
 
static const string TASK_CANCELLED_TEXT = "#AR-Tasks_StatusCancelled-UC"
 
static const string TASK_COMPLETED_TEXT = "#AR-Tasks_StatusCompleted-UC"
 
static const string TASK_FAILED_TEXT = "#AR-Tasks_StatusFailed-UC"
 
static const float DEFAULT_ASSIGNEE_TIME_LIMIT = 1800
 
static const float DEFAULT_ASSIGNEE_TIMEOUT_TIME = 60
 
static const int INVALID_TIMESTAMP = -1
 
static const int INVALID_TASK_ID = -1
 
static int s_iCurrentTaskID = 0
 
const string TASK_BG_M = "Icon_M_Task_BG"
 
const string TASK_O_M = "Icon_M_Task_Outline"
 
const string TASK_BG = "Icon_Task_BG"
 
const string TASK_O = "Icon_Task_Outline"
 
const string TASK_H = "Icon_M_Task_Hover"
 
const string Task_S = "TaskIconSymbol"
 

Protected Member Functions

override bool DoneByAssignee ()
 
override void ShowAvailableTask (bool afterAssigneeRemoved=false)
 Shows a message about this task being available again.
 
override void ShowTaskProgress (bool showMsg=true)
 
- Protected Member Functions inherited from SCR_CampaignBaseTask
override void UpdateMapInfo ()
 
- Protected Member Functions inherited from SCR_BaseTask
void ShowPopUpNotification (string subtitle)
 
void UpdateMapInfo ()
 
bool DoneByAssignee ()
 
void ShowTaskProgress (bool showMsg=true)
 
void ShowAvailableTask (bool afterAssigneeRemoved=false)
 Shows a message informing about this task being available.
 
bool IsAssignedToLocalPlayer ()
 Returns whether this task is assigned to the local player.
 
void OnAssigneeRemoved (SCR_BaseTaskExecutor oldAssignee)
 An event called when an assignee has been removed from this task.
 
void OnAssigneeAdded (SCR_BaseTaskExecutor newAssignee)
 An event called when a new assignee has been added to this task.
 
void OnStateChanged (SCR_TaskState previousState, SCR_TaskState newState)
 An event called when the state of this task has been changed.
 

Protected Attributes

string m_sNameReconfigure
 
string m_sDescriptionReconfigure
 
string m_sAffix
 
SCR_CampaignTaskType m_eType
 
- Protected Attributes inherited from SCR_CampaignBaseTask
SCR_CampaignMilitaryBaseComponent m_TargetBase = null
 
int m_iTargetBaseId = -1
 
- Protected Attributes inherited from SCR_BaseTask
string m_sName
 
string m_sDescription
 
bool m_bAssignable
 
bool m_bIndividualTask
 
string m_sMapIconName
 
string m_sTaskListIconName
 
string m_sMajorModifier
 
ResourceName m_sMapUIElementResourceName
 
ResourceName m_sIconImageset
 
SCR_ERadioMsg m_eAssignMessage
 
bool m_bNotifyAssignment
 
SCR_ERadioMsg m_eUnassignMessage
 
bool m_bNotifyUnassign
 
ResourceName m_sHUDIcon
 
Faction m_TargetFaction = null
 
int m_iTaskID = INVALID_TASK_ID
 
float m_fAssigneeTimeLimit = DEFAULT_ASSIGNEE_TIME_LIMIT
 
float m_fLastAssigneeAddedTimestamp = INVALID_TIMESTAMP
 
ref array< SCR_BaseTaskExecutorm_aAssignees = new array<SCR_BaseTaskExecutor>()
 
SCR_TaskState m_eState
 
SCR_BaseTaskExecutor m_TimedOutAssignee = null
 
float m_fAssigneeTimeoutTimestamp = INVALID_TIMESTAMP
 
SCR_MapDescriptorComponent m_MapDescriptor
 
ImageWidget m_wHUDIcon
 
Widget m_wMapTaskIcon
 
Widget m_wTaskListDescription
 
bool m_bIsPriority
 
SCR_PlayerFactionAffiliationComponent m_sPlyFactionAffilComp
 
float m_fMajorSize = 80
 

Constructor & Destructor Documentation

◆ SCR_CampaignTask()

void SCR_CampaignTask.SCR_CampaignTask ( IEntitySource  src,
IEntity  parent 
)

◆ ~SCR_CampaignTask()

void SCR_CampaignTask.~SCR_CampaignTask ( )

Member Function Documentation

◆ Deserialize()

override void SCR_CampaignTask.Deserialize ( ScriptBitReader  reader)

Implements SCR_CampaignBaseTask.

◆ DoneByAssignee()

override bool SCR_CampaignTask.DoneByAssignee ( )
protected

Implements SCR_BaseTask.

◆ DoNotifyAssignment()

override void SCR_CampaignTask.DoNotifyAssignment ( int  assigneeID)

Implements SCR_BaseTask.

◆ Fail()

override void SCR_CampaignTask.Fail ( bool  showMsg = true)

Fails the task.

Implements SCR_BaseTask.

◆ Finish()

override void SCR_CampaignTask.Finish ( bool  showMsg = true)

Marks the task as finished.

Implements SCR_BaseTask.

◆ GetDescription()

override string SCR_CampaignTask.GetDescription ( )

Return the description of this task.

Implements SCR_BaseTask.

◆ GetFinishText()

override string SCR_CampaignTask.GetFinishText ( )

Returns a text informing about the task being finished.

Implements SCR_BaseTask.

◆ GetFinishTextData()

void SCR_CampaignTask.GetFinishTextData ( out string  text = "",
out string  param1 = "",
out string  param2 = "",
out string  param3 = "",
out string  param4 = "",
out string  param5 = "" 
)

Returns text data informing about the task being finished.

◆ GetIconSuffix()

override string SCR_CampaignTask.GetIconSuffix ( )

Implements SCR_BaseTask.

◆ GetMapDescriptorText()

override string SCR_CampaignTask.GetMapDescriptorText ( )

Implements SCR_BaseTask.

◆ GetTitle()

override string SCR_CampaignTask.GetTitle ( )

Return the title of this task.

Implements SCR_BaseTask.

◆ GetTitleText()

override string SCR_CampaignTask.GetTitleText ( )

Implements SCR_BaseTask.

◆ GetType()

SCR_CampaignTaskType SCR_CampaignTask.GetType ( )

Returns the type of this task.

◆ OnCampaignBaseSignalChanged()

void SCR_CampaignTask.OnCampaignBaseSignalChanged ( SCR_CampaignMilitaryBaseComponent  base)

◆ OnTargetBaseCaptured()

void SCR_CampaignTask.OnTargetBaseCaptured ( SCR_MilitaryBaseComponent  base,
Faction  faction 
)

◆ Serialize()

override void SCR_CampaignTask.Serialize ( ScriptBitWriter  writer)

Implements SCR_CampaignBaseTask.

◆ SetDescriptionWidgetText()

override void SCR_CampaignTask.SetDescriptionWidgetText ( notnull TextWidget  textWidget,
string  taskText 
)

Implements SCR_BaseTask.

◆ SetIsPriority()

override void SCR_CampaignTask.SetIsPriority ( bool  isPrio)

Implements SCR_BaseTask.

◆ SetTargetBase()

override void SCR_CampaignTask.SetTargetBase ( notnull SCR_CampaignMilitaryBaseComponent  targetBase)

Sets the base that is marked as the target of this task.

For capture, target base should be the base to be captured. For defend, target base should be the base to be defended. For recon, target base should be the base around which recon should be done.

Implements SCR_CampaignBaseTask.

◆ SetTitleWidgetText()

override void SCR_CampaignTask.SetTitleWidgetText ( notnull TextWidget  textWidget,
string  taskText 
)

Implements SCR_BaseTask.

◆ SetType()

void SCR_CampaignTask.SetType ( SCR_CampaignTaskType  type)

Sets the type of this task.

◆ ShowAvailableTask()

override void SCR_CampaignTask.ShowAvailableTask ( bool  afterAssigneeRemoved = false)
protected

Shows a message about this task being available again.

Implements SCR_BaseTask.

◆ ShowTaskProgress()

override void SCR_CampaignTask.ShowTaskProgress ( bool  showMsg = true)
protected

Implements SCR_BaseTask.

Member Data Documentation

◆ CAMPAIGN_TASK_RECONFIGURED_BY_TEXT

const string SCR_CampaignTask.CAMPAIGN_TASK_RECONFIGURED_BY_TEXT = "#AR-CampaignTasks_ReconfiguredBy-UC"
static

◆ CAMPAIGN_TASK_RECONFIGURED_TEXT

const string SCR_CampaignTask.CAMPAIGN_TASK_RECONFIGURED_TEXT = "#AR-CampaignTasks_Reconfigured-UC"
static

◆ m_eType

SCR_CampaignTaskType SCR_CampaignTask.m_eType
protected

◆ m_sAffix

string SCR_CampaignTask.m_sAffix
protected

◆ m_sDescriptionReconfigure

string SCR_CampaignTask.m_sDescriptionReconfigure
protected

◆ m_sNameReconfigure

string SCR_CampaignTask.m_sNameReconfigure
protected

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