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

Public Member Functions

override void OnMenuOpen ()
 
override void OnMenuClose ()
 
override void OnMenuShow ()
 
override void OnMenuFocusGained ()
 
- Public Member Functions inherited from MenuRootBase
ScriptInvoker GetOnMenuFocusGained ()
 
ScriptInvoker GetOnMenuFocusLost ()
 
ScriptInvoker GetOnMenuShow ()
 
ScriptInvoker GetOnMenuHide ()
 
ScriptInvoker GetOnMenuItem ()
 
ScriptInvoker GetOnMenuUpdate ()
 
ScriptInvoker GetOnMenuOpen ()
 
ScriptInvoker GetOnMenuInit ()
 
ScriptInvoker GetOnMenuClose ()
 
void OnMenuClosed ()
 
void InitChat ()
 
void ShowChat ()
 
MenuRootComponent GetRootComponent ()
 
SCR_DynamicFooterComponent GetFooterComponent ()
 
override void OnMenuFocusGained ()
 
override void OnMenuFocusLost ()
 
override void OnMenuShow ()
 
override void OnMenuHide ()
 
override void OnMenuItem (string menuItemName, bool changed, bool finished)
 
override void OnMenuUpdate (float tDelta)
 
override void OnMenuOpen ()
 
override void OnMenuInit ()
 
override void OnMenuClose ()
 
- Public Member Functions inherited from ChimeraMenuBase
override void OnMenuInit ()
 
override void OnMenuUpdate (float tDelta)
 
override void OnMenuOpen ()
 
override void OnMenuOpened ()
 
override void OnMenuClose ()
 
override void OnMenuFocusGained ()
 
override void OnMenuFocusLost ()
 
override void OnMenuShow ()
 
override void OnMenuHide ()
 

Static Public Attributes

const string TYPE_FEATURED = "m_aFeaturedScenarios"
 
const string TYPE_RECOMMENDED = "m_aRecommendedScenarios"
 
const int THRESHOLD_RECENTLY_PLAYED = 3600 * 24 * 30
 

Protected Member Functions

void SetupSectionTiles (SCR_PlayMenuComponent section, array< ref SCR_PlayMenuEntry > entries)
 
void CreateMenuEntries (out array< ref SCR_PlayMenuEntry > entries, array< MissionWorkshopItem > scenarios, EPlayMenuContentType type)
 
void GetScenarios (out array< MissionWorkshopItem > scenarios, EPlayMenuContentType type)
 
void GetRecentScenarios (out array< MissionWorkshopItem > scenarios)
 
void OnActionTriggered (string action, float multiplier)
 Input Events.
 
void OnInteractionButtonPressed (string action)
 
void OnConfirmationDialogButtonPressed (SCR_ScenarioConfirmationDialogUi dialog, string tag)
 
void SwitchOnButton (string tag, MissionWorkshopItem scenario)
 
void OnTileClickInteraction (float multiplier)
 
void OnClickInteraction (MissionWorkshopItem scenario)
 
void OnDoubleClickInteraction (MissionWorkshopItem scenario)
 
void OnTileMouseClick (SCR_ScriptedWidgetComponent tile)
 
void OnPlayInteraction (MissionWorkshopItem scenario)
 
void OnBack ()
 
void OnScenarios ()
 
void Play (MissionWorkshopItem scenario)
 
void Continue (MissionWorkshopItem scenario)
 
void Restart (MissionWorkshopItem scenario)
 
void OnRestartConfirmed ()
 
void Host (MissionWorkshopItem scenario)
 
void Join (MissionWorkshopItem scenario)
 
void OnTileFocused (SCR_PlayMenuTileComponent tile)
 
void OnTileFocusLost (SCR_PlayMenuTileComponent tile)
 
void UpdateNavigationButtons (bool show=true)
 
void PlayCurrentScenario ()
 
void FindCurrentScenarioServers ()
 
void HostCurrentScenario ()
 
void OnPlayTutorial ()
 
SCR_PlayMenuTileComponent GetSelectedTile ()
 
SCR_PlayMenuTileComponent GetTileUnderCursor ()
 
MissionWorkshopItem GetSelectedScenario ()
 
void OnCommStatusCheckFinished (SCR_ECommStatus status, float responseTime, float lastSuccessTime, float lastFailTime)
 

Protected Attributes

ResourceName m_sConfig = "{6409EA8EA4BFF7E6}Configs/PlayMenu/PlayMenuEntries.conf"
 
ref Resource m_Config
 
BaseContainer m_ConfigEntries
 
SCR_PlayMenuComponent m_Featured
 
SCR_PlayMenuComponent m_Recommended
 
SCR_PlayMenuComponent m_Recent
 
ref array< MissionWorkshopItem > m_aScenariosFeatured = {}
 
ref array< MissionWorkshopItem > m_aScenariosRecommended = {}
 
ref array< MissionWorkshopItem > m_aScenariosRecent = {}
 
ref array< ref SCR_PlayMenuEntrym_aEntriesFeatured = {}
 
ref array< ref SCR_PlayMenuEntrym_aEntriesRecommended = {}
 
ref array< ref SCR_PlayMenuEntrym_aEntriesRecent = {}
 
ref MissionWorkshopItem m_ItemTutorial
 
WorkshopApi m_WorkshopAPI
 
SCR_PlayMenuTileComponent m_CurrentTile
 
Widget m_wRoot
 
bool m_bTutorialPlayed
 
bool m_bShowPlayTutorialDialog
 
int m_iPlayTutorialShowCount
 
int m_iPlayTutorialShowMax
 
ref array< SCR_InputButtonComponentm_aRightFooterButtons = {}
 
SCR_PlayMenuTileComponent m_ClickedTile
 
MissionWorkshopItem m_SelectedScenario
 
SCR_MenuActionsComponent m_ActionsComponent
 
- Protected Attributes inherited from MenuRootBase
MenuRootComponent m_MenuRootComponent
 
ref ScriptInvoker m_EventOnMenuFocusGained
 
ref ScriptInvoker m_EventOnMenuFocusLost
 
ref ScriptInvoker m_EventOnMenuShow
 
ref ScriptInvoker m_EventOnMenuHide
 
ref ScriptInvoker m_EventOnMenuItem
 
ref ScriptInvoker m_EventOnMenuUpdate
 
ref ScriptInvoker m_EventOnMenuOpen
 
ref ScriptInvoker m_EventOnMenuInit
 
ref ScriptInvoker m_EventOnMenuClose
 
SCR_ChatPanel m_ChatPanel
 
SCR_DynamicFooterComponent m_DynamicFooter
 
- Protected Attributes inherited from ChimeraMenuBase
bool m_bTextEditActive = false
 

Additional Inherited Members

- Static Public Member Functions inherited from ChimeraMenuBase
static ChimeraMenuBase CurrentChimeraMenu ()
 
static ChimeraMenuBase GetOwnerMenu (Widget w)
 Returns parent menu of a widget.
 
- Public Attributes inherited from ChimeraMenuBase
ref ScriptInvoker m_OnTextEditContextChange = new ScriptInvoker
 
ref ScriptInvoker m_OnUpdate = new ScriptInvoker
 
- Static Protected Attributes inherited from ChimeraMenuBase
const string INPUT_CONTEXT_EDIT = "MenuTextEditContext"
 
static ChimeraMenuBase m_ThisMenu
 

Member Function Documentation

◆ Continue()

void SCR_PlayMenu.Continue ( MissionWorkshopItem  scenario)
protected

◆ CreateMenuEntries()

void SCR_PlayMenu.CreateMenuEntries ( out array< ref SCR_PlayMenuEntry entries,
array< MissionWorkshopItem >  scenarios,
EPlayMenuContentType  type 
)
protected

◆ FindCurrentScenarioServers()

void SCR_PlayMenu.FindCurrentScenarioServers ( )
protected

◆ GetRecentScenarios()

void SCR_PlayMenu.GetRecentScenarios ( out array< MissionWorkshopItem >  scenarios)
protected

◆ GetScenarios()

void SCR_PlayMenu.GetScenarios ( out array< MissionWorkshopItem >  scenarios,
EPlayMenuContentType  type 
)
protected

◆ GetSelectedScenario()

MissionWorkshopItem SCR_PlayMenu.GetSelectedScenario ( )
protected

◆ GetSelectedTile()

SCR_PlayMenuTileComponent SCR_PlayMenu.GetSelectedTile ( )
protected

◆ GetTileUnderCursor()

SCR_PlayMenuTileComponent SCR_PlayMenu.GetTileUnderCursor ( )
protected

◆ Host()

void SCR_PlayMenu.Host ( MissionWorkshopItem  scenario)
protected

◆ HostCurrentScenario()

void SCR_PlayMenu.HostCurrentScenario ( )
protected

◆ Join()

void SCR_PlayMenu.Join ( MissionWorkshopItem  scenario)
protected

◆ OnActionTriggered()

void SCR_PlayMenu.OnActionTriggered ( string  action,
float  multiplier 
)
protected

Input Events.

TODO: set which input modes should trigger the actions in the component itself

◆ OnBack()

void SCR_PlayMenu.OnBack ( )
protected

◆ OnClickInteraction()

void SCR_PlayMenu.OnClickInteraction ( MissionWorkshopItem  scenario)
protected

Confirmation Dialog

Bind dialog delegates

◆ OnCommStatusCheckFinished()

void SCR_PlayMenu.OnCommStatusCheckFinished ( SCR_ECommStatus  status,
float  responseTime,
float  lastSuccessTime,
float  lastFailTime 
)
protected

◆ OnConfirmationDialogButtonPressed()

void SCR_PlayMenu.OnConfirmationDialogButtonPressed ( SCR_ScenarioConfirmationDialogUi  dialog,
string  tag 
)
protected

◆ OnDoubleClickInteraction()

void SCR_PlayMenu.OnDoubleClickInteraction ( MissionWorkshopItem  scenario)
protected

◆ OnInteractionButtonPressed()

void SCR_PlayMenu.OnInteractionButtonPressed ( string  action)
protected

◆ OnMenuClose()

override void SCR_PlayMenu.OnMenuClose ( )

Implements MenuRootBase.

◆ OnMenuFocusGained()

override void SCR_PlayMenu.OnMenuFocusGained ( )

Implements MenuRootBase.

◆ OnMenuOpen()

override void SCR_PlayMenu.OnMenuOpen ( )

Inputs Buttons

Listeners

Implements MenuRootBase.

◆ OnMenuShow()

override void SCR_PlayMenu.OnMenuShow ( )

Implements MenuRootBase.

◆ OnPlayInteraction()

void SCR_PlayMenu.OnPlayInteraction ( MissionWorkshopItem  scenario)
protected

◆ OnPlayTutorial()

void SCR_PlayMenu.OnPlayTutorial ( )
protected

◆ OnRestartConfirmed()

void SCR_PlayMenu.OnRestartConfirmed ( )
protected

◆ OnScenarios()

void SCR_PlayMenu.OnScenarios ( )
protected

◆ OnTileClickInteraction()

void SCR_PlayMenu.OnTileClickInteraction ( float  multiplier)
protected

multiplier value in the action is used to differentiate between single and double click

◆ OnTileFocused()

void SCR_PlayMenu.OnTileFocused ( SCR_PlayMenuTileComponent  tile)
protected

◆ OnTileFocusLost()

void SCR_PlayMenu.OnTileFocusLost ( SCR_PlayMenuTileComponent  tile)
protected

◆ OnTileMouseClick()

void SCR_PlayMenu.OnTileMouseClick ( SCR_ScriptedWidgetComponent  tile)
protected

◆ Play()

void SCR_PlayMenu.Play ( MissionWorkshopItem  scenario)
protected

◆ PlayCurrentScenario()

void SCR_PlayMenu.PlayCurrentScenario ( )
protected

◆ Restart()

void SCR_PlayMenu.Restart ( MissionWorkshopItem  scenario)
protected

◆ SetupSectionTiles()

void SCR_PlayMenu.SetupSectionTiles ( SCR_PlayMenuComponent  section,
array< ref SCR_PlayMenuEntry entries 
)
protected

◆ SwitchOnButton()

void SCR_PlayMenu.SwitchOnButton ( string  tag,
MissionWorkshopItem  scenario 
)
protected

◆ UpdateNavigationButtons()

void SCR_PlayMenu.UpdateNavigationButtons ( bool  show = true)
protected

Member Data Documentation

◆ m_ActionsComponent

SCR_MenuActionsComponent SCR_PlayMenu.m_ActionsComponent
protected

◆ m_aEntriesFeatured

ref array<ref SCR_PlayMenuEntry> SCR_PlayMenu.m_aEntriesFeatured = {}
protected

◆ m_aEntriesRecent

ref array<ref SCR_PlayMenuEntry> SCR_PlayMenu.m_aEntriesRecent = {}
protected

◆ m_aEntriesRecommended

ref array<ref SCR_PlayMenuEntry> SCR_PlayMenu.m_aEntriesRecommended = {}
protected

◆ m_aRightFooterButtons

ref array<SCR_InputButtonComponent> SCR_PlayMenu.m_aRightFooterButtons = {}
protected

◆ m_aScenariosFeatured

ref array<MissionWorkshopItem> SCR_PlayMenu.m_aScenariosFeatured = {}
protected

◆ m_aScenariosRecent

ref array<MissionWorkshopItem> SCR_PlayMenu.m_aScenariosRecent = {}
protected

◆ m_aScenariosRecommended

ref array<MissionWorkshopItem> SCR_PlayMenu.m_aScenariosRecommended = {}
protected

◆ m_bShowPlayTutorialDialog

bool SCR_PlayMenu.m_bShowPlayTutorialDialog
protected

◆ m_bTutorialPlayed

bool SCR_PlayMenu.m_bTutorialPlayed
protected

◆ m_ClickedTile

SCR_PlayMenuTileComponent SCR_PlayMenu.m_ClickedTile
protected

◆ m_Config

ref Resource SCR_PlayMenu.m_Config
protected

◆ m_ConfigEntries

BaseContainer SCR_PlayMenu.m_ConfigEntries
protected

◆ m_CurrentTile

SCR_PlayMenuTileComponent SCR_PlayMenu.m_CurrentTile
protected

◆ m_Featured

SCR_PlayMenuComponent SCR_PlayMenu.m_Featured
protected

◆ m_iPlayTutorialShowCount

int SCR_PlayMenu.m_iPlayTutorialShowCount
protected

◆ m_iPlayTutorialShowMax

int SCR_PlayMenu.m_iPlayTutorialShowMax
protected

◆ m_ItemTutorial

ref MissionWorkshopItem SCR_PlayMenu.m_ItemTutorial
protected

◆ m_Recent

SCR_PlayMenuComponent SCR_PlayMenu.m_Recent
protected

◆ m_Recommended

SCR_PlayMenuComponent SCR_PlayMenu.m_Recommended
protected

◆ m_sConfig

ResourceName SCR_PlayMenu.m_sConfig = "{6409EA8EA4BFF7E6}Configs/PlayMenu/PlayMenuEntries.conf"
protected

◆ m_SelectedScenario

MissionWorkshopItem SCR_PlayMenu.m_SelectedScenario
protected

◆ m_WorkshopAPI

WorkshopApi SCR_PlayMenu.m_WorkshopAPI
protected

◆ m_wRoot

Widget SCR_PlayMenu.m_wRoot
protected

◆ THRESHOLD_RECENTLY_PLAYED

const int SCR_PlayMenu.THRESHOLD_RECENTLY_PLAYED = 3600 * 24 * 30
static

◆ TYPE_FEATURED

const string SCR_PlayMenu.TYPE_FEATURED = "m_aFeaturedScenarios"
static

◆ TYPE_RECOMMENDED

const string SCR_PlayMenu.TYPE_RECOMMENDED = "m_aRecommendedScenarios"
static

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