Arma Reforger Script API
|
Public Member Functions | |
override void | SetTitleWidgetText (notnull TextWidget textWidget, string taskText) |
override string | GetTitleText () |
override Widget | GenerateTaskDescriptionUI (notnull Widget rootWidget, array< Widget > widgets) |
override void | DoNotifyAssignment (int assigneeID) |
override void | DoNotifyUnassign (int assigneeID) |
override void | SetDescriptionWidgetText (notnull TextWidget textWidget, string taskText) |
override string | GetTaskListTaskText () |
override void | Cancel (bool showMsg=true) |
override void | Fail (bool showMsg=true) |
Fails the task. | |
override void | Finish (bool showMsg=true) |
Marks the task as finished. | |
void | RequesterDied () |
SCR_BaseTaskExecutor | GetRequester () |
string | GetRequesterName () |
void | OnEntityDeath (IEntity killedEntity) |
void | SetRequesterID (int requesterID) |
bool | AutoSetRequester () |
override 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. | |
void | SetRequester (SCR_BaseTaskExecutor requester) |
override void | EOnFrame (IEntity owner, float timeSlice) |
override void | Deserialize (ScriptBitReader reader) |
override void | Serialize (ScriptBitWriter writer) |
override void | EOnInit (IEntity owner) |
void | SCR_RequestedTask (IEntitySource src, IEntity parent) |
void | ~SCR_RequestedTask () |
![]() | |
void | OnDelete () |
bool | NotifyAssignment () |
bool | NotifyUnassign () |
SCR_ERadioMsg | GetAssignMessage () |
SCR_ERadioMsg | GetUnassignMessage () |
ResourceName | GetMapUIElementResourceName () |
string | GetMapDescriptorText () |
void | OnMapOpen (MapConfiguration config) |
void | OnHoverItem (MapItem item) |
string | GetFullTaskIconName () |
string | GetTaskMapIconName () |
string | GetTaskListIconNamePrefix () |
string | GetTaskListIconName () |
string | GetTaskListTaskTitle () |
string | GetMajorModifier () |
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 | 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 () |
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 | Remove () |
Marks the task as removed. | |
void | Create (bool showMsg=true) |
When the task is created. | |
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 | SCR_BaseTask (IEntitySource src, IEntity parent) |
void | ~SCR_BaseTask () |
Public Attributes | |
SCR_EXPRewards | m_AssigneeXPReward |
int | m_iRequesterID = -1 |
SCR_BaseTaskExecutor | m_Requester |
Static Public Attributes | |
static const string | TASK_REQUEST_TRANSMITTED_TEXT = "#AR-Tasks_StatusTransmitted-UC" |
static const string | TASK_SUPPORT_CANCELLED_TEXT = "#AR-Tasks_StatusCancelled-UC" |
![]() | |
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 void | ShowAvailableTask (bool afterAssigneeRemoved=false) |
Shows a message informing about this task being available. | |
bool | IsLocallyRequestedTask () |
![]() | |
void | ShowPopUpNotification (string subtitle) |
void | UpdateMapInfo () |
bool | DoneByAssignee () |
void | ShowTaskProgress (bool showMsg=true) |
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. | |
Static Protected Attributes | |
static const string | LOCAL_PLAYER_REQUEST = "#AR-Tasks_TitleRequest" |
![]() | |
static const float | PLATFORM_ICON_SIZE = 2 |
void SCR_RequestedTask.SCR_RequestedTask | ( | IEntitySource | src, |
IEntity | parent ) |
void SCR_RequestedTask.~SCR_RequestedTask | ( | ) |
bool SCR_RequestedTask.AutoSetRequester | ( | ) |
override bool SCR_RequestedTask.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.
Implements SCR_BaseTask.
override void SCR_RequestedTask.Cancel | ( | bool | showMsg = true | ) |
Implements SCR_BaseTask.
override void SCR_RequestedTask.Deserialize | ( | ScriptBitReader | reader | ) |
Implements SCR_BaseTask.
Implemented in SCR_EvacuateTask, and SCR_TransportTask.
override void SCR_RequestedTask.DoNotifyAssignment | ( | int | assigneeID | ) |
Implements SCR_BaseTask.
override void SCR_RequestedTask.DoNotifyUnassign | ( | int | assigneeID | ) |
Implements SCR_BaseTask.
override void SCR_RequestedTask.EOnFrame | ( | IEntity | owner, |
float | timeSlice ) |
override void SCR_RequestedTask.EOnInit | ( | IEntity | owner | ) |
Implements SCR_BaseTask.
Implemented in SCR_TransportTask.
override void SCR_RequestedTask.Fail | ( | bool | showMsg = true | ) |
Fails the task.
Implements SCR_BaseTask.
override void SCR_RequestedTask.Finish | ( | bool | showMsg = true | ) |
Marks the task as finished.
Implements SCR_BaseTask.
override Widget SCR_RequestedTask.GenerateTaskDescriptionUI | ( | notnull Widget | rootWidget, |
array< Widget > | widgets ) |
Implements SCR_BaseTask.
SCR_BaseTaskExecutor SCR_RequestedTask.GetRequester | ( | ) |
string SCR_RequestedTask.GetRequesterName | ( | ) |
override string SCR_RequestedTask.GetTaskListTaskText | ( | ) |
Implements SCR_BaseTask.
override string SCR_RequestedTask.GetTitleText | ( | ) |
Implements SCR_BaseTask.
|
protected |
void SCR_RequestedTask.OnEntityDeath | ( | IEntity | killedEntity | ) |
void SCR_RequestedTask.RequesterDied | ( | ) |
override void SCR_RequestedTask.Serialize | ( | ScriptBitWriter | writer | ) |
Implements SCR_BaseTask.
Implemented in SCR_EvacuateTask, and SCR_TransportTask.
override void SCR_RequestedTask.SetDescriptionWidgetText | ( | notnull TextWidget | textWidget, |
string | taskText ) |
Implements SCR_BaseTask.
void SCR_RequestedTask.SetRequester | ( | SCR_BaseTaskExecutor | requester | ) |
void SCR_RequestedTask.SetRequesterID | ( | int | requesterID | ) |
override void SCR_RequestedTask.SetTitleWidgetText | ( | notnull TextWidget | textWidget, |
string | taskText ) |
Implements SCR_BaseTask.
|
protected |
Shows a message informing about this task being available.
Implements SCR_BaseTask.
|
staticprotected |
SCR_EXPRewards SCR_RequestedTask.m_AssigneeXPReward |
int SCR_RequestedTask.m_iRequesterID = -1 |
SCR_BaseTaskExecutor SCR_RequestedTask.m_Requester |
|
static |
|
static |