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

This class will take care of handling all room mods & dependencies Receiveing, sorting, downloading. More...

Public Member Functions

ScriptInvokerRoom GetOnGetAllDependencies ()
 
ScriptInvokerRoom GetOnGetScenario ()
 
ScriptInvokerVoid GetOnModsFail ()
 
ScriptInvokerBase< ScriptInvoker_RoomModsDependencies > GetOnDependenciesLoadingPrevented ()
 
void Clear ()
 
void ReceiveRoomMods (notnull Room room)
 Getting all mods for selected room Checkign dependencies and loading workshop items of mods

 
void ReceiveRoomScenario (notnull Room room)
 
SCR_ReportedAddonsDialog DisplayRestrictedAddonsList ()
 Show restricted addons and return true if there are restricted addons in room content.
 
array< ref SCR_WorkshopItemGetCollidingDependencies ()
 
string GetModListSizeString (array< ref SCR_WorkshopItem > items)
 
float GetModsSize (array< ref SCR_WorkshopItem > items)
 
string GetModListPatchSizeString (array< ref SCR_WorkshopItem > items)
 Get size with unit based on pach sizes from addons list.
 
float GetModListPatchSize (array< ref SCR_WorkshopItem > items)
 
bool HasBlockedMods ()
 
array< ref SCR_WorkshopItemGetRoomItemsScripted ()
 
array< ref SCR_WorkshopItemGetRoomItemsUpdated ()
 
array< ref SCR_WorkshopItemGetRoomItemsToUpdate ()
 
bool GetModsMatching ()
 

Protected Member Functions

void OnLoadingModsFail (Room room)
 Invoke mods loading error.
 
void UpdatedDependencies (notnull array< ref SCR_WorkshopItem > items)
 Return only all updated dependecies from dependencies param Save all up to date to give out reference array Save all up missing or outdate to out reference array

 
void AllItemsLoaded ()
 
void LoadScenario ()
 Call this when sceario is loaded.
 
void OnAllReportsCanceled (SCR_ReportedAddonsDialog dialog)
 Call when all reports from dialog are cancled to clear invoker actions and display download dialog.
 
void OnScenarioModLoaded ()
 Call this when mod containing scenario is loaded

 
void OnScenarioDetails ()
 Call this when scenario has got complete info.
 
void OnRoomCallbackResponse (SCR_BackendCallbackRoomMods callback)
 
void OnRoomFullList ()
 Call this when room receive list of all mod dependencies.
 
void InitDownloadSequence ()
 
void OnDownloadSequenceReady (SCR_DownloadSequence sequence)
 
void OnDependenciesLoadingPrevented (SCR_DownloadSequence sequence, array< ref SCR_WorkshopItem > dependencies)
 Callback when any of depeendencies are preventing loading or donwloading Show dialog to cancel downloads blocking loading details.
 
void OnCancelDownloadConfirm (SCR_ConfigurableDialogUi dialog)
 
void OnCancelDownloadDialogClose (SCR_ConfigurableDialogUi dialog)
 
void OnDownloadSequenceError (SCR_DownloadSequence sequence)
 
void OnDownloadSequenceRestrictedAddons (SCR_DownloadSequence sequence, array< ref SCR_WorkshopItem > items)
 

Protected Attributes

Room m_Room
 
Dependency m_ScenarioDependency
 
ref SCR_DownloadSequence m_DownloadSequence
 
bool m_bModsMatching = false
 
bool m_bBlockedMods
 
ref array< ref SCR_WorkshopItemm_aCollidingDependencies = {}
 
ref array< ref SCR_WorkshopItemm_aRoomItemsScripted = {}
 
ref array< ref SCR_WorkshopItemm_aItemsUpdated = {}
 
ref array< ref SCR_WorkshopItemm_aItemsToUpdate = {}
 
ref SCR_BackendCallbackRoomMods m_ModsCallback
 
ref ScriptInvokerRoom m_OnGetAllDependencies = new ScriptInvokerRoom()
 
ref ScriptInvokerRoom m_OnGetScenario = new ScriptInvokerRoom()
 
ref ScriptInvokerVoid m_OnModsFail
 
ref ScriptInvokerBase< ScriptInvoker_RoomModsDependencies > m_OnDependenciesLoadingPrevented
 

Detailed Description

This class will take care of handling all room mods & dependencies Receiveing, sorting, downloading.

Member Function Documentation

◆ AllItemsLoaded()

void SCR_RoomModsManager.AllItemsLoaded ( )
protected

◆ Clear()

void SCR_RoomModsManager.Clear ( )

◆ DisplayRestrictedAddonsList()

SCR_ReportedAddonsDialog SCR_RoomModsManager.DisplayRestrictedAddonsList ( )

Show restricted addons and return true if there are restricted addons in room content.

◆ GetCollidingDependencies()

array< ref SCR_WorkshopItem > SCR_RoomModsManager.GetCollidingDependencies ( )

◆ GetModListPatchSize()

float SCR_RoomModsManager.GetModListPatchSize ( array< ref SCR_WorkshopItem > items)

◆ GetModListPatchSizeString()

string SCR_RoomModsManager.GetModListPatchSizeString ( array< ref SCR_WorkshopItem > items)

Get size with unit based on pach sizes from addons list.

◆ GetModListSizeString()

string SCR_RoomModsManager.GetModListSizeString ( array< ref SCR_WorkshopItem > items)

◆ GetModsMatching()

bool SCR_RoomModsManager.GetModsMatching ( )

◆ GetModsSize()

float SCR_RoomModsManager.GetModsSize ( array< ref SCR_WorkshopItem > items)

◆ GetOnDependenciesLoadingPrevented()

ScriptInvokerBase< ScriptInvoker_RoomModsDependencies > SCR_RoomModsManager.GetOnDependenciesLoadingPrevented ( )

◆ GetOnGetAllDependencies()

ScriptInvokerRoom SCR_RoomModsManager.GetOnGetAllDependencies ( )

◆ GetOnGetScenario()

ScriptInvokerRoom SCR_RoomModsManager.GetOnGetScenario ( )

◆ GetOnModsFail()

ScriptInvokerVoid SCR_RoomModsManager.GetOnModsFail ( )

◆ GetRoomItemsScripted()

array< ref SCR_WorkshopItem > SCR_RoomModsManager.GetRoomItemsScripted ( )

◆ GetRoomItemsToUpdate()

array< ref SCR_WorkshopItem > SCR_RoomModsManager.GetRoomItemsToUpdate ( )

◆ GetRoomItemsUpdated()

array< ref SCR_WorkshopItem > SCR_RoomModsManager.GetRoomItemsUpdated ( )

◆ HasBlockedMods()

bool SCR_RoomModsManager.HasBlockedMods ( )

◆ InitDownloadSequence()

void SCR_RoomModsManager.InitDownloadSequence ( )
protected

◆ LoadScenario()

void SCR_RoomModsManager.LoadScenario ( )
protected

Call this when sceario is loaded.

◆ OnAllReportsCanceled()

void SCR_RoomModsManager.OnAllReportsCanceled ( SCR_ReportedAddonsDialog dialog)
protected

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

◆ OnCancelDownloadConfirm()

void SCR_RoomModsManager.OnCancelDownloadConfirm ( SCR_ConfigurableDialogUi dialog)
protected

◆ OnCancelDownloadDialogClose()

void SCR_RoomModsManager.OnCancelDownloadDialogClose ( SCR_ConfigurableDialogUi dialog)
protected

◆ OnDependenciesLoadingPrevented()

void SCR_RoomModsManager.OnDependenciesLoadingPrevented ( SCR_DownloadSequence sequence,
array< ref SCR_WorkshopItem > dependencies )
protected

Callback when any of depeendencies are preventing loading or donwloading Show dialog to cancel downloads blocking loading details.

◆ OnDownloadSequenceError()

void SCR_RoomModsManager.OnDownloadSequenceError ( SCR_DownloadSequence sequence)
protected

◆ OnDownloadSequenceReady()

void SCR_RoomModsManager.OnDownloadSequenceReady ( SCR_DownloadSequence sequence)
protected

◆ OnDownloadSequenceRestrictedAddons()

void SCR_RoomModsManager.OnDownloadSequenceRestrictedAddons ( SCR_DownloadSequence sequence,
array< ref SCR_WorkshopItem > items )
protected

◆ OnLoadingModsFail()

void SCR_RoomModsManager.OnLoadingModsFail ( Room room)
protected

Invoke mods loading error.

◆ OnRoomCallbackResponse()

void SCR_RoomModsManager.OnRoomCallbackResponse ( SCR_BackendCallbackRoomMods callback)
protected

◆ OnRoomFullList()

void SCR_RoomModsManager.OnRoomFullList ( )
protected

Call this when room receive list of all mod dependencies.

◆ OnScenarioDetails()

void SCR_RoomModsManager.OnScenarioDetails ( )
protected

Call this when scenario has got complete info.

◆ OnScenarioModLoaded()

void SCR_RoomModsManager.OnScenarioModLoaded ( )
protected

Call this when mod containing scenario is loaded

◆ ReceiveRoomMods()

void SCR_RoomModsManager.ReceiveRoomMods ( notnull Room room)

Getting all mods for selected room Checkign dependencies and loading workshop items of mods

◆ ReceiveRoomScenario()

void SCR_RoomModsManager.ReceiveRoomScenario ( notnull Room room)

◆ UpdatedDependencies()

void SCR_RoomModsManager.UpdatedDependencies ( notnull array< ref SCR_WorkshopItem > items)
protected

Return only all updated dependecies from dependencies param Save all up to date to give out reference array Save all up missing or outdate to out reference array

Member Data Documentation

◆ m_aCollidingDependencies

ref array<ref SCR_WorkshopItem> SCR_RoomModsManager.m_aCollidingDependencies = {}
protected

◆ m_aItemsToUpdate

ref array<ref SCR_WorkshopItem> SCR_RoomModsManager.m_aItemsToUpdate = {}
protected

◆ m_aItemsUpdated

ref array<ref SCR_WorkshopItem> SCR_RoomModsManager.m_aItemsUpdated = {}
protected

◆ m_aRoomItemsScripted

ref array<ref SCR_WorkshopItem> SCR_RoomModsManager.m_aRoomItemsScripted = {}
protected

◆ m_bBlockedMods

bool SCR_RoomModsManager.m_bBlockedMods
protected

◆ m_bModsMatching

bool SCR_RoomModsManager.m_bModsMatching = false
protected

◆ m_DownloadSequence

ref SCR_DownloadSequence SCR_RoomModsManager.m_DownloadSequence
protected

◆ m_ModsCallback

ref SCR_BackendCallbackRoomMods SCR_RoomModsManager.m_ModsCallback
protected

◆ m_OnDependenciesLoadingPrevented

ref ScriptInvokerBase<ScriptInvoker_RoomModsDependencies> SCR_RoomModsManager.m_OnDependenciesLoadingPrevented
protected

◆ m_OnGetAllDependencies

ref ScriptInvokerRoom SCR_RoomModsManager.m_OnGetAllDependencies = new ScriptInvokerRoom()
protected

◆ m_OnGetScenario

ref ScriptInvokerRoom SCR_RoomModsManager.m_OnGetScenario = new ScriptInvokerRoom()
protected

◆ m_OnModsFail

ref ScriptInvokerVoid SCR_RoomModsManager.m_OnModsFail
protected

◆ m_Room

Room SCR_RoomModsManager.m_Room
protected

◆ m_ScenarioDependency

Dependency SCR_RoomModsManager.m_ScenarioDependency
protected

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