Workbench Interface Reference

Static Public Member Functions
static proto WBModuleDef	GetModule (TypeName type)
static proto bool	OpenModule (TypeName type)
static proto bool	CloseModule (TypeName type)
static proto void	Dialog (string caption, string text, string detailedText=string.Empty)
static proto int	ScriptDialog (string caption, string text, Class data)
static proto bool	SearchResources (WorkbenchSearchResourcesCallback callback, array< string > fileExtensions=null, array< string > searchStrArray=null, string rootPath=string.Empty, bool recursive=true)
	Search for all resources by filer and call callback method for each. rootPath must be in "exact path" format e.g. "$addonName:Prefabs".
static proto int	RunCmd (string command, bool wait=false)
static proto ProcessHandle	RunProcess (string command)
	Attempts to start up a process with given CLI command.
static proto bool	KillProcess (ProcessHandle handle)
	Attempts to kill the process of given handle.
static proto bool	IsRunningProcess (ProcessHandle handle)
	Queries the active flag on the process handle.
static proto int	WaitProcess (ProcessHandle handle, int timeout=-1)
	Waits for the process to complete.
static proto void	FinishProcess (ProcessHandle handle)
	Closes the process handle.
static proto void	GetCwd (out string currentDir)
static proto void	GetUserName (out string userName)
static proto bool	GetAbsolutePath (string relativePath, out string absPath, bool mustExist=true)
static proto void	GetExecutableFilePath (out string filePath)
static proto string	GetCurrentGameProjectFile ()
	Returns absolute path to game project settings.
static proto BaseContainer	GetGameProjectSettings ()
	Returns game project settings.
static proto string	GenerateGloballyUniqueID64 ()
static proto void	Exit (int exitCode)
static proto DateTimeUtcAsInt	GetPackedUtcTime ()
static proto ResourceName	GetResourceName (string path)
static proto bool	OpenResource (string filename)
static proto ref ScriptModule	GetWBScriptModule ()
static proto ref ScriptModule	GetWBGameScriptModule ()
static proto bool	SavePixelRawData (string fileName, PixelRawData data, int width, int height, int stride)
	Saves PixelRawData into specified path in PNG format.

Member Function Documentation

CloseModule()

static proto bool Workbench.CloseModule ( TypeName type )

static

Dialog()

static proto void Workbench.Dialog ( string caption, string text, string detailedText = string.Empty )

static

Exit()

static proto void Workbench.Exit ( int exitCode )

static

FinishProcess()

static proto void Workbench.FinishProcess ( ProcessHandle handle )

static

Closes the process handle.

GenerateGloballyUniqueID64()

static proto string Workbench.GenerateGloballyUniqueID64 ( )

static

GetAbsolutePath()

static proto bool Workbench.GetAbsolutePath ( string relativePath, out string absPath, bool mustExist = true )

static

GetCurrentGameProjectFile()

static proto string Workbench.GetCurrentGameProjectFile ( )

static

Returns absolute path to game project settings.

GetCwd()

static proto void Workbench.GetCwd ( out string currentDir )

static

GetExecutableFilePath()

static proto void Workbench.GetExecutableFilePath ( out string filePath )

static

GetGameProjectSettings()

static proto BaseContainer Workbench.GetGameProjectSettings ( )

static

Returns game project settings.

GetModule()

static proto WBModuleDef Workbench.GetModule ( TypeName type )

static

GetPackedUtcTime()

static proto DateTimeUtcAsInt Workbench.GetPackedUtcTime ( )

static

GetResourceName()

static proto ResourceName Workbench.GetResourceName ( string path )

static

GetUserName()

static proto void Workbench.GetUserName ( out string userName )

static

GetWBGameScriptModule()

static proto ref ScriptModule Workbench.GetWBGameScriptModule ( )

static

GetWBScriptModule()

static proto ref ScriptModule Workbench.GetWBScriptModule ( )

static

IsRunningProcess()

static proto bool Workbench.IsRunningProcess ( ProcessHandle handle )

static

Queries the active flag on the process handle.

KillProcess()

static proto bool Workbench.KillProcess ( ProcessHandle handle )

static

Attempts to kill the process of given handle.

Closes the handle. Returns true when the process really transitioned from running to closed state.

OpenModule()

static proto bool Workbench.OpenModule ( TypeName type )

static

OpenResource()

static proto bool Workbench.OpenResource ( string filename )

static

RunCmd()

static proto int Workbench.RunCmd ( string command, bool wait = false )

static

RunProcess()

static proto ProcessHandle Workbench.RunProcess ( string command )

static

Attempts to start up a process with given CLI command.

Returns process handle.

SavePixelRawData()

static proto bool Workbench.SavePixelRawData ( string fileName, PixelRawData data, int width, int height, int stride )

static

Saves PixelRawData into specified path in PNG format.

Parameters

fileName	Name where to save data
data	which data to save
width	width of data
height	height of data
stride	byte size between two rows of data

ScriptDialog()

static proto int Workbench.ScriptDialog ( string caption, string text, Class data )

static

SearchResources()

static proto bool Workbench.SearchResources ( WorkbenchSearchResourcesCallback callback, array< string > fileExtensions = null, array< string > searchStrArray = null, string rootPath = string.Empty, bool recursive = true )

static

Search for all resources by filer and call callback method for each. rootPath must be in "exact path" format e.g. "$addonName:Prefabs".

WaitProcess()

static proto int Workbench.WaitProcess ( ProcessHandle handle, int timeout = -1 )

static

Waits for the process to complete.

Takes timeout value in milliseconds.

---

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

• Core/generated/WorkbenchAPI/Workbench.c