SCR_WorkbenchHelper Interface Reference

Static Public Member Functions
static void	PrintDialog (string message, string caption="", LogLevel level=LogLevel.WARNING)
static void	PrintFormatDialog (string message, string param1, string param2="", string param3="", string caption="", LogLevel level=LogLevel.WARNING)
static array< ResourceName >	SearchWorkbenchResources (array< string > fileExtensions=null, array< string > searchStrArray=null, string rootPath="", bool recursive=true)
	Search Workbench-available files by extension and filters inside a provided directory Does NOT support unregistered files such as script files - use SearchWorkbenchFiles if needed.
static array< string >	SearchWorkbenchFiles (array< string > fileExtensions=null, array< string > searchStrArray=null, string rootPath="", bool recursive=true)
	Search Workbench-available files by extension and filters inside a provided directory Support unregistered files such as script files - use SearchWorkbenchResources if ResourceNames are needed.

Static Protected Member Functions
static bool	SearchResourcesCallbackMethod (ResourceName resourceName, string exactPath="")
	SearchResourcesCallback method used by SearchWorkbenchFiles to get file (relative) PATHS (not ResourceNames), e.g $Arma4:Scripts/Game/MyFile.c.

Static Protected Attributes
static ref array< string >	s_aTempStrings

Member Function Documentation

PrintDialog()

static void SCR_WorkbenchHelper.PrintDialog ( string message, string caption = "", LogLevel level = LogLevel::WARNING )

static

Parameters

[in]	message
[in]	caption

PrintFormatDialog()

static void SCR_WorkbenchHelper.PrintFormatDialog ( string message, string param1, string param2 = "", string param3 = "", string caption = "", LogLevel level = LogLevel::WARNING )

static

Parameters

[in]	message
[in]	param1
[in]	param2
[in]	param3
[in]	caption

SearchResourcesCallbackMethod()

static bool SCR_WorkbenchHelper.SearchResourcesCallbackMethod ( ResourceName resourceName, string exactPath = "" )

staticprotected

SearchResourcesCallback method used by SearchWorkbenchFiles to get file (relative) PATHS (not ResourceNames), e.g $Arma4:Scripts/Game/MyFile.c.

SearchWorkbenchFiles()

static array< string > SCR_WorkbenchHelper.SearchWorkbenchFiles ( array< string > fileExtensions = null, array< string > searchStrArray = null, string rootPath = "", bool recursive = true )

static

Search Workbench-available files by extension and filters inside a provided directory Support unregistered files such as script files - use SearchWorkbenchResources if ResourceNames are needed.

Parameters

[in]	fileExtensions
[in]	searchStrArray
[in]	rootPath	format $addon:Workbench/Directory
[in]	recursive

Returns

found file's relative paths (e.g $Arma4:Scripts/Game/MyFile.c)

SearchWorkbenchResources()

static array< ResourceName > SCR_WorkbenchHelper.SearchWorkbenchResources ( array< string > fileExtensions = null, array< string > searchStrArray = null, string rootPath = "", bool recursive = true )

static

Search Workbench-available files by extension and filters inside a provided directory Does NOT support unregistered files such as script files - use SearchWorkbenchFiles if needed.

Parameters

[in]	fileExtensions
[in]	searchStrArray
[in]	rootPath	format $addon:Workbench/Directory
[in]	recursive

Returns

found resources

Member Data Documentation

s_aTempStrings

ref array<string> SCR_WorkbenchHelper.s_aTempStrings

staticprotected

---

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

• WorkbenchGame/WorldEditor/Helpers/SCR_WorkbenchHelper.c