Arma Reforger Script API
Loading...
Searching...
No Matches
SCR_ScenarioUICommon Interface Reference

Static Public Member Functions

static void TryPlayScenario (MissionWorkshopItem scenario)
 Starts the mission or opens a confirmation dialog if it can't be immediately started.
 
static void TryHostScenario (notnull MissionWorkshopItem scenario, notnull SCR_DSConfig config)
 Hosts the scenario or opens a confirmation dialog if it can't be immediately started.
 
static bool HasSave (MissionWorkshopItem mission)
 
static bool LoadSave (MissionWorkshopItem scenario, SCR_MissionHeader header, ChimeraMenuPreset startMenu)
 
static bool IsMultiplayer (MissionWorkshopItem mission)
 
static bool IsReady (MissionWorkshopItem mission)
 
static bool IsEnabled (MissionWorkshopItem mission)
 
static bool IsAddonDownloaded (MissionWorkshopItem mission)
 
static bool IsMissingDependencies (MissionWorkshopItem mission)
 
static bool AreDependenciesAvailable (MissionWorkshopItem mission)
 
static SCR_ERevisionAvailability GetOwnerRevisionAvailability (MissionWorkshopItem mission)
 
static bool IsOwnerRestricted (MissionWorkshopItem mission)
 
static bool CanPlay (MissionWorkshopItem mission)
 
static bool CanJoin (MissionWorkshopItem mission)
 
static bool CanHost (MissionWorkshopItem mission)
 
static MissionWorkshopItem GetInGameScenario (ResourceName resource)
 
static void UpdatePlayMouseButton (SCR_ModularButtonComponent button, MissionWorkshopItem mission, bool entryFocused, bool visible=true)
 
static void UpdatePlaySaveMouseButton (SCR_ModularButtonComponent button, WorldSaveItem save, bool entryFocused, bool visible=true)
 
static void UpdateContinueMouseButton (SCR_ModularButtonComponent button, MissionWorkshopItem mission, bool entryFocused, bool visible=true)
 
static void UpdateRestartMouseButton (SCR_ModularButtonComponent button, MissionWorkshopItem mission, bool entryFocused, bool visible=true)
 
static void UpdatePlayMouseButtonTooltip (SCR_ScriptedWidgetTooltip tooltip, MissionWorkshopItem mission)
 
static void UpdatePlayInputButton (SCR_InputButtonComponent button, MissionWorkshopItem mission, bool visible=true)
 
static void UpdateContinueInputButton (SCR_InputButtonComponent button, MissionWorkshopItem mission, bool visible=true)
 
static void UpdateRestartInputButton (SCR_InputButtonComponent button, MissionWorkshopItem mission, bool visible=true)
 
static void UpdateJoinMouseButton (SCR_ModularButtonComponent button, MissionWorkshopItem mission, bool entryFocused, bool visible=true)
 
static void UpdateJoinMouseButtonTooltip (SCR_ScriptedWidgetTooltip tooltip, MissionWorkshopItem mission)
 
static void UpdateJoinInputButton (SCR_InputButtonComponent button, MissionWorkshopItem mission, bool visible=true)
 
static void UpdateHostMouseButton (SCR_ModularButtonComponent button, MissionWorkshopItem mission, bool entryFocused, bool visible=true)
 
static void UpdateHostMouseButtonTooltip (SCR_ScriptedWidgetTooltip tooltip, MissionWorkshopItem mission)
 
static void UpdateHostInputButton (SCR_InputButtonComponent button, MissionWorkshopItem mission, bool visible=true)
 
static void UpdateInputButtons (MissionWorkshopItem mission, array< SCR_InputButtonComponent > buttons, bool visible=true)
 
static void UpdateMouseButtonTooltips (SCR_ScriptedWidgetTooltip tooltip, MissionWorkshopItem mission)
 

Static Public Attributes

static const string BUTTON_PLAY = "Play"
 
static const string BUTTON_CONTINUE = "Continue"
 
static const string BUTTON_RESTART = "Restart"
 
static const string BUTTON_HOST = "Host"
 
static const string BUTTON_FIND_SERVERS = "FindServers"
 
static const string BUTTON_FAVORITE = "Favorite"
 
static const string BUTTON_SCENARIOS = "Scenarios"
 
static const string ACTION_RESTART = "MenuRestart"
 
static const string ACTION_FIND_SERVERS = "MenuJoin"
 
static const string ACTION_HOST = "MenuHost"
 
static const string ACTION_SERVER_DETAILS = "MenuServerDetails"
 
static const string DIALOG_RESTART = "scenario_restart"
 

Static Protected Member Functions

static SCR_EScenarioIssues GetPlayHighestPriorityIssue (MissionWorkshopItem mission)
 
static SCR_EScenarioIssues GetJoinHighestPriorityIssue (MissionWorkshopItem mission)
 
static SCR_EScenarioIssues GetHostHighestPriorityIssue (MissionWorkshopItem mission)
 
static string GetErrorTexture (SCR_EScenarioIssues issue, SCR_ERevisionAvailability availability)
 
static string GetErrorMessage (SCR_EScenarioIssues issue, SCR_ERevisionAvailability availability)
 
static void SetInputButtonEnabled (SCR_InputButtonComponent button, SCR_EScenarioIssues issue, SCR_ERevisionAvailability availability)
 
static void UpdateMouseButtonTooltip (SCR_ScriptedWidgetTooltip tooltip, SCR_EScenarioIssues issue, SCR_ERevisionAvailability availability)
 

Member Function Documentation

◆ AreDependenciesAvailable()

static bool SCR_ScenarioUICommon.AreDependenciesAvailable ( MissionWorkshopItem mission)
static

◆ CanHost()

static bool SCR_ScenarioUICommon.CanHost ( MissionWorkshopItem mission)
static

◆ CanJoin()

static bool SCR_ScenarioUICommon.CanJoin ( MissionWorkshopItem mission)
static

◆ CanPlay()

static bool SCR_ScenarioUICommon.CanPlay ( MissionWorkshopItem mission)
static

◆ GetErrorMessage()

static string SCR_ScenarioUICommon.GetErrorMessage ( SCR_EScenarioIssues issue,
SCR_ERevisionAvailability availability )
staticprotected

◆ GetErrorTexture()

static string SCR_ScenarioUICommon.GetErrorTexture ( SCR_EScenarioIssues issue,
SCR_ERevisionAvailability availability )
staticprotected

◆ GetHostHighestPriorityIssue()

static SCR_EScenarioIssues SCR_ScenarioUICommon.GetHostHighestPriorityIssue ( MissionWorkshopItem mission)
staticprotected

◆ GetInGameScenario()

static MissionWorkshopItem SCR_ScenarioUICommon.GetInGameScenario ( ResourceName resource)
static

◆ GetJoinHighestPriorityIssue()

static SCR_EScenarioIssues SCR_ScenarioUICommon.GetJoinHighestPriorityIssue ( MissionWorkshopItem mission)
staticprotected

◆ GetOwnerRevisionAvailability()

static SCR_ERevisionAvailability SCR_ScenarioUICommon.GetOwnerRevisionAvailability ( MissionWorkshopItem mission)
static

◆ GetPlayHighestPriorityIssue()

static SCR_EScenarioIssues SCR_ScenarioUICommon.GetPlayHighestPriorityIssue ( MissionWorkshopItem mission)
staticprotected

◆ HasSave()

static bool SCR_ScenarioUICommon.HasSave ( MissionWorkshopItem mission)
static

◆ IsAddonDownloaded()

static bool SCR_ScenarioUICommon.IsAddonDownloaded ( MissionWorkshopItem mission)
static

◆ IsEnabled()

static bool SCR_ScenarioUICommon.IsEnabled ( MissionWorkshopItem mission)
static

◆ IsMissingDependencies()

static bool SCR_ScenarioUICommon.IsMissingDependencies ( MissionWorkshopItem mission)
static

◆ IsMultiplayer()

static bool SCR_ScenarioUICommon.IsMultiplayer ( MissionWorkshopItem mission)
static

◆ IsOwnerRestricted()

static bool SCR_ScenarioUICommon.IsOwnerRestricted ( MissionWorkshopItem mission)
static

◆ IsReady()

static bool SCR_ScenarioUICommon.IsReady ( MissionWorkshopItem mission)
static

◆ LoadSave()

static bool SCR_ScenarioUICommon.LoadSave ( MissionWorkshopItem scenario,
SCR_MissionHeader header,
ChimeraMenuPreset startMenu )
static

◆ SetInputButtonEnabled()

static void SCR_ScenarioUICommon.SetInputButtonEnabled ( SCR_InputButtonComponent button,
SCR_EScenarioIssues issue,
SCR_ERevisionAvailability availability )
staticprotected

◆ TryHostScenario()

static void SCR_ScenarioUICommon.TryHostScenario ( notnull MissionWorkshopItem scenario,
notnull SCR_DSConfig config )
static

Hosts the scenario or opens a confirmation dialog if it can't be immediately started.

◆ TryPlayScenario()

static void SCR_ScenarioUICommon.TryPlayScenario ( MissionWorkshopItem scenario)
static

Starts the mission or opens a confirmation dialog if it can't be immediately started.

◆ UpdateContinueInputButton()

static void SCR_ScenarioUICommon.UpdateContinueInputButton ( SCR_InputButtonComponent button,
MissionWorkshopItem mission,
bool visible = true )
static

◆ UpdateContinueMouseButton()

static void SCR_ScenarioUICommon.UpdateContinueMouseButton ( SCR_ModularButtonComponent button,
MissionWorkshopItem mission,
bool entryFocused,
bool visible = true )
static

◆ UpdateHostInputButton()

static void SCR_ScenarioUICommon.UpdateHostInputButton ( SCR_InputButtonComponent button,
MissionWorkshopItem mission,
bool visible = true )
static

◆ UpdateHostMouseButton()

static void SCR_ScenarioUICommon.UpdateHostMouseButton ( SCR_ModularButtonComponent button,
MissionWorkshopItem mission,
bool entryFocused,
bool visible = true )
static

◆ UpdateHostMouseButtonTooltip()

static void SCR_ScenarioUICommon.UpdateHostMouseButtonTooltip ( SCR_ScriptedWidgetTooltip tooltip,
MissionWorkshopItem mission )
static

◆ UpdateInputButtons()

static void SCR_ScenarioUICommon.UpdateInputButtons ( MissionWorkshopItem mission,
array< SCR_InputButtonComponent > buttons,
bool visible = true )
static

◆ UpdateJoinInputButton()

static void SCR_ScenarioUICommon.UpdateJoinInputButton ( SCR_InputButtonComponent button,
MissionWorkshopItem mission,
bool visible = true )
static

◆ UpdateJoinMouseButton()

static void SCR_ScenarioUICommon.UpdateJoinMouseButton ( SCR_ModularButtonComponent button,
MissionWorkshopItem mission,
bool entryFocused,
bool visible = true )
static

◆ UpdateJoinMouseButtonTooltip()

static void SCR_ScenarioUICommon.UpdateJoinMouseButtonTooltip ( SCR_ScriptedWidgetTooltip tooltip,
MissionWorkshopItem mission )
static

◆ UpdateMouseButtonTooltip()

static void SCR_ScenarioUICommon.UpdateMouseButtonTooltip ( SCR_ScriptedWidgetTooltip tooltip,
SCR_EScenarioIssues issue,
SCR_ERevisionAvailability availability )
staticprotected

◆ UpdateMouseButtonTooltips()

static void SCR_ScenarioUICommon.UpdateMouseButtonTooltips ( SCR_ScriptedWidgetTooltip tooltip,
MissionWorkshopItem mission )
static

◆ UpdatePlayInputButton()

static void SCR_ScenarioUICommon.UpdatePlayInputButton ( SCR_InputButtonComponent button,
MissionWorkshopItem mission,
bool visible = true )
static

◆ UpdatePlayMouseButton()

static void SCR_ScenarioUICommon.UpdatePlayMouseButton ( SCR_ModularButtonComponent button,
MissionWorkshopItem mission,
bool entryFocused,
bool visible = true )
static

◆ UpdatePlayMouseButtonTooltip()

static void SCR_ScenarioUICommon.UpdatePlayMouseButtonTooltip ( SCR_ScriptedWidgetTooltip tooltip,
MissionWorkshopItem mission )
static

◆ UpdatePlaySaveMouseButton()

static void SCR_ScenarioUICommon.UpdatePlaySaveMouseButton ( SCR_ModularButtonComponent button,
WorldSaveItem save,
bool entryFocused,
bool visible = true )
static

◆ UpdateRestartInputButton()

static void SCR_ScenarioUICommon.UpdateRestartInputButton ( SCR_InputButtonComponent button,
MissionWorkshopItem mission,
bool visible = true )
static

◆ UpdateRestartMouseButton()

static void SCR_ScenarioUICommon.UpdateRestartMouseButton ( SCR_ModularButtonComponent button,
MissionWorkshopItem mission,
bool entryFocused,
bool visible = true )
static

Member Data Documentation

◆ ACTION_FIND_SERVERS

const string SCR_ScenarioUICommon.ACTION_FIND_SERVERS = "MenuJoin"
static

◆ ACTION_HOST

const string SCR_ScenarioUICommon.ACTION_HOST = "MenuHost"
static

◆ ACTION_RESTART

const string SCR_ScenarioUICommon.ACTION_RESTART = "MenuRestart"
static

◆ ACTION_SERVER_DETAILS

const string SCR_ScenarioUICommon.ACTION_SERVER_DETAILS = "MenuServerDetails"
static

◆ BUTTON_CONTINUE

const string SCR_ScenarioUICommon.BUTTON_CONTINUE = "Continue"
static

◆ BUTTON_FAVORITE

const string SCR_ScenarioUICommon.BUTTON_FAVORITE = "Favorite"
static

◆ BUTTON_FIND_SERVERS

const string SCR_ScenarioUICommon.BUTTON_FIND_SERVERS = "FindServers"
static

◆ BUTTON_HOST

const string SCR_ScenarioUICommon.BUTTON_HOST = "Host"
static

◆ BUTTON_PLAY

const string SCR_ScenarioUICommon.BUTTON_PLAY = "Play"
static

◆ BUTTON_RESTART

const string SCR_ScenarioUICommon.BUTTON_RESTART = "Restart"
static

◆ BUTTON_SCENARIOS

const string SCR_ScenarioUICommon.BUTTON_SCENARIOS = "Scenarios"
static

◆ DIALOG_RESTART

const string SCR_ScenarioUICommon.DIALOG_RESTART = "scenario_restart"
static

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