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

Public Member Functions

override void OnMenuOpen (SCR_ConfigurableDialogUiPreset preset)
 Called last of all, after all the initialization of main element done.
 
override void OnMenuClose ()
 
override void OnConfirm ()
 
override void OnCancel ()
 
void Init (Room room, SCR_EJoinFailUI mode, MissionWorkshopItem scenario, ScriptInvokerVoid onFavoritesResponse=null)
 
void UpdateInfo ()
 
void SetScenarioImage (MissionWorkshopItem scenario)
 
ScriptInvokerRoom GetOnRetryFullServerJoin ()
 
ScriptInvokerRoom GetOnLeaveQueueRequest ()
 
ScriptInvokerVoid GetOnFavorite ()
 
- Public Member Functions inherited from SCR_ConfigurableDialogUi
Widget GetRootWidget ()
 
OverlayWidget GetDialogBaseOverlay ()
 Returns the base dialog overlay (the rectangle covered by the background). Useful for dialog wide darkening (e.g. by SCR_LoadingOverlay)
 
Widget GetContentLayoutRoot ()
 Returns the root of the content layout.
 
SCR_ConfigurableDialogUiPreset GetDialogPreset ()
 
void Close ()
 
void SetTitle (string text)
 
void SetMessage (string text)
 
void SetMessageColor (Color color)
 
TextWidget GetMessageWidget ()
 
string GetMessageStr ()
 
void SetTitleIcon (ResourceName image, string imageName)
 Set title icons with custom image.
 
void SetIconColor (Color color)
 Set title icons with custom image.
 
void SetStyle (EConfigurableDialogStyle type)
 Sets colors based on style.
 
void BindButtonConfirm (SCR_InputButtonComponent button)
 Allows to register a custom button to call OnConfirm (i.e. one not in the conf files but placed by hand in the layout)
 
void BindButtonCancel (SCR_InputButtonComponent button)
 Allows to register a custom button to call OnCancel (i.e. one not in the conf files but placed by hand in the layout)
 
void BindButtonGeneric (SCR_InputButtonComponent button, string tag=string.Empty)
 Allows to register a custom button to call OnButtonPressed (i.e. one not in the conf files but placed by hand in the layout). An empty tag will result in the widget's name being used instead.
 
SCR_InputButtonComponent FindButton (string tag)
 Returns a button with given tag.
 
string GetButtonTag (SCR_InputButtonComponent button)
 Returns a button's tag.
 
void OnMenuUpdate (float tDelta)
 
void OnMenuFocusGained ()
 
void OnMenuFocusLost ()
 
void OnMenuShow ()
 
void OnMenuHide ()
 
void OnMenuClose ()
 

Protected Member Functions

void OnFavorite ()
 
void OnFieldManual ()
 
void DisplayFavoriteAction (bool isFavorite)
 
void OnRoomSetFavoriteResponseDialog ()
 
void OnCopyIPAddress ()
 
void SetIPAddressText (string text)
 
void SetDiscordText (string text)
 
void UpdateDetailIcons ()
 
void SetFavoritesButtonsEnabled (bool enabled)
 
void UpdateInfo_Enqueued ()
 
void UpdateInfo_QueueFull ()
 
void UpdateInfo_QueueDisabled ()
 
void UpdateEnqueuedTimeDisplay ()
 
- Protected Member Functions inherited from SCR_ConfigurableDialogUi
void OnConfirm ()
 
void OnCancel ()
 
void OnButtonPressed (SCR_InputButtonComponent button)
 
void OnMenuOpen (SCR_ConfigurableDialogUiPreset preset)
 Called last of all, after all the initialization of main element done.
 
void Init (Widget root, SCR_ConfigurableDialogUiPreset preset, MenuBase proxyMenu)
 
void InitWidgets ()
 
SCR_InputButtonComponent CreateButton (SCR_ConfigurableDialogUiButtonPreset buttonPreset)
 
void Internal_Close ()
 
void InitAttributedVariables ()
 Verifies that all attributed variables are set up.
 

Protected Attributes

ref SCR_ServerFullDialogContentWidgets m_Widgets = new SCR_ServerFullDialogContentWidgets()
 
SCR_InputButtonComponent m_NavConfirm
 
SCR_InputButtonComponent m_NavCancel
 
SCR_InputButtonComponent m_NavFavorites
 
SCR_InputButtonComponent m_NavFieldManual
 
SCR_ModularButtonComponent m_BtnFavorites
 
SCR_ScenarioBackendImageComponent m_BackendImageComp
 
Widget m_wSideSpinner
 
Room m_Room
 
SCR_EJoinFailUI m_eMode
 
ref ScriptInvokerRoom m_OnRetryFullServerJoin
 
ref ScriptInvokerRoom m_OnLeaveQueueRequest
 
ref ScriptInvokerVoid m_OnFavorite
 
- Protected Attributes inherited from SCR_ConfigurableDialogUi
float m_fFadeInTime
 
ResourceName m_sNavigationButtonLayout
 
string m_sWidgetNameButtonsLeft
 
string m_sWidgetNameButtonsRight
 
string m_sWidgetNameButtonsCenter
 
ImageWidget m_wImgTopLine
 
ImageWidget m_wImgTitleIcon
 
TextWidget m_wTitle
 
TextWidget m_wMessage
 
VerticalLayoutWidget m_wContentVerticalLayout
 
ref map< string, SCR_InputButtonComponent > m_aButtonComponents = new map<string, SCR_InputButtonComponent>
 
Widget m_wRoot
 
OverlayWidget m_wDialogBase
 
SCR_DynamicFooterComponent m_DynamicFooter
 
MenuBase m_ProxyMenu
 
ref SCR_ConfigurableDialogUiPreset m_DialogPreset
 
string m_sLastPressedButtonTag
 
bool m_bIsClosing
 

Static Protected Attributes

const string WIDGET_BACKGROUND_IMAGE = "BackgroundImageBackend"
 
const string WIDGET_SIDE_SPINNER = "SideSpinner"
 
const string INPUT_BUTTON_FIELD_MANUAL = "FieldManual"
 
const string INPUT_BUTTON_FAVORITES = "Favorites"
 
const string MOUSE_BUTTON_FAVORITES = "FavoriteButton"
 
const int ENQUEUED_TIME_UPDATE_FREQUENCY = 1000
 
const string MESSAGE_SERVER_FULL = "#AR-ServerBrowser_FullServer"
 
const string MESSAGE_SERVER_POPULATION = "#AR-Scenario_Players"
 
const string MESSAGE_QUEUE_FULL = "#AR-ServerQueue_QueueFull_Header"
 
const string MESSAGE_QUEUE_DISABLED = "#AR-ServerQueue_QueueDisabled_Header"
 
const string MESSAGE_QUEUE_POPULATION = "#AR-ServerQueue_PlayersInQueue"
 
const string MESSAGE_QUEUE_MAX_SIZE = "#AR-ServerQueue_MaxSize"
 
const string MESSAGE_ENQUEUED = "#AR-ServerQueue_Enqueued_Header"
 
const string MESSAGE_ENQUEUED_POSITION = "#AR-ServerQueue_CurrentPosition"
 
const string MESSAGE_QUEUE_WAIT_TIME = "#AR-ServerQueue_AvgWaitTime"
 
const string MESSAGE_QUEUE_EXPLANATION = "#AR-ServerQueue_Enqueued_Message"
 
const string MESSAGE_QUEUE_EXPLANATION_TIME = "#AR-ServerQueue_Enqueued_Message_Time"
 
const string LABEL_LEAVE_QUEUE = "#AR-ServerQueue_LeaveQueue_Button"
 
const string LABEL_CANCEL = "#AR-Workshop_ButtonCancel"
 
- Static Protected Attributes inherited from SCR_ConfigurableDialogUi
static SCR_ConfigurableDialogUi m_CurrentDialog
 

Additional Inherited Members

- Static Public Member Functions inherited from SCR_ConfigurableDialogUi
static SCR_ConfigurableDialogUi CreateFromPreset (ResourceName presetsResourceName, string tag, SCR_ConfigurableDialogUi customDialogObj=null)
 Creates a dialog from preset.
 
static SCR_ConfigurableDialogUi GetCurrentDialog ()
 
static string GetCurrentDialogTag ()
 
static bool IsPresetValid (ResourceName presetsResourceName, string tag)
 
- Public Attributes inherited from SCR_ConfigurableDialogUi
ref ScriptInvoker m_OnConfirm = new ScriptInvoker()
 
ref ScriptInvoker m_OnCancel = new ScriptInvoker()
 
ref ScriptInvoker m_OnClose = new ScriptInvoker()
 
ref ScriptInvoker m_OnCloseStart = new ScriptInvoker()
 
ref ScriptInvoker m_OnButtonPressed = new ScriptInvoker()
 
- Static Public Attributes inherited from SCR_ConfigurableDialogUi
static const ResourceName NAVIGATION_BUTTON_LAYOUT = "{87037226B1A2064B}UI/layouts/WidgetLibrary/Buttons/WLib_NavigationButtonSuperSmall.layout"
 
static const string BUTTON_CONFIRM = "confirm"
 
static const string BUTTON_CANCEL = "cancel"
 
- Static Protected Member Functions inherited from SCR_ConfigurableDialogUi
static SCR_ConfigurableDialogUi CreateByPreset (SCR_ConfigurableDialogUiPreset preset, SCR_ConfigurableDialogUi customDialogObj=null)
 
static Widget GetContentWidget (Widget baseWidget)
 Returns the container in which to place the content layout. Container must be called ContentLayoutContainer.
 

Member Function Documentation

◆ DisplayFavoriteAction()

void SCR_ServerFullDialog.DisplayFavoriteAction ( bool  isFavorite)
protected

◆ GetOnFavorite()

ScriptInvokerVoid SCR_ServerFullDialog.GetOnFavorite ( )

◆ GetOnLeaveQueueRequest()

ScriptInvokerRoom SCR_ServerFullDialog.GetOnLeaveQueueRequest ( )

◆ GetOnRetryFullServerJoin()

ScriptInvokerRoom SCR_ServerFullDialog.GetOnRetryFullServerJoin ( )

◆ Init()

void SCR_ServerFullDialog.Init ( Room  room,
SCR_EJoinFailUI  mode,
MissionWorkshopItem  scenario,
ScriptInvokerVoid  onFavoritesResponse = null 
)

◆ OnCancel()

override void SCR_ServerFullDialog.OnCancel ( )

Implements SCR_ConfigurableDialogUi.

◆ OnConfirm()

override void SCR_ServerFullDialog.OnConfirm ( )

Implements SCR_ConfigurableDialogUi.

◆ OnCopyIPAddress()

void SCR_ServerFullDialog.OnCopyIPAddress ( )
protected

◆ OnFavorite()

void SCR_ServerFullDialog.OnFavorite ( )
protected

◆ OnFieldManual()

void SCR_ServerFullDialog.OnFieldManual ( )
protected

◆ OnMenuClose()

override void SCR_ServerFullDialog.OnMenuClose ( )

Implements SCR_ConfigurableDialogUi.

◆ OnMenuOpen()

override void SCR_ServerFullDialog.OnMenuOpen ( SCR_ConfigurableDialogUiPreset  preset)

Called last of all, after all the initialization of main element done.

Here you can perform custom initialization.

Implements SCR_ConfigurableDialogUi.

◆ OnRoomSetFavoriteResponseDialog()

void SCR_ServerFullDialog.OnRoomSetFavoriteResponseDialog ( )
protected

◆ SetDiscordText()

void SCR_ServerFullDialog.SetDiscordText ( string  text)
protected

◆ SetFavoritesButtonsEnabled()

void SCR_ServerFullDialog.SetFavoritesButtonsEnabled ( bool  enabled)
protected

◆ SetIPAddressText()

void SCR_ServerFullDialog.SetIPAddressText ( string  text)
protected

◆ SetScenarioImage()

void SCR_ServerFullDialog.SetScenarioImage ( MissionWorkshopItem  scenario)

◆ UpdateDetailIcons()

void SCR_ServerFullDialog.UpdateDetailIcons ( )
protected

◆ UpdateEnqueuedTimeDisplay()

void SCR_ServerFullDialog.UpdateEnqueuedTimeDisplay ( )
protected

◆ UpdateInfo()

void SCR_ServerFullDialog.UpdateInfo ( )

◆ UpdateInfo_Enqueued()

void SCR_ServerFullDialog.UpdateInfo_Enqueued ( )
protected

◆ UpdateInfo_QueueDisabled()

void SCR_ServerFullDialog.UpdateInfo_QueueDisabled ( )
protected

◆ UpdateInfo_QueueFull()

void SCR_ServerFullDialog.UpdateInfo_QueueFull ( )
protected

Member Data Documentation

◆ ENQUEUED_TIME_UPDATE_FREQUENCY

const int SCR_ServerFullDialog.ENQUEUED_TIME_UPDATE_FREQUENCY = 1000
staticprotected

◆ INPUT_BUTTON_FAVORITES

const string SCR_ServerFullDialog.INPUT_BUTTON_FAVORITES = "Favorites"
staticprotected

◆ INPUT_BUTTON_FIELD_MANUAL

const string SCR_ServerFullDialog.INPUT_BUTTON_FIELD_MANUAL = "FieldManual"
staticprotected

◆ LABEL_CANCEL

const string SCR_ServerFullDialog.LABEL_CANCEL = "#AR-Workshop_ButtonCancel"
staticprotected

◆ LABEL_LEAVE_QUEUE

const string SCR_ServerFullDialog.LABEL_LEAVE_QUEUE = "#AR-ServerQueue_LeaveQueue_Button"
staticprotected

◆ m_BackendImageComp

SCR_ScenarioBackendImageComponent SCR_ServerFullDialog.m_BackendImageComp
protected

◆ m_BtnFavorites

SCR_ModularButtonComponent SCR_ServerFullDialog.m_BtnFavorites
protected

◆ m_eMode

SCR_EJoinFailUI SCR_ServerFullDialog.m_eMode
protected

◆ m_NavCancel

SCR_InputButtonComponent SCR_ServerFullDialog.m_NavCancel
protected

◆ m_NavConfirm

SCR_InputButtonComponent SCR_ServerFullDialog.m_NavConfirm
protected

◆ m_NavFavorites

SCR_InputButtonComponent SCR_ServerFullDialog.m_NavFavorites
protected

◆ m_NavFieldManual

SCR_InputButtonComponent SCR_ServerFullDialog.m_NavFieldManual
protected

◆ m_OnFavorite

ref ScriptInvokerVoid SCR_ServerFullDialog.m_OnFavorite
protected

◆ m_OnLeaveQueueRequest

ref ScriptInvokerRoom SCR_ServerFullDialog.m_OnLeaveQueueRequest
protected

◆ m_OnRetryFullServerJoin

ref ScriptInvokerRoom SCR_ServerFullDialog.m_OnRetryFullServerJoin
protected

◆ m_Room

Room SCR_ServerFullDialog.m_Room
protected

◆ m_Widgets

ref SCR_ServerFullDialogContentWidgets SCR_ServerFullDialog.m_Widgets = new SCR_ServerFullDialogContentWidgets()
protected

◆ m_wSideSpinner

Widget SCR_ServerFullDialog.m_wSideSpinner
protected

◆ MESSAGE_ENQUEUED

const string SCR_ServerFullDialog.MESSAGE_ENQUEUED = "#AR-ServerQueue_Enqueued_Header"
staticprotected

◆ MESSAGE_ENQUEUED_POSITION

const string SCR_ServerFullDialog.MESSAGE_ENQUEUED_POSITION = "#AR-ServerQueue_CurrentPosition"
staticprotected

◆ MESSAGE_QUEUE_DISABLED

const string SCR_ServerFullDialog.MESSAGE_QUEUE_DISABLED = "#AR-ServerQueue_QueueDisabled_Header"
staticprotected

◆ MESSAGE_QUEUE_EXPLANATION

const string SCR_ServerFullDialog.MESSAGE_QUEUE_EXPLANATION = "#AR-ServerQueue_Enqueued_Message"
staticprotected

◆ MESSAGE_QUEUE_EXPLANATION_TIME

const string SCR_ServerFullDialog.MESSAGE_QUEUE_EXPLANATION_TIME = "#AR-ServerQueue_Enqueued_Message_Time"
staticprotected

◆ MESSAGE_QUEUE_FULL

const string SCR_ServerFullDialog.MESSAGE_QUEUE_FULL = "#AR-ServerQueue_QueueFull_Header"
staticprotected

◆ MESSAGE_QUEUE_MAX_SIZE

const string SCR_ServerFullDialog.MESSAGE_QUEUE_MAX_SIZE = "#AR-ServerQueue_MaxSize"
staticprotected

◆ MESSAGE_QUEUE_POPULATION

const string SCR_ServerFullDialog.MESSAGE_QUEUE_POPULATION = "#AR-ServerQueue_PlayersInQueue"
staticprotected

◆ MESSAGE_QUEUE_WAIT_TIME

const string SCR_ServerFullDialog.MESSAGE_QUEUE_WAIT_TIME = "#AR-ServerQueue_AvgWaitTime"
staticprotected

◆ MESSAGE_SERVER_FULL

const string SCR_ServerFullDialog.MESSAGE_SERVER_FULL = "#AR-ServerBrowser_FullServer"
staticprotected

◆ MESSAGE_SERVER_POPULATION

const string SCR_ServerFullDialog.MESSAGE_SERVER_POPULATION = "#AR-Scenario_Players"
staticprotected

◆ MOUSE_BUTTON_FAVORITES

const string SCR_ServerFullDialog.MOUSE_BUTTON_FAVORITES = "FavoriteButton"
staticprotected

◆ WIDGET_BACKGROUND_IMAGE

const string SCR_ServerFullDialog.WIDGET_BACKGROUND_IMAGE = "BackgroundImageBackend"
staticprotected

◆ WIDGET_SIDE_SPINNER

const string SCR_ServerFullDialog.WIDGET_SIDE_SPINNER = "SideSpinner"
staticprotected
The documentation for this interface was generated from the following file:
Generated by doxygen 1.9.6