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

Class for handling server browser dialogs. More...

Public Member Functions

void DisplayDialog (EJoinDialogState state)
 Display dialog by state and setup current state.
 
void SetDialogMessage (string msg)
 
void CloseCurrentDialog ()
 
void DisplayJoinFail (EApiCode apiError)
 Show join fail message in dialog.
 
void DisplayJoinBan (RoomJoinData data)
 
void DisplayJoinDownloadsWarning (array< ref SCR_WorkshopItemActionDownload > downloads, SCR_EJoinDownloadsConfirmationDialogType type)
 
MultiplayerDialogUI CreateManualJoinDialog ()
 DECOUPLED DIALOGS.
 
SCR_ServerDetailsDialog CreateServerDetailsDialog (Room room, array< ref SCR_WorkshopItem > items, ScriptInvokerVoid onFavoritesResponse=null)
 
void FillRoomDetailsMods (array< ref SCR_WorkshopItem > items, SCR_RoomModsManager modsManager=null)
 
void UpdateRoomDetailsScenarioImage (MissionWorkshopItem scenario)
 
SCR_ServerFullDialog CreateServerFullDialog ()
 
void UpdateServerFullScenarioImage (MissionWorkshopItem scenario)
 
void UpdateServerFullDialog ()
 
ScriptInvokerVoid GetOnConfirm ()
 
ScriptInvokerVoid GetOnCancel ()
 
ScriptInvokerVoid GetOnJoinProcessCancel ()
 
ScriptInvokerRoom GetOnDownloadComplete ()
 
ScriptInvokerVoid GetOnDownloadCancelDialogClose ()
 
Room GetJoinRoom ()
 
EJoinDialogState GetDisplayState ()
 
SCR_ConfigurableDialogUi GetCurrentDialog ()
 
bool IsDialogOpen ()
 
void SetJoinRoom (Room room)
 
void SetModManager (SCR_RoomModsManager modManager)
 

Static Public Attributes

const ResourceName CONFIG_DIALOGS = "{471EFCF445C3E9C6}Configs/ServerBrowser/JoiningDialogs.conf"
 
const string ERROR_TAG_DEFAULT = "JOIN_FAILED"
 

Protected Member Functions

void SetDialogByTag (string tag, SCR_ConfigurableDialogUi dialog=null)
 Quick short code to open dialog by tag and cache it.
 
void OnDialogConfirm ()
 
void OnDialogCancel ()
 
void OnAllReportsCanceled (SCR_ReportedAddonsDialog dialog)
 Call this when all reports from dialog are cancled to clear invoker actions and display download dialog.
 
void OnDownloadingDone ()
 
void DisplayPasswordRequired ()
 Display dialog for password insert whenever password is required.
 
void OnPasswordEditboxChanged (string text)
 Call this whenever password dialog editbox is being edited.
 

Protected Attributes

Room m_JoinRoom
 
SCR_RoomModsManager m_ModManager
 
ServerBrowserMenuUI m_ServerBrowser
 
EJoinDialogState m_iDisplayState
 
SCR_ConfigurableDialogUi m_CurrentDialog
 
ref ScriptInvokerVoid m_OnConfirm
 
ref ScriptInvokerVoid m_OnCancel
 
ref ScriptInvokerVoid m_OnJoinProcessCancel
 
ref ScriptInvokerRoom m_OnDownloadComplete
 
ref ScriptInvokerVoid m_OnDownloadCancelDialogClose
 

Static Protected Attributes

const string OFFICIAL_SERVER_SCOPE = "officialServer"
 
const string TAG_SEARCHING_SERVER = "SEARCHING_SERVER"
 
const string TAG_JOIN = "JOIN"
 
const string TAG_REJOIN = "REJOIN"
 
const string TAG_SERVER_NOT_FOUND = "SERVER_NOT_FOUND"
 
const string TAG_VERSION_MISMATCH = "VERSION_MISMATCH"
 
const string TAG_CHECKING_CONTENT = "CHECKING_CONTENT"
 
const string TAG_MOD_UGC_PRIVILEGE_MISSING = "MOD_UGC_PRIVILEGE_MISSING"
 
const string TAG_MODS_DOWNLOADING = "MODS_DOWNLOADING"
 
const string TAG_SERVER_FULL = "SERVER_FULL"
 
const string TAG_PASSWORD_REQUIRED = "PASSWORD_REQUIRED"
 
const string TAG_BACKEND_TIMEOUT = "BACKEND_TIMEOUT"
 
const string TAG_BANNED = "JOIN_FAILED_BAN"
 
const string TAG_HIGH_PING_SERVER = "HIGH_PING_SERVER"
 
const string TAG_UNRELATED_DOWNLOADS_CANCELING = "UNRELATED_DOWNLOADS_CANCELING"
 
const string STR_LIGHT_BAN = "#AR-LightBan"
 
const string STR_HEAVY_BAN = "#AR-HeavyBan"
 

Detailed Description

Class for handling server browser dialogs.

Server browser use multiple dialogs in joining process for checking servers, mod content and restrictinos.

Member Function Documentation

◆ CloseCurrentDialog()

void SCR_ServerBrowserDialogManager.CloseCurrentDialog ( )

◆ CreateManualJoinDialog()

MultiplayerDialogUI SCR_ServerBrowserDialogManager.CreateManualJoinDialog ( )

DECOUPLED DIALOGS.

◆ CreateServerDetailsDialog()

SCR_ServerDetailsDialog SCR_ServerBrowserDialogManager.CreateServerDetailsDialog ( Room  room,
array< ref SCR_WorkshopItem >  items,
ScriptInvokerVoid  onFavoritesResponse = null 
)

◆ CreateServerFullDialog()

SCR_ServerFullDialog SCR_ServerBrowserDialogManager.CreateServerFullDialog ( )

◆ DisplayDialog()

void SCR_ServerBrowserDialogManager.DisplayDialog ( EJoinDialogState  state)

Display dialog by state and setup current state.

◆ DisplayJoinBan()

void SCR_ServerBrowserDialogManager.DisplayJoinBan ( RoomJoinData  data)

◆ DisplayJoinDownloadsWarning()

void SCR_ServerBrowserDialogManager.DisplayJoinDownloadsWarning ( array< ref SCR_WorkshopItemActionDownload >  downloads,
SCR_EJoinDownloadsConfirmationDialogType  type 
)

◆ DisplayJoinFail()

void SCR_ServerBrowserDialogManager.DisplayJoinFail ( EApiCode  apiError)

Show join fail message in dialog.

◆ DisplayPasswordRequired()

void SCR_ServerBrowserDialogManager.DisplayPasswordRequired ( )
protected

Display dialog for password insert whenever password is required.

◆ FillRoomDetailsMods()

void SCR_ServerBrowserDialogManager.FillRoomDetailsMods ( array< ref SCR_WorkshopItem >  items,
SCR_RoomModsManager  modsManager = null 
)

◆ GetCurrentDialog()

SCR_ConfigurableDialogUi SCR_ServerBrowserDialogManager.GetCurrentDialog ( )

◆ GetDisplayState()

EJoinDialogState SCR_ServerBrowserDialogManager.GetDisplayState ( )

◆ GetJoinRoom()

Room SCR_ServerBrowserDialogManager.GetJoinRoom ( )

◆ GetOnCancel()

ScriptInvokerVoid SCR_ServerBrowserDialogManager.GetOnCancel ( )

◆ GetOnConfirm()

ScriptInvokerVoid SCR_ServerBrowserDialogManager.GetOnConfirm ( )

◆ GetOnDownloadCancelDialogClose()

ScriptInvokerVoid SCR_ServerBrowserDialogManager.GetOnDownloadCancelDialogClose ( )

◆ GetOnDownloadComplete()

ScriptInvokerRoom SCR_ServerBrowserDialogManager.GetOnDownloadComplete ( )

◆ GetOnJoinProcessCancel()

ScriptInvokerVoid SCR_ServerBrowserDialogManager.GetOnJoinProcessCancel ( )

◆ IsDialogOpen()

bool SCR_ServerBrowserDialogManager.IsDialogOpen ( )

◆ OnAllReportsCanceled()

void SCR_ServerBrowserDialogManager.OnAllReportsCanceled ( SCR_ReportedAddonsDialog  dialog)
protected

Call this when all reports from dialog are cancled to clear invoker actions and display download dialog.

◆ OnDialogCancel()

void SCR_ServerBrowserDialogManager.OnDialogCancel ( )
protected

◆ OnDialogConfirm()

void SCR_ServerBrowserDialogManager.OnDialogConfirm ( )
protected

◆ OnDownloadingDone()

void SCR_ServerBrowserDialogManager.OnDownloadingDone ( )
protected

◆ OnPasswordEditboxChanged()

void SCR_ServerBrowserDialogManager.OnPasswordEditboxChanged ( string  text)
protected

Call this whenever password dialog editbox is being edited.

◆ SetDialogByTag()

void SCR_ServerBrowserDialogManager.SetDialogByTag ( string  tag,
SCR_ConfigurableDialogUi  dialog = null 
)
protected

Quick short code to open dialog by tag and cache it.

◆ SetDialogMessage()

void SCR_ServerBrowserDialogManager.SetDialogMessage ( string  msg)

◆ SetJoinRoom()

void SCR_ServerBrowserDialogManager.SetJoinRoom ( Room  room)

◆ SetModManager()

void SCR_ServerBrowserDialogManager.SetModManager ( SCR_RoomModsManager  modManager)

◆ UpdateRoomDetailsScenarioImage()

void SCR_ServerBrowserDialogManager.UpdateRoomDetailsScenarioImage ( MissionWorkshopItem  scenario)

◆ UpdateServerFullDialog()

void SCR_ServerBrowserDialogManager.UpdateServerFullDialog ( )

◆ UpdateServerFullScenarioImage()

void SCR_ServerBrowserDialogManager.UpdateServerFullScenarioImage ( MissionWorkshopItem  scenario)

Member Data Documentation

◆ CONFIG_DIALOGS

const ResourceName SCR_ServerBrowserDialogManager.CONFIG_DIALOGS = "{471EFCF445C3E9C6}Configs/ServerBrowser/JoiningDialogs.conf"
static

◆ ERROR_TAG_DEFAULT

const string SCR_ServerBrowserDialogManager.ERROR_TAG_DEFAULT = "JOIN_FAILED"
static

◆ m_CurrentDialog

SCR_ConfigurableDialogUi SCR_ServerBrowserDialogManager.m_CurrentDialog
protected

◆ m_iDisplayState

EJoinDialogState SCR_ServerBrowserDialogManager.m_iDisplayState
protected

◆ m_JoinRoom

Room SCR_ServerBrowserDialogManager.m_JoinRoom
protected

◆ m_ModManager

SCR_RoomModsManager SCR_ServerBrowserDialogManager.m_ModManager
protected

◆ m_OnCancel

ref ScriptInvokerVoid SCR_ServerBrowserDialogManager.m_OnCancel
protected

◆ m_OnConfirm

ref ScriptInvokerVoid SCR_ServerBrowserDialogManager.m_OnConfirm
protected

◆ m_OnDownloadCancelDialogClose

ref ScriptInvokerVoid SCR_ServerBrowserDialogManager.m_OnDownloadCancelDialogClose
protected

◆ m_OnDownloadComplete

ref ScriptInvokerRoom SCR_ServerBrowserDialogManager.m_OnDownloadComplete
protected

◆ m_OnJoinProcessCancel

ref ScriptInvokerVoid SCR_ServerBrowserDialogManager.m_OnJoinProcessCancel
protected

◆ m_ServerBrowser

ServerBrowserMenuUI SCR_ServerBrowserDialogManager.m_ServerBrowser
protected

◆ OFFICIAL_SERVER_SCOPE

const string SCR_ServerBrowserDialogManager.OFFICIAL_SERVER_SCOPE = "officialServer"
staticprotected

◆ STR_HEAVY_BAN

const string SCR_ServerBrowserDialogManager.STR_HEAVY_BAN = "#AR-HeavyBan"
staticprotected

◆ STR_LIGHT_BAN

const string SCR_ServerBrowserDialogManager.STR_LIGHT_BAN = "#AR-LightBan"
staticprotected

◆ TAG_BACKEND_TIMEOUT

const string SCR_ServerBrowserDialogManager.TAG_BACKEND_TIMEOUT = "BACKEND_TIMEOUT"
staticprotected

◆ TAG_BANNED

const string SCR_ServerBrowserDialogManager.TAG_BANNED = "JOIN_FAILED_BAN"
staticprotected

◆ TAG_CHECKING_CONTENT

const string SCR_ServerBrowserDialogManager.TAG_CHECKING_CONTENT = "CHECKING_CONTENT"
staticprotected

◆ TAG_HIGH_PING_SERVER

const string SCR_ServerBrowserDialogManager.TAG_HIGH_PING_SERVER = "HIGH_PING_SERVER"
staticprotected

◆ TAG_JOIN

const string SCR_ServerBrowserDialogManager.TAG_JOIN = "JOIN"
staticprotected

◆ TAG_MOD_UGC_PRIVILEGE_MISSING

const string SCR_ServerBrowserDialogManager.TAG_MOD_UGC_PRIVILEGE_MISSING = "MOD_UGC_PRIVILEGE_MISSING"
staticprotected

◆ TAG_MODS_DOWNLOADING

const string SCR_ServerBrowserDialogManager.TAG_MODS_DOWNLOADING = "MODS_DOWNLOADING"
staticprotected

◆ TAG_PASSWORD_REQUIRED

const string SCR_ServerBrowserDialogManager.TAG_PASSWORD_REQUIRED = "PASSWORD_REQUIRED"
staticprotected

◆ TAG_REJOIN

const string SCR_ServerBrowserDialogManager.TAG_REJOIN = "REJOIN"
staticprotected

◆ TAG_SEARCHING_SERVER

const string SCR_ServerBrowserDialogManager.TAG_SEARCHING_SERVER = "SEARCHING_SERVER"
staticprotected

◆ TAG_SERVER_FULL

const string SCR_ServerBrowserDialogManager.TAG_SERVER_FULL = "SERVER_FULL"
staticprotected

◆ TAG_SERVER_NOT_FOUND

const string SCR_ServerBrowserDialogManager.TAG_SERVER_NOT_FOUND = "SERVER_NOT_FOUND"
staticprotected

◆ TAG_UNRELATED_DOWNLOADS_CANCELING

const string SCR_ServerBrowserDialogManager.TAG_UNRELATED_DOWNLOADS_CANCELING = "UNRELATED_DOWNLOADS_CANCELING"
staticprotected

◆ TAG_VERSION_MISMATCH

const string SCR_ServerBrowserDialogManager.TAG_VERSION_MISMATCH = "VERSION_MISMATCH"
staticprotected
The documentation for this interface was generated from the following file:
Generated by doxygen 1.9.6