SCR_WorkbenchHelper Class Reference

Static Protected 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 int	PrintOKCancelDialog (string message, string caption="", LogLevel level=LogLevel.WARNING)
static array< ResourceName >	SearchWorkbenchResources (array< string > fileExtensions=null, array< string > searchStrArray=null, string rootPath="", bool recursive=true)
static array< string >	SearchWorkbenchFiles (array< string > fileExtensions=null, array< string > searchStrArray=null, string rootPath="", bool recursive=true)
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

Detailed Description

Definition at line 1 of file SCR_WorkbenchHelper.c.

Member Function Documentation

PrintDialog()

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

inlinestaticprotected

Parameters

[in]	message
[in]	caption
[in]	level

Definition at line 10 of file SCR_WorkbenchHelper.c.

PrintFormatDialog()

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

inlinestaticprotected

Parameters

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

Definition at line 24 of file SCR_WorkbenchHelper.c.

PrintOKCancelDialog()

int SCR_WorkbenchHelper::PrintOKCancelDialog ( string message, string caption = "", LogLevel level = LogLevel.WARNING )

inlinestaticprotected

Parameters

[in]	message
[in]	caption
[in]	level

Returns

Definition at line 37 of file SCR_WorkbenchHelper.c.

SearchResourcesCallbackMethod()

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

inlinestaticprotected

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

Definition at line 120 of file SCR_WorkbenchHelper.c.

SearchWorkbenchFiles()

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

inlinestaticprotected

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)

Definition at line 96 of file SCR_WorkbenchHelper.c.

SearchWorkbenchResources()

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

inlinestaticprotected

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

Definition at line 51 of file SCR_WorkbenchHelper.c.

Member Data Documentation

s_aTempStrings

ref array<string> SCR_WorkbenchHelper::s_aTempStrings

staticprotected

Definition at line 3 of file SCR_WorkbenchHelper.c.

---

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

• scripts/WorkbenchGame/WorldEditor/Helpers/SCR_WorkbenchHelper.c