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

Public Member Functions

override void OnMenuOpen (SCR_ConfigurableDialogUiPreset preset)
 OVERRIDES.
 
void SetSave (WorldSaveItem save)
 PUBLIC.
 
- Public Member Functions inherited from SCR_ScenarioConfirmationDialogUi
void SCR_ScenarioConfirmationDialogUi (MissionWorkshopItem scenario, ScriptInvokerBool onFavoritesResponse=null)
 
override void OnMenuOpen (SCR_ConfigurableDialogUiPreset preset)
 OVERRIDES.
 
override void OnMenuClose ()
 
override void OnButtonPressed (SCR_InputButtonComponent button)
 
override SCR_InputButtonComponent CreateButton (SCR_ConfigurableDialogUiButtonPreset buttonPreset)
 
MissionWorkshopItem GetScenario ()
 PUBLIC.
 
ScriptInvokerMissionWorkshopItem 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 FillSaveDetails ()
 PROTECTED.
 
- Protected Member Functions inherited from SCR_ScenarioConfirmationDialogUi
void OnCommStatusCheckFinished (SCR_ECommStatus status, float responseTime, float lastSuccessTime, float lastFailTime)
 PROTECTED.
 
void OnFavoritesButton ()
 
void UpdateFavoriteWidgets (bool isFavorite)
 
- 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

WorldSaveItem m_Save
 
- Protected Attributes inherited from SCR_ScenarioConfirmationDialogUi
SCR_InputButtonComponent m_Favorite
 
SCR_InputButtonComponent m_Host
 
SCR_InputButtonComponent m_FindServers
 
ref array< SCR_InputButtonComponentm_aRightFooterButtons = {}
 
SCR_ModularButtonComponent m_FavoriteStarButton
 
bool m_bHandleFavoriting = true
 If true, the dialog itself will set the scenario favorite state, otherwise it will live it to the menu or handler class.
 
ref ScriptInvokerMissionWorkshopItem 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_InputButtonComponentm_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
 

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_ScenarioConfirmationDialogUi
MissionWorkshopItem m_Scenario
 
- 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.
 
- Static Protected Attributes inherited from SCR_ConfigurableDialogUi
static SCR_ConfigurableDialogUi m_CurrentDialog
 

Member Function Documentation

◆ FillSaveDetails()

void SCR_GMSaveDialog.FillSaveDetails ( )
protected

PROTECTED.

Update visuals

Content layout

Source addon

Star button

Favorites widgets update

◆ OnMenuOpen()

override void SCR_GMSaveDialog.OnMenuOpen ( SCR_ConfigurableDialogUiPreset  preset)

OVERRIDES.

Implements SCR_ScenarioConfirmationDialogUi.

◆ SetSave()

void SCR_GMSaveDialog.SetSave ( WorldSaveItem  save)

PUBLIC.

Member Data Documentation

◆ m_Save

WorldSaveItem SCR_GMSaveDialog.m_Save
protected

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