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_ServerDetailsDialog Interface Reference

Details with mod list to display all server mods. More...

Inheritance diagram for SCR_ServerDetailsDialog:
[legend]

Public Member Functions

override void OnMenuOpen (SCR_ConfigurableDialogUiPreset preset)
 Called last of all, after all the initialization of main element done.
 
void FillModList (array< ref SCR_WorkshopItem > items, SCR_RoomModsManager modsManager)
 
void SetScenarioImage (MissionWorkshopItem scenario)
 
void SetCanJoin (bool canJoin)
 
- Public Member Functions inherited from SCR_AddonListDialog
void SCR_AddonListDialog (array< ref SCR_WorkshopItem > items, string preset)
 
override void OnMenuOpen (SCR_ConfigurableDialogUiPreset preset)
 Called last of all, after all the initialization of main element done.
 
array< SCR_DownloadManager_AddonDownloadLine > GetDonwloadLines ()
 
- 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 ()
 

Static Public Member Functions

static SCR_ServerDetailsDialog CreateServerDetailsDialog (Room room, array< ref SCR_WorkshopItem > items, string preset, ResourceName dialogsConfig="", ScriptInvokerVoid onFavoritesResponse=null)
 
- Static Public Member Functions inherited from SCR_AddonListDialog
static SCR_AddonListDialog CreateItemsList (array< ref SCR_WorkshopItem > items, string preset, ResourceName dialogsConfig=string.Empty)
 
static SCR_AddonListDialog CreateRestrictedAddonsDownload (array< ref SCR_WorkshopItem > items)
 Dialog when downloading restricted addons.
 
static SCR_AddonListDialog CreateRestrictedAddonsJoinServer (array< ref SCR_WorkshopItem > items)
 Dialog when trying to connect to a server with restricted addons.
 
static SCR_AddonListDialog DisplayRestrictedAddonsList (array< ref SCR_WorkshopItem > items, string tagBlocked, string tagReported)
 Display dialogs for reported and blocked (banned) mods.
 
static SCR_AddonListDialog CreateFailedToStartWithMods (array< ref SCR_WorkshopItem > items)
 Dialog when failed to load game with selected mods.
 
- 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

ref ScriptInvoker m_OnFavorites = new ScriptInvoker()
 
- 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

static Room s_Room
 
- 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"
 

Protected Member Functions

override void InitWidgets ()
 
override void Init (Widget root, SCR_ConfigurableDialogUiPreset preset, MenuBase proxyMenu)
 
void OnFavorites ()
 
void DisplayFavoriteAction (bool isFavorite)
 
void OnRoomSetFavoriteResponseDialog ()
 
void OnCopyIPAddress ()
 
void OnDiscord ()
 
void SetIPAddressText (string text)
 
void SetDiscordText (string text)
 
void UpdateModsAmountMessages (SCR_RoomModsManager modsManager=null)
 
void UpdateDetailIcons ()
 
void UpdateAlertMessage ()
 
- 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

Widget m_wScroll
 
Widget m_wAddonList
 
Widget m_wLoading
 
Widget m_wModsSizeLayout
 
Widget m_wDetailIconsLayout
 
Widget m_wVersionAlertIcon
 
Widget m_wModsSizeToDownloadLayout
 
Widget m_wAlertWrapper
 
RichTextWidget m_wIPAddressText
 
RichTextWidget m_wDiscordText
 
RichTextWidget m_wModsNumberText
 
RichTextWidget m_wModsSizeText
 
RichTextWidget m_wAlertText
 
RichTextWidget m_wModsSizeToDownloadText
 
SCR_InputButtonComponent m_NavConfirm
 
SCR_InputButtonComponent m_NavFavorites
 
SCR_ModularButtonComponent m_BtnFavorites
 
SCR_ButtonComponent m_BtnCopyIPAddress
 
SCR_ButtonComponent m_BtnDiscord
 
SCR_ScenarioBackendImageComponent m_BackendImageComp
 
Widget m_wBackgroundImageBackend
 
float m_fVersionAlertIconPaddingLeft
 
- Protected Attributes inherited from SCR_AddonListDialog
ref array< ref SCR_WorkshopItem > m_aItems = {}
 
ref array< SCR_DownloadManager_AddonDownloadLine > m_aDownloadLines = {}
 
- 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_SCROLL = "ScrollSize"
 
const string WIDGET_ADDON_LIST = "AddonList"
 
const string WIDGET_LOADING = "Loading"
 
const string WIDGET_IPADDRESS_TEXT = "IPAddressText"
 
const string WIDGET_DISCORD_TEXT = "DiscordText"
 
const string WIDGET_MODS_NUMBER_TEXT = "ModsNumberText"
 
const string WIDGET_MODS_SIZE_TEXT = "ModsSizeAmount"
 
const string WIDGET_ALERT_TEXT = "AlertText"
 
const string WIDGET_ALERT_WRAPPER = "AlertOverlay"
 
const string WIDGET_MODS_SIZE_TO_DOWNLOAD_TEXT = "ModsSizeToDownload"
 
const string WIDGET_MODS_SIZE_LAYOUT = "ModsSizeLayout"
 
const string WIDGET_DETAIL_ICONS_LAYOUT = "DetailIconsLayout"
 
const string WIDGET_MODS_SIZE_TO_DOWNLOAD_LAYOUT = "ModsSizeToDownloadLayout"
 
const string IMG_WRONG_VERSION = "DetailIcon_WrongVersion"
 
const string IMG_PASSWORD_PROTECTED = "Detailicon_PasswordProtected"
 
const string IMG_CROSS_PLATFORM = "DetailIcon_CrossPlatform"
 
const string IMG_MODDED = "DetailIcon_Modded"
 
const string IMG_VERSION_ALERT = "VersionAlertIconButton"
 
const string BTN_CONFIRM = "Confirm"
 
const string BTN_FAVORITES = "favorites"
 
const string BTN_FAVORITES_STAR = "FavoriteButton"
 
const string BTN_COPY_IPADDRESS = "IPAddressButton"
 
const string BTN_DISCORD = "DiscordButton"
 
const ResourceName ADDON_LINE_LAYOUT_SERVER_BROWSER = "{3BC78F295971FD3D}UI/layouts/Menus/ContentBrowser/DownloadManager/DownloadManager_AddonDownloadLineConfirmation_ServerBrowser.layout"
 
const string STR_VERSION_MISMATCH = "#AR-ServerBrowser_JoinModVersionMissmatch"
 
const string STR_HIGH_PING = "#AR-ServerBrowser_HighPingWarning_Title"
 
const string STR_HIGH_PING_ICON = "ping-low"
 
- Static Protected Attributes inherited from SCR_AddonListDialog
const ResourceName ADDON_LINE_LAYOUT = "{BB5AEDDA3C4134FD}UI/layouts/Menus/ContentBrowser/DownloadManager/DownloadManager_AddonDownloadLineConfirmation.layout"
 
- Static Protected Attributes inherited from SCR_ConfigurableDialogUi
static SCR_ConfigurableDialogUi m_CurrentDialog
 

Additional Inherited Members

- 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.
 

Detailed Description

Details with mod list to display all server mods.

There should be displayed missing server. Extra information about server can be added.

Member Function Documentation

◆ CreateServerDetailsDialog()

static SCR_ServerDetailsDialog SCR_ServerDetailsDialog.CreateServerDetailsDialog ( Room  room,
array< ref SCR_WorkshopItem >  items,
string  preset,
ResourceName  dialogsConfig = "",
ScriptInvokerVoid  onFavoritesResponse = null 
)
static

Favorites button

◆ DisplayFavoriteAction()

void SCR_ServerDetailsDialog.DisplayFavoriteAction ( bool  isFavorite)
protected

◆ FillModList()

void SCR_ServerDetailsDialog.FillModList ( array< ref SCR_WorkshopItem >  items,
SCR_RoomModsManager  modsManager 
)

◆ Init()

override void SCR_ServerDetailsDialog.Init ( Widget  root,
SCR_ConfigurableDialogUiPreset  preset,
MenuBase  proxyMenu 
)
protected

Implements SCR_ConfigurableDialogUi.

◆ InitWidgets()

override void SCR_ServerDetailsDialog.InitWidgets ( )
protected

Implements SCR_ConfigurableDialogUi.

◆ OnCopyIPAddress()

void SCR_ServerDetailsDialog.OnCopyIPAddress ( )
protected

◆ OnDiscord()

void SCR_ServerDetailsDialog.OnDiscord ( )
protected

◆ OnFavorites()

void SCR_ServerDetailsDialog.OnFavorites ( )
protected

◆ OnMenuOpen()

override void SCR_ServerDetailsDialog.OnMenuOpen ( SCR_ConfigurableDialogUiPreset  preset)

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

Here you can perform custom initialization.

Background Image

Implements SCR_AddonListDialog.

◆ OnRoomSetFavoriteResponseDialog()

void SCR_ServerDetailsDialog.OnRoomSetFavoriteResponseDialog ( )
protected

◆ SetCanJoin()

void SCR_ServerDetailsDialog.SetCanJoin ( bool  canJoin)

◆ SetDiscordText()

void SCR_ServerDetailsDialog.SetDiscordText ( string  text)
protected

◆ SetIPAddressText()

void SCR_ServerDetailsDialog.SetIPAddressText ( string  text)
protected

◆ SetScenarioImage()

void SCR_ServerDetailsDialog.SetScenarioImage ( MissionWorkshopItem  scenario)

◆ UpdateAlertMessage()

void SCR_ServerDetailsDialog.UpdateAlertMessage ( )
protected

◆ UpdateDetailIcons()

void SCR_ServerDetailsDialog.UpdateDetailIcons ( )
protected

◆ UpdateModsAmountMessages()

void SCR_ServerDetailsDialog.UpdateModsAmountMessages ( SCR_RoomModsManager  modsManager = null)
protected

Member Data Documentation

◆ ADDON_LINE_LAYOUT_SERVER_BROWSER

const ResourceName SCR_ServerDetailsDialog.ADDON_LINE_LAYOUT_SERVER_BROWSER = "{3BC78F295971FD3D}UI/layouts/Menus/ContentBrowser/DownloadManager/DownloadManager_AddonDownloadLineConfirmation_ServerBrowser.layout"
staticprotected

◆ BTN_CONFIRM

const string SCR_ServerDetailsDialog.BTN_CONFIRM = "Confirm"
staticprotected

◆ BTN_COPY_IPADDRESS

const string SCR_ServerDetailsDialog.BTN_COPY_IPADDRESS = "IPAddressButton"
staticprotected

◆ BTN_DISCORD

const string SCR_ServerDetailsDialog.BTN_DISCORD = "DiscordButton"
staticprotected

◆ BTN_FAVORITES

const string SCR_ServerDetailsDialog.BTN_FAVORITES = "favorites"
staticprotected

◆ BTN_FAVORITES_STAR

const string SCR_ServerDetailsDialog.BTN_FAVORITES_STAR = "FavoriteButton"
staticprotected

◆ IMG_CROSS_PLATFORM

const string SCR_ServerDetailsDialog.IMG_CROSS_PLATFORM = "DetailIcon_CrossPlatform"
staticprotected

◆ IMG_MODDED

const string SCR_ServerDetailsDialog.IMG_MODDED = "DetailIcon_Modded"
staticprotected

◆ IMG_PASSWORD_PROTECTED

const string SCR_ServerDetailsDialog.IMG_PASSWORD_PROTECTED = "Detailicon_PasswordProtected"
staticprotected

◆ IMG_VERSION_ALERT

const string SCR_ServerDetailsDialog.IMG_VERSION_ALERT = "VersionAlertIconButton"
staticprotected

◆ IMG_WRONG_VERSION

const string SCR_ServerDetailsDialog.IMG_WRONG_VERSION = "DetailIcon_WrongVersion"
staticprotected

◆ m_BackendImageComp

SCR_ScenarioBackendImageComponent SCR_ServerDetailsDialog.m_BackendImageComp
protected

◆ m_BtnCopyIPAddress

SCR_ButtonComponent SCR_ServerDetailsDialog.m_BtnCopyIPAddress
protected

◆ m_BtnDiscord

SCR_ButtonComponent SCR_ServerDetailsDialog.m_BtnDiscord
protected

◆ m_BtnFavorites

SCR_ModularButtonComponent SCR_ServerDetailsDialog.m_BtnFavorites
protected

◆ m_fVersionAlertIconPaddingLeft

float SCR_ServerDetailsDialog.m_fVersionAlertIconPaddingLeft
protected

◆ m_NavConfirm

SCR_InputButtonComponent SCR_ServerDetailsDialog.m_NavConfirm
protected

◆ m_NavFavorites

SCR_InputButtonComponent SCR_ServerDetailsDialog.m_NavFavorites
protected

◆ m_OnFavorites

ref ScriptInvoker SCR_ServerDetailsDialog.m_OnFavorites = new ScriptInvoker()

◆ m_wAddonList

Widget SCR_ServerDetailsDialog.m_wAddonList
protected

◆ m_wAlertText

RichTextWidget SCR_ServerDetailsDialog.m_wAlertText
protected

◆ m_wAlertWrapper

Widget SCR_ServerDetailsDialog.m_wAlertWrapper
protected

◆ m_wBackgroundImageBackend

Widget SCR_ServerDetailsDialog.m_wBackgroundImageBackend
protected

◆ m_wDetailIconsLayout

Widget SCR_ServerDetailsDialog.m_wDetailIconsLayout
protected

◆ m_wDiscordText

RichTextWidget SCR_ServerDetailsDialog.m_wDiscordText
protected

◆ m_wIPAddressText

RichTextWidget SCR_ServerDetailsDialog.m_wIPAddressText
protected

◆ m_wLoading

Widget SCR_ServerDetailsDialog.m_wLoading
protected

◆ m_wModsNumberText

RichTextWidget SCR_ServerDetailsDialog.m_wModsNumberText
protected

◆ m_wModsSizeLayout

Widget SCR_ServerDetailsDialog.m_wModsSizeLayout
protected

◆ m_wModsSizeText

RichTextWidget SCR_ServerDetailsDialog.m_wModsSizeText
protected

◆ m_wModsSizeToDownloadLayout

Widget SCR_ServerDetailsDialog.m_wModsSizeToDownloadLayout
protected

◆ m_wModsSizeToDownloadText

RichTextWidget SCR_ServerDetailsDialog.m_wModsSizeToDownloadText
protected

◆ m_wScroll

Widget SCR_ServerDetailsDialog.m_wScroll
protected

◆ m_wVersionAlertIcon

Widget SCR_ServerDetailsDialog.m_wVersionAlertIcon
protected

◆ s_Room

Room SCR_ServerDetailsDialog.s_Room
static

◆ STR_HIGH_PING

const string SCR_ServerDetailsDialog.STR_HIGH_PING = "#AR-ServerBrowser_HighPingWarning_Title"
staticprotected

◆ STR_HIGH_PING_ICON

const string SCR_ServerDetailsDialog.STR_HIGH_PING_ICON = "ping-low"
staticprotected

◆ STR_VERSION_MISMATCH

const string SCR_ServerDetailsDialog.STR_VERSION_MISMATCH = "#AR-ServerBrowser_JoinModVersionMissmatch"
staticprotected

◆ WIDGET_ADDON_LIST

const string SCR_ServerDetailsDialog.WIDGET_ADDON_LIST = "AddonList"
staticprotected

◆ WIDGET_ALERT_TEXT

const string SCR_ServerDetailsDialog.WIDGET_ALERT_TEXT = "AlertText"
staticprotected

◆ WIDGET_ALERT_WRAPPER

const string SCR_ServerDetailsDialog.WIDGET_ALERT_WRAPPER = "AlertOverlay"
staticprotected

◆ WIDGET_DETAIL_ICONS_LAYOUT

const string SCR_ServerDetailsDialog.WIDGET_DETAIL_ICONS_LAYOUT = "DetailIconsLayout"
staticprotected

◆ WIDGET_DISCORD_TEXT

const string SCR_ServerDetailsDialog.WIDGET_DISCORD_TEXT = "DiscordText"
staticprotected

◆ WIDGET_IPADDRESS_TEXT

const string SCR_ServerDetailsDialog.WIDGET_IPADDRESS_TEXT = "IPAddressText"
staticprotected

◆ WIDGET_LOADING

const string SCR_ServerDetailsDialog.WIDGET_LOADING = "Loading"
staticprotected

◆ WIDGET_MODS_NUMBER_TEXT

const string SCR_ServerDetailsDialog.WIDGET_MODS_NUMBER_TEXT = "ModsNumberText"
staticprotected

◆ WIDGET_MODS_SIZE_LAYOUT

const string SCR_ServerDetailsDialog.WIDGET_MODS_SIZE_LAYOUT = "ModsSizeLayout"
staticprotected

◆ WIDGET_MODS_SIZE_TEXT

const string SCR_ServerDetailsDialog.WIDGET_MODS_SIZE_TEXT = "ModsSizeAmount"
staticprotected

◆ WIDGET_MODS_SIZE_TO_DOWNLOAD_LAYOUT

const string SCR_ServerDetailsDialog.WIDGET_MODS_SIZE_TO_DOWNLOAD_LAYOUT = "ModsSizeToDownloadLayout"
staticprotected

◆ WIDGET_MODS_SIZE_TO_DOWNLOAD_TEXT

const string SCR_ServerDetailsDialog.WIDGET_MODS_SIZE_TO_DOWNLOAD_TEXT = "ModsSizeToDownload"
staticprotected

◆ WIDGET_SCROLL

const string SCR_ServerDetailsDialog.WIDGET_SCROLL = "ScrollSize"
staticprotected
The documentation for this interface was generated from the following file:
Generated by doxygen 1.9.6