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

Public Member Functions

bool IsTaskListOpen ()
 
void SetSelectedWidget (Widget w)
 
void StopHUDIconUpdates (SCR_BaseTask task)
 
void KeepHUDIconUpdated (int msTime, SCR_BaseTask task)
 
void OnTaskDeleted (SCR_BaseTask task)
 
void SelectTask (SCR_BaseTask task, Widget w=null)
 
SCR_BaseTask GetSelectedTask ()
 
Widget GetRootWidget ()
 
Widget GetParentWidget ()
 
array< Widget > GetWidgetsArray ()
 
void UnregisterTimer (SCR_BaseTask task)
 
void RegisterTimer (SCR_BaseTask task, TextWidget timerWidget)
 
void SetupAssigneeTexts (notnull SCR_BaseTask task, Widget parent)
 Creates assignee texts if needed.
 
void GenerateUI (Widget rootWidget, SCR_BaseTask taskToFocus=null)
 
override void EOnFrame (IEntity owner, float timeSlice)
 
string GetFormattedTimerText (float time)
 
Widget InitCurrentTaskWidget ()
 
bool HasLocallyAssignedTask ()
 
void ToggleCurrentTask (bool fade=true)
 
void HidePickAssignee ()
 
void HideDetail ()
 
void Action_PickAssignee ()
 
void Action_TasksOpen ()
 
void Action_ShowHint ()
 
void Action_TasksClose ()
 
void Action_ShowOnMap ()
 
void Action_AssignTask (SCR_BaseTask task=null)
 
void Action_ShowDetail ()
 
void Action_Expand ()
 Action expand task called from controller.
 
void OnMapOpen (MapConfiguration cfg)
 
void OnMapClose (MapConfiguration config)
 
void HideAllHUDIcons (bool fade=true)
 
void Action_ShowTasks (Widget targetWidget=null, SCR_BaseTask taskToFocus=null)
 
void Action_HideTasks ()
 
void Action_SelectTask (notnull SCR_BaseTask task)
 
void Action_RequestTasksClose ()
 Do not close task list directly, but request it on mapTaskListUI in ordero unregister all events and set the variables properly.
 
void UpdateTimers ()
 Updates the timers in task descriptions.
 
void EnableTaskContext (bool enable)
 
override void OnPostInit (IEntity owner)
 
void AddActionListeners ()
 
void RemoveActionListeners ()
 
override void EOnInit (IEntity owner)
 
void OnPlayerConnected (int playerID)
 
Widget CreateTaskList (Widget w=null)
 
void ClearWidget ()
 
void SCR_UITaskManagerComponent (IEntityComponentSource src, IEntity ent, IEntity parent)
 
void ~SCR_UITaskManagerComponent ()
 

Static Public Member Functions

static SCR_UITaskManagerComponent GetInstance ()
 
static void PanMapToTask (int taskID=-1, SCR_BaseTask task=null)
 

Public Attributes

SCR_MapEntity m_MapEntity
 
ref array< Widget > m_aWidgets = {}
 
ref map< SCR_BaseTask, TextWidget > m_mTasksTimers = new map<SCR_BaseTask, TextWidget>()
 
ResourceName m_UIResource
 

Static Public Attributes

static const ref ScriptInvoker s_OnTaskListVisible = new ScriptInvoker()
 
static SCR_UITaskManagerComponent s_Instance
 

Protected Member Functions

void GenerateRequestButtons ()
 
void ClearUI ()
 
void RemoveTaskFromList (SCR_BaseTask task)
 
void OnInputDeviceIsGamepad (bool isGamepad)
 
void OnDestroyed (Instigator killer, IEntity killerEntity)
 SCR_PlayerController Event Listeners are added back because they are previously removed on unconsciousness and if character dies, they need to added back.
 
void OnControlledEntityChanged (IEntity from, IEntity to)
 SCR_PlayerController Event Used to reinit Task manager Component when new entity is controlled.
 
void LifeStateChanged (ECharacterLifeState previousLifeState, ECharacterLifeState newLifeState)
 

Protected Attributes

ref array< SCR_BaseTaskm_aHUDIconUpdatedTasks = {}
 
Widget m_wWidgetToFocus = null
 
Widget m_wTasksUI = null
 
Widget m_wParentWidget = null
 
Widget m_wUI = null
 
Widget m_wTaskDetail = null
 
Widget m_wExpandButton = null
 
bool m_bVisible
 
bool m_bDetailVisible
 
bool m_bPickAssigneeVisible
 
bool m_bCurrentTaskVisible
 
bool m_bTaskContextEnabled
 
bool m_bIsUnconscious
 
float m_fCurrentTaskTime
 
SCR_BaseTask m_SelectedTask
 
SCR_BaseTask m_LastSelectedTask
 
bool m_bShowSelectedTaskOnMap
 
ResourceName m_sCurrentTaskLayout
 
ResourceName m_sTaskDetailLayout
 
float m_fCurrentTaskShowTime
 
bool m_bOpenTaskListOnMapOpen
 
ResourceName m_wPlayerListEntry
 
ref Color m_AssignedTaskColor
 
Widget m_wCurrentTask
 

Static Protected Attributes

static const string NO_ASSIGNED_TASK = "#AR-Tasks_NoAssignedTaskTitle"
 
static const string ASSIGN_TASK_HINT = "#AR-Tasks_NoAssignedTaskDescription"
 

Constructor & Destructor Documentation

◆ SCR_UITaskManagerComponent()

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

◆ ~SCR_UITaskManagerComponent()

void SCR_UITaskManagerComponent.~SCR_UITaskManagerComponent ( )

Member Function Documentation

◆ Action_AssignTask()

void SCR_UITaskManagerComponent.Action_AssignTask ( SCR_BaseTask  task = null)
Parameters
[in]task

◆ Action_Expand()

void SCR_UITaskManagerComponent.Action_Expand ( )

Action expand task called from controller.

◆ Action_HideTasks()

void SCR_UITaskManagerComponent.Action_HideTasks ( )

◆ Action_PickAssignee()

void SCR_UITaskManagerComponent.Action_PickAssignee ( )

◆ Action_RequestTasksClose()

void SCR_UITaskManagerComponent.Action_RequestTasksClose ( )

Do not close task list directly, but request it on mapTaskListUI in ordero unregister all events and set the variables properly.

◆ Action_SelectTask()

void SCR_UITaskManagerComponent.Action_SelectTask ( notnull SCR_BaseTask  task)
Parameters
[in]task

◆ Action_ShowDetail()

void SCR_UITaskManagerComponent.Action_ShowDetail ( )

◆ Action_ShowHint()

void SCR_UITaskManagerComponent.Action_ShowHint ( )

◆ Action_ShowOnMap()

void SCR_UITaskManagerComponent.Action_ShowOnMap ( )

◆ Action_ShowTasks()

void SCR_UITaskManagerComponent.Action_ShowTasks ( Widget  targetWidget = null,
SCR_BaseTask  taskToFocus = null 
)
Parameters
[in]targetWidget
[in]taskToFocus

◆ Action_TasksClose()

void SCR_UITaskManagerComponent.Action_TasksClose ( )

◆ Action_TasksOpen()

void SCR_UITaskManagerComponent.Action_TasksOpen ( )

◆ AddActionListeners()

void SCR_UITaskManagerComponent.AddActionListeners ( )

◆ ClearUI()

void SCR_UITaskManagerComponent.ClearUI ( )
protected

◆ ClearWidget()

void SCR_UITaskManagerComponent.ClearWidget ( )

◆ CreateTaskList()

Widget SCR_UITaskManagerComponent.CreateTaskList ( Widget  w = null)
Parameters
[in]w
Returns

◆ EnableTaskContext()

void SCR_UITaskManagerComponent.EnableTaskContext ( bool  enable)
Parameters
[in]enable

◆ EOnFrame()

override void SCR_UITaskManagerComponent.EOnFrame ( IEntity  owner,
float  timeSlice 
)

◆ EOnInit()

override void SCR_UITaskManagerComponent.EOnInit ( IEntity  owner)

◆ GenerateRequestButtons()

void SCR_UITaskManagerComponent.GenerateRequestButtons ( )
protected

◆ GenerateUI()

void SCR_UITaskManagerComponent.GenerateUI ( Widget  rootWidget,
SCR_BaseTask  taskToFocus = null 
)
Parameters
[in]rootWidget
[in]taskToFocus

◆ GetFormattedTimerText()

string SCR_UITaskManagerComponent.GetFormattedTimerText ( float  time)
Parameters
[in]time
Returns

◆ GetInstance()

static SCR_UITaskManagerComponent SCR_UITaskManagerComponent.GetInstance ( )
static
Returns

◆ GetParentWidget()

Widget SCR_UITaskManagerComponent.GetParentWidget ( )
Returns

◆ GetRootWidget()

Widget SCR_UITaskManagerComponent.GetRootWidget ( )
Returns

◆ GetSelectedTask()

SCR_BaseTask SCR_UITaskManagerComponent.GetSelectedTask ( )
Returns

◆ GetWidgetsArray()

array< Widget > SCR_UITaskManagerComponent.GetWidgetsArray ( )
Returns

◆ HasLocallyAssignedTask()

bool SCR_UITaskManagerComponent.HasLocallyAssignedTask ( )
Returns

◆ HideAllHUDIcons()

void SCR_UITaskManagerComponent.HideAllHUDIcons ( bool  fade = true)
Parameters
[in]fade

◆ HideDetail()

void SCR_UITaskManagerComponent.HideDetail ( )

◆ HidePickAssignee()

void SCR_UITaskManagerComponent.HidePickAssignee ( )

◆ InitCurrentTaskWidget()

Widget SCR_UITaskManagerComponent.InitCurrentTaskWidget ( )
Returns

◆ IsTaskListOpen()

bool SCR_UITaskManagerComponent.IsTaskListOpen ( )
Returns

◆ KeepHUDIconUpdated()

void SCR_UITaskManagerComponent.KeepHUDIconUpdated ( int  msTime,
SCR_BaseTask  task 
)
Parameters
[in]msTime
[in]task

◆ LifeStateChanged()

void SCR_UITaskManagerComponent.LifeStateChanged ( ECharacterLifeState  previousLifeState,
ECharacterLifeState  newLifeState 
)
protected

◆ OnControlledEntityChanged()

void SCR_UITaskManagerComponent.OnControlledEntityChanged ( IEntity  from,
IEntity  to 
)
protected

SCR_PlayerController Event Used to reinit Task manager Component when new entity is controlled.

◆ OnDestroyed()

void SCR_UITaskManagerComponent.OnDestroyed ( Instigator  killer,
IEntity  killerEntity 
)
protected

SCR_PlayerController Event Listeners are added back because they are previously removed on unconsciousness and if character dies, they need to added back.

◆ OnInputDeviceIsGamepad()

void SCR_UITaskManagerComponent.OnInputDeviceIsGamepad ( bool  isGamepad)
protected

◆ OnMapClose()

void SCR_UITaskManagerComponent.OnMapClose ( MapConfiguration  config)
Parameters
[in]config

◆ OnMapOpen()

void SCR_UITaskManagerComponent.OnMapOpen ( MapConfiguration  cfg)
Parameters
[in]cfg

◆ OnPlayerConnected()

void SCR_UITaskManagerComponent.OnPlayerConnected ( int  playerID)

◆ OnPostInit()

override void SCR_UITaskManagerComponent.OnPostInit ( IEntity  owner)

◆ OnTaskDeleted()

void SCR_UITaskManagerComponent.OnTaskDeleted ( SCR_BaseTask  task)
Parameters
[in]task

◆ PanMapToTask()

static void SCR_UITaskManagerComponent.PanMapToTask ( int  taskID = -1,
SCR_BaseTask  task = null 
)
static
Parameters
[in]taskID
[in]task

◆ RegisterTimer()

void SCR_UITaskManagerComponent.RegisterTimer ( SCR_BaseTask  task,
TextWidget  timerWidget 
)
Parameters
[in]task
[in]timerWidget

◆ RemoveActionListeners()

void SCR_UITaskManagerComponent.RemoveActionListeners ( )

◆ RemoveTaskFromList()

void SCR_UITaskManagerComponent.RemoveTaskFromList ( SCR_BaseTask  task)
protected

◆ SelectTask()

void SCR_UITaskManagerComponent.SelectTask ( SCR_BaseTask  task,
Widget  w = null 
)
Parameters
[in]task
[in]w

◆ SetSelectedWidget()

void SCR_UITaskManagerComponent.SetSelectedWidget ( Widget  w)
Parameters
[in]w

◆ SetupAssigneeTexts()

void SCR_UITaskManagerComponent.SetupAssigneeTexts ( notnull SCR_BaseTask  task,
Widget  parent 
)

Creates assignee texts if needed.

◆ StopHUDIconUpdates()

void SCR_UITaskManagerComponent.StopHUDIconUpdates ( SCR_BaseTask  task)
Parameters
[in]task

◆ ToggleCurrentTask()

void SCR_UITaskManagerComponent.ToggleCurrentTask ( bool  fade = true)
Parameters
[in]fade

◆ UnregisterTimer()

void SCR_UITaskManagerComponent.UnregisterTimer ( SCR_BaseTask  task)
Parameters
[in]task

◆ UpdateTimers()

void SCR_UITaskManagerComponent.UpdateTimers ( )

Updates the timers in task descriptions.

Member Data Documentation

◆ ASSIGN_TASK_HINT

const string SCR_UITaskManagerComponent.ASSIGN_TASK_HINT = "#AR-Tasks_NoAssignedTaskDescription"
staticprotected

◆ m_aHUDIconUpdatedTasks

ref array<SCR_BaseTask> SCR_UITaskManagerComponent.m_aHUDIconUpdatedTasks = {}
protected

◆ m_AssignedTaskColor

ref Color SCR_UITaskManagerComponent.m_AssignedTaskColor
protected

◆ m_aWidgets

ref array<Widget> SCR_UITaskManagerComponent.m_aWidgets = {}

◆ m_bCurrentTaskVisible

bool SCR_UITaskManagerComponent.m_bCurrentTaskVisible
protected

◆ m_bDetailVisible

bool SCR_UITaskManagerComponent.m_bDetailVisible
protected

◆ m_bIsUnconscious

bool SCR_UITaskManagerComponent.m_bIsUnconscious
protected

◆ m_bOpenTaskListOnMapOpen

bool SCR_UITaskManagerComponent.m_bOpenTaskListOnMapOpen
protected

◆ m_bPickAssigneeVisible

bool SCR_UITaskManagerComponent.m_bPickAssigneeVisible
protected

◆ m_bShowSelectedTaskOnMap

bool SCR_UITaskManagerComponent.m_bShowSelectedTaskOnMap
protected

◆ m_bTaskContextEnabled

bool SCR_UITaskManagerComponent.m_bTaskContextEnabled
protected

◆ m_bVisible

bool SCR_UITaskManagerComponent.m_bVisible
protected

◆ m_fCurrentTaskShowTime

float SCR_UITaskManagerComponent.m_fCurrentTaskShowTime
protected

◆ m_fCurrentTaskTime

float SCR_UITaskManagerComponent.m_fCurrentTaskTime
protected

◆ m_LastSelectedTask

SCR_BaseTask SCR_UITaskManagerComponent.m_LastSelectedTask
protected

◆ m_MapEntity

SCR_MapEntity SCR_UITaskManagerComponent.m_MapEntity

◆ m_mTasksTimers

ref map<SCR_BaseTask, TextWidget> SCR_UITaskManagerComponent.m_mTasksTimers = new map<SCR_BaseTask, TextWidget>()

◆ m_sCurrentTaskLayout

ResourceName SCR_UITaskManagerComponent.m_sCurrentTaskLayout
protected

◆ m_SelectedTask

SCR_BaseTask SCR_UITaskManagerComponent.m_SelectedTask
protected

◆ m_sTaskDetailLayout

ResourceName SCR_UITaskManagerComponent.m_sTaskDetailLayout
protected

◆ m_UIResource

ResourceName SCR_UITaskManagerComponent.m_UIResource

◆ m_wCurrentTask

Widget SCR_UITaskManagerComponent.m_wCurrentTask
protected

◆ m_wExpandButton

Widget SCR_UITaskManagerComponent.m_wExpandButton = null
protected

◆ m_wParentWidget

Widget SCR_UITaskManagerComponent.m_wParentWidget = null
protected

◆ m_wPlayerListEntry

ResourceName SCR_UITaskManagerComponent.m_wPlayerListEntry
protected

◆ m_wTaskDetail

Widget SCR_UITaskManagerComponent.m_wTaskDetail = null
protected

◆ m_wTasksUI

Widget SCR_UITaskManagerComponent.m_wTasksUI = null
protected

◆ m_wUI

Widget SCR_UITaskManagerComponent.m_wUI = null
protected

◆ m_wWidgetToFocus

Widget SCR_UITaskManagerComponent.m_wWidgetToFocus = null
protected

◆ NO_ASSIGNED_TASK

const string SCR_UITaskManagerComponent.NO_ASSIGNED_TASK = "#AR-Tasks_NoAssignedTaskTitle"
staticprotected

◆ s_Instance

SCR_UITaskManagerComponent SCR_UITaskManagerComponent.s_Instance
static

◆ s_OnTaskListVisible

const ref ScriptInvoker SCR_UITaskManagerComponent.s_OnTaskListVisible = new ScriptInvoker()
static

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