Arma Reforger Script API
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
SCR_LoadoutRequestUIComponent Interface Reference

Component responsible for requesting and visualization of available loadouts in deploy menu. More...

Inheritance diagram for SCR_LoadoutRequestUIComponent:
[legend]

Public Member Functions

override void HandlerAttached (Widget w)
 
override void HandlerDeattached (Widget w)
 
override void SetExpanded (bool expanded)
 
void OnPlayerLoadoutAssigned (SCR_PlayerLoadoutComponent component)
 Called from deploy menu when player's loadout is assigned.
 
void ShowAvailableLoadouts (Faction faction)
 Show available loadouts in the loadout selector.
 
void ShowPlayerLoadouts (array< int > playerIds, int slotCount=-1)
 Fill the loadout list with players' loadouts.
 
ScriptInvokerInt GetOnPlayerEntryFocused ()
 
ScriptInvokerWidget GetOnPlayerEntryFocusLost ()
 
void RequestRandomLoadout (Faction faction)
 Send a request to assign a random faction loadout.
 
void SetSelected (SCR_PlayerLoadoutComponent component)
 
void RegisterOnSpawnPointInvoker (notnull OnSpawnPointRplIdSetInvoker invoker)
 
void RefreshLoadoutPreview ()
 Refreshes current loadout preview widget.
 
SCR_BasePlayerLoadout GetPlayerLoadout ()
 Get local player's assigned loadout.
 
void SetListVisible (bool visible)
 
void ShowLoadoutSelector (bool show)
 
SCR_EditableEntityUIInfo GetUIInfo (SCR_BasePlayerLoadout loadout)
 
override void SetListWidget (Widget list)
 Marks which widget should be used as a root for creating buttons.
 
bool IsSelectorFocused ()
 
- Public Member Functions inherited from SCR_DeployRequestUIBaseComponent
override void HandlerAttached (Widget w)
 
void Update (float dt)
 
void Unlock ()
 Unlock this component's buttons.
 
bool IsEnabled ()
 
SCR_DeployButtonBase GetFirstValidButton ()
 Gets first available button from the m_aButtons list.
 
void SetExpanded (bool expanded)
 
bool IsExpanded ()
 
void SetListWidget (Widget list)
 Marks which widget should be used as a root for creating buttons.
 
Widget GetListWidget ()
 Gets current list widget.
 
ScriptInvoker GetOnButtonFocused ()
 
ScriptInvoker GetOnMouseLeft ()
 

Protected Member Functions

override void ToggleCollapsed ()
 
override bool IsExpanded ()
 
void OnLoadoutsChanged (SCR_BasePlayerLoadout loadout, int newCount)
 
void ClearLoadoutList ()
 Removed all buttons from the loadout list.
 
void CreatePlayerLoadoutButton (SCR_BasePlayerLoadout loadout, int pid, int order)
 
void CreateEmptySlot (int order)
 Create an empty slot in the loadout grid.
 
void UpdateLoadouts (int playerID, bool hasValidLoadout)
 
void RequestPlayerLoadout (SCR_LoadoutButton loadoutBtn)
 Send a loadout request when clicking on a loadout button.
 
void OnButtonFocused (Widget w)
 
void OnButtonFocusLost (Widget w)
 
void OnSpawnPointChanged (RplId id)
 
void OnLoadoutSpawnCostMultiplierChanged (float newMultiplier)
 
float GetLoadoutCost ()
 
void SetLoadoutPreview (SCR_BasePlayerLoadout loadout)
 Set a loadout shown in the preview widget.
 
void AddLoadout (SCR_BasePlayerLoadout loadout)
 Add a loadout into the loadout selector.
 
void ResetPlayerLoadoutPreview ()
 
- Protected Member Functions inherited from SCR_DeployRequestUIBaseComponent
void Lock (SCR_DeployButtonBase btn)
 Lock this component's buttons from processing any further requests. Unlock() should be called once you receive a response.
 
void ToggleCollapsed ()
 
void OnListExpand (SCR_DeployRequestUIBaseComponent component, bool expanded)
 
void OnMouseLeft ()
 

Protected Attributes

string m_sLoadoutList
 
GridLayoutWidget m_wLoadoutList
 
string m_sLoadoutPreview
 
Widget m_wLoadoutPreview
 
string m_sLoadoutIcon
 
ImageWidget m_wLoadoutIcon
 
string m_sLoadoutName
 
TextWidget m_wLoadoutName
 
string m_sDTDawn
 
string m_sDTForenoon
 
string m_sDTAfternoon
 
string m_sDTDusk
 
string m_sDTEvening
 
string m_sDTNight
 
ref array< string > m_sDayModifierStrings = { m_sDTDawn, m_sDTForenoon, m_sDTAfternoon, m_sDTDusk, m_sDTEvening, m_sDTNight }
 
ResourceName m_sLoadoutButton
 
string m_sLoadoutSelector
 
Widget m_wLoadoutSelector
 
string m_sRoot
 
SCR_LoadoutGallery m_LoadoutSelector
 
SCR_LoadoutManager m_LoadoutManager
 
SCR_PlayerLoadoutComponent m_PlyLoadoutComp
 
SCR_LoadoutPreviewComponent m_PreviewComp
 
SCR_ArsenalManagerComponent m_ArsenalManagerComp
 
SCR_PlayerFactionAffiliationComponent m_PlyFactionAffilComp
 
IEntity m_PreviewedEntity
 
Widget m_wLoadouty
 
Widget m_wSupplies
 
ResourceName m_sLoadoutImageSet
 
RichTextWidget m_wSuppliesText
 
ref ScriptInvokerInt m_OnPlayerEntryFocused
 
ref ScriptInvokerWidget m_OnPlayerEntryFocusLost
 
SCR_UIInfo uiInfo
 
string m_sLoadoutImageName
 
string m_sDayModifier
 
string m_sWeatherModifier
 
- Protected Attributes inherited from SCR_DeployRequestUIBaseComponent
string m_sExpandButton
 
Widget m_wExpandButton
 
string m_sExpandButtonName
 
TextWidget m_wExpandButtonName
 
string m_sExpandButtonIcon
 
ImageWidget m_wExpandButtonIcon
 
bool m_bUseListFromButton
 
bool m_bEnabled = true
 
bool m_bLocked = false
 
ref array< SCR_DeployButtonBasem_aButtons = {}
 
Widget m_wRoot
 
ref ScriptInvoker m_OnButtonFocused = new ScriptInvoker()
 
ref ScriptInvoker m_OnMouseLeft = new ScriptInvoker()
 

Static Protected Attributes

const int LOADOUTS_PER_ROW = 2
 
- Static Protected Attributes inherited from SCR_DeployRequestUIBaseComponent
static ref ScriptInvoker< SCR_DeployRequestUIBaseComponent, bool > s_OnListExpand
 

Additional Inherited Members

- Static Public Member Functions inherited from SCR_DeployRequestUIBaseComponent
static ScriptInvoker GetOnListCollapse ()
 

Detailed Description

Component responsible for requesting and visualization of available loadouts in deploy menu.

Returns

Member Function Documentation

◆ AddLoadout()

void SCR_LoadoutRequestUIComponent.AddLoadout ( SCR_BasePlayerLoadout  loadout)
protected

Add a loadout into the loadout selector.

◆ ClearLoadoutList()

void SCR_LoadoutRequestUIComponent.ClearLoadoutList ( )
protected

Removed all buttons from the loadout list.

◆ CreateEmptySlot()

void SCR_LoadoutRequestUIComponent.CreateEmptySlot ( int  order)
protected

Create an empty slot in the loadout grid.

◆ CreatePlayerLoadoutButton()

void SCR_LoadoutRequestUIComponent.CreatePlayerLoadoutButton ( SCR_BasePlayerLoadout  loadout,
int  pid,
int  order 
)
protected

◆ GetLoadoutCost()

float SCR_LoadoutRequestUIComponent.GetLoadoutCost ( )
protected

◆ GetOnPlayerEntryFocused()

ScriptInvokerInt SCR_LoadoutRequestUIComponent.GetOnPlayerEntryFocused ( )

◆ GetOnPlayerEntryFocusLost()

ScriptInvokerWidget SCR_LoadoutRequestUIComponent.GetOnPlayerEntryFocusLost ( )

◆ GetPlayerLoadout()

SCR_BasePlayerLoadout SCR_LoadoutRequestUIComponent.GetPlayerLoadout ( )

Get local player's assigned loadout.

◆ GetUIInfo()

SCR_EditableEntityUIInfo SCR_LoadoutRequestUIComponent.GetUIInfo ( SCR_BasePlayerLoadout  loadout)

◆ HandlerAttached()

override void SCR_LoadoutRequestUIComponent.HandlerAttached ( Widget  w)

◆ HandlerDeattached()

override void SCR_LoadoutRequestUIComponent.HandlerDeattached ( Widget  w)

◆ IsExpanded()

override bool SCR_LoadoutRequestUIComponent.IsExpanded ( )
protected

◆ IsSelectorFocused()

bool SCR_LoadoutRequestUIComponent.IsSelectorFocused ( )

◆ OnButtonFocused()

void SCR_LoadoutRequestUIComponent.OnButtonFocused ( Widget  w)
protected

◆ OnButtonFocusLost()

void SCR_LoadoutRequestUIComponent.OnButtonFocusLost ( Widget  w)
protected

◆ OnLoadoutsChanged()

void SCR_LoadoutRequestUIComponent.OnLoadoutsChanged ( SCR_BasePlayerLoadout  loadout,
int  newCount 
)
protected

◆ OnLoadoutSpawnCostMultiplierChanged()

void SCR_LoadoutRequestUIComponent.OnLoadoutSpawnCostMultiplierChanged ( float  newMultiplier)
protected

◆ OnPlayerLoadoutAssigned()

void SCR_LoadoutRequestUIComponent.OnPlayerLoadoutAssigned ( SCR_PlayerLoadoutComponent  component)

Called from deploy menu when player's loadout is assigned.

◆ OnSpawnPointChanged()

void SCR_LoadoutRequestUIComponent.OnSpawnPointChanged ( RplId  id)
protected

◆ RefreshLoadoutPreview()

void SCR_LoadoutRequestUIComponent.RefreshLoadoutPreview ( )

Refreshes current loadout preview widget.

◆ RegisterOnSpawnPointInvoker()

void SCR_LoadoutRequestUIComponent.RegisterOnSpawnPointInvoker ( notnull OnSpawnPointRplIdSetInvoker  invoker)

◆ RequestPlayerLoadout()

void SCR_LoadoutRequestUIComponent.RequestPlayerLoadout ( SCR_LoadoutButton  loadoutBtn)
protected

Send a loadout request when clicking on a loadout button.

◆ RequestRandomLoadout()

void SCR_LoadoutRequestUIComponent.RequestRandomLoadout ( Faction  faction)

Send a request to assign a random faction loadout.

◆ ResetPlayerLoadoutPreview()

void SCR_LoadoutRequestUIComponent.ResetPlayerLoadoutPreview ( )
protected

◆ SetExpanded()

override void SCR_LoadoutRequestUIComponent.SetExpanded ( bool  expanded)

◆ SetListVisible()

void SCR_LoadoutRequestUIComponent.SetListVisible ( bool  visible)

◆ SetListWidget()

override void SCR_LoadoutRequestUIComponent.SetListWidget ( Widget  list)

Marks which widget should be used as a root for creating buttons.

Implements SCR_DeployRequestUIBaseComponent.

◆ SetLoadoutPreview()

void SCR_LoadoutRequestUIComponent.SetLoadoutPreview ( SCR_BasePlayerLoadout  loadout)
protected

Set a loadout shown in the preview widget.

◆ SetSelected()

void SCR_LoadoutRequestUIComponent.SetSelected ( SCR_PlayerLoadoutComponent  component)

◆ ShowAvailableLoadouts()

void SCR_LoadoutRequestUIComponent.ShowAvailableLoadouts ( Faction  faction)

Show available loadouts in the loadout selector.

◆ ShowLoadoutSelector()

void SCR_LoadoutRequestUIComponent.ShowLoadoutSelector ( bool  show)

◆ ShowPlayerLoadouts()

void SCR_LoadoutRequestUIComponent.ShowPlayerLoadouts ( array< int >  playerIds,
int  slotCount = -1 
)

Fill the loadout list with players' loadouts.

◆ ToggleCollapsed()

override void SCR_LoadoutRequestUIComponent.ToggleCollapsed ( )
protected

◆ UpdateLoadouts()

void SCR_LoadoutRequestUIComponent.UpdateLoadouts ( int  playerID,
bool  hasValidLoadout 
)
protected

Member Data Documentation

◆ LOADOUTS_PER_ROW

const int SCR_LoadoutRequestUIComponent.LOADOUTS_PER_ROW = 2
staticprotected

◆ m_ArsenalManagerComp

SCR_ArsenalManagerComponent SCR_LoadoutRequestUIComponent.m_ArsenalManagerComp
protected

◆ m_LoadoutManager

SCR_LoadoutManager SCR_LoadoutRequestUIComponent.m_LoadoutManager
protected

◆ m_LoadoutSelector

SCR_LoadoutGallery SCR_LoadoutRequestUIComponent.m_LoadoutSelector
protected

◆ m_OnPlayerEntryFocused

ref ScriptInvokerInt SCR_LoadoutRequestUIComponent.m_OnPlayerEntryFocused
protected

◆ m_OnPlayerEntryFocusLost

ref ScriptInvokerWidget SCR_LoadoutRequestUIComponent.m_OnPlayerEntryFocusLost
protected

◆ m_PlyFactionAffilComp

SCR_PlayerFactionAffiliationComponent SCR_LoadoutRequestUIComponent.m_PlyFactionAffilComp
protected

◆ m_PlyLoadoutComp

SCR_PlayerLoadoutComponent SCR_LoadoutRequestUIComponent.m_PlyLoadoutComp
protected

◆ m_PreviewComp

SCR_LoadoutPreviewComponent SCR_LoadoutRequestUIComponent.m_PreviewComp
protected

◆ m_PreviewedEntity

IEntity SCR_LoadoutRequestUIComponent.m_PreviewedEntity
protected

◆ m_sDayModifier

string SCR_LoadoutRequestUIComponent.m_sDayModifier
protected

◆ m_sDayModifierStrings

ref array<string> SCR_LoadoutRequestUIComponent.m_sDayModifierStrings = { m_sDTDawn, m_sDTForenoon, m_sDTAfternoon, m_sDTDusk, m_sDTEvening, m_sDTNight }
protected

◆ m_sDTAfternoon

string SCR_LoadoutRequestUIComponent.m_sDTAfternoon
protected

◆ m_sDTDawn

string SCR_LoadoutRequestUIComponent.m_sDTDawn
protected

◆ m_sDTDusk

string SCR_LoadoutRequestUIComponent.m_sDTDusk
protected

◆ m_sDTEvening

string SCR_LoadoutRequestUIComponent.m_sDTEvening
protected

◆ m_sDTForenoon

string SCR_LoadoutRequestUIComponent.m_sDTForenoon
protected

◆ m_sDTNight

string SCR_LoadoutRequestUIComponent.m_sDTNight
protected

◆ m_sLoadoutButton

ResourceName SCR_LoadoutRequestUIComponent.m_sLoadoutButton
protected

◆ m_sLoadoutIcon

string SCR_LoadoutRequestUIComponent.m_sLoadoutIcon
protected

◆ m_sLoadoutImageName

string SCR_LoadoutRequestUIComponent.m_sLoadoutImageName
protected

◆ m_sLoadoutImageSet

ResourceName SCR_LoadoutRequestUIComponent.m_sLoadoutImageSet
protected

◆ m_sLoadoutList

string SCR_LoadoutRequestUIComponent.m_sLoadoutList
protected

◆ m_sLoadoutName

string SCR_LoadoutRequestUIComponent.m_sLoadoutName
protected

◆ m_sLoadoutPreview

string SCR_LoadoutRequestUIComponent.m_sLoadoutPreview
protected

◆ m_sLoadoutSelector

string SCR_LoadoutRequestUIComponent.m_sLoadoutSelector
protected

◆ m_sRoot

string SCR_LoadoutRequestUIComponent.m_sRoot
protected

◆ m_sWeatherModifier

string SCR_LoadoutRequestUIComponent.m_sWeatherModifier
protected

◆ m_wLoadoutIcon

ImageWidget SCR_LoadoutRequestUIComponent.m_wLoadoutIcon
protected

◆ m_wLoadoutList

GridLayoutWidget SCR_LoadoutRequestUIComponent.m_wLoadoutList
protected

◆ m_wLoadoutName

TextWidget SCR_LoadoutRequestUIComponent.m_wLoadoutName
protected

◆ m_wLoadoutPreview

Widget SCR_LoadoutRequestUIComponent.m_wLoadoutPreview
protected

◆ m_wLoadoutSelector

Widget SCR_LoadoutRequestUIComponent.m_wLoadoutSelector
protected

◆ m_wLoadouty

Widget SCR_LoadoutRequestUIComponent.m_wLoadouty
protected

◆ m_wSupplies

Widget SCR_LoadoutRequestUIComponent.m_wSupplies
protected

◆ m_wSuppliesText

RichTextWidget SCR_LoadoutRequestUIComponent.m_wSuppliesText
protected

◆ uiInfo

SCR_UIInfo SCR_LoadoutRequestUIComponent.uiInfo
protected

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