WorkbenchPluginAttribute Interface Reference

Attribute for Workbench plugin definition: More...

Inheritance diagram for WorkbenchPluginAttribute:

Public Member Functions
void	WorkbenchPluginAttribute (string name, string description="", string shortcut="", string icon="", array< string > wbModules=null, string category="", int awesomeFontCode=0, array< string > resourceTypes=null)

Public Attributes
string	m_Name
string	m_Icon
string	m_Shortcut
string	m_Description
string	m_Category
int	m_AwesomeFontCode
ref array< string >	m_WBModules
	https://fontawesome.com/cheatsheet/
ref array< string >	m_ResourceTypes

Detailed Description

Attribute for Workbench plugin definition:

• name - ui name in Script Tools menu
• description - tooltip
• shortcut - shortcut in simple text form e.g. "ctrl+g"
• icon - relative path to icon file (32x32 png)
• wbModules - list of strings representing Workbench modules where this tool should be avalaible (e.g. {"ResourceManager", "ScriptEditor"}). Leave null or empty array for any module.
• resourceTypes - list of resource types to offer this plugin in context menu (e.g. {"conf", "dds", "layout"})

Constructor & Destructor Documentation

WorkbenchPluginAttribute()

void WorkbenchPluginAttribute.WorkbenchPluginAttribute	(	string	name,
		string	description = "",
		string	shortcut = "",
		string	icon = "",
		array< string >	wbModules = null,
		string	category = "",
		int	awesomeFontCode = 0,
		array< string >	resourceTypes = null )

Member Data Documentation

m_AwesomeFontCode

int WorkbenchPluginAttribute.m_AwesomeFontCode

m_Category

string WorkbenchPluginAttribute.m_Category

m_Description

string WorkbenchPluginAttribute.m_Description

m_Icon

string WorkbenchPluginAttribute.m_Icon

m_Name

string WorkbenchPluginAttribute.m_Name

m_ResourceTypes

ref array<string> WorkbenchPluginAttribute.m_ResourceTypes

m_Shortcut

string WorkbenchPluginAttribute.m_Shortcut

m_WBModules

ref array<string> WorkbenchPluginAttribute.m_WBModules

https://fontawesome.com/cheatsheet/

---

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

• GameLib/workbench/workbench.c