Arma Reforger:Workbench Plugin Tutorial - Revision history

Lou Montana: Update from ModifyEntityKey to SetVariableValue and angleXYZ to angles

2026-01-03T11:18:25Z

Update from ModifyEntityKey to SetVariableValue and angleXYZ to angles

Lou Montana: Text replacement - "\{\{GameCategory\|armaR\|Modding\|(Guidelines|Tutorials)\|([^=↵]*)\}\}" to "{{GameCategory|armaR|Modding|$2|$1}}"

2025-02-26T12:31:51Z

Text replacement - "\{\{GameCategory\|armaR\|Modding\|(Guidelines|Tutorials)\|([^=↵]*)\}\}" to "{{GameCategory|armaR|Modding|$2|$1}}"

← Older revision		Revision as of 14:31, 26 February 2025
Line 982:		Line 982:


	{{GameCategory\|armaR\|Modding~~\|Tutorials~~\|Scripting\|Workbench}}		{{GameCategory\|armaR\|Modding\|Scripting\|Workbench\|Tutorials}}

Reyhard at 10:30, 5 June 2024

2024-06-05T10:30:24Z

← Older revision		Revision as of 12:30, 5 June 2024
Line 395:		Line 395:
	// Get list of currently selected resources		// Get list of currently selected resources
	array<ResourceName> selection = {};		array<ResourceName> selection = {};
	~~SCR_WorkbenchSearchResourcesCallbackArray context = new SCR_WorkbenchSearchResourcesCallbackArray(selection);~~		resourceManager.GetResourceBrowserSelection(selection .Insert, true);
	resourceManager.GetResourceBrowserSelection(~~context~~.Insert, true);

	// Verify if something is selected - if no, exit method & print error message		// Verify if something is selected - if no, exit method & print error message

Lou Montana: Text replacement - "ized" to "ised"

2024-05-24T20:07:48Z

Text replacement - "ized" to "ised"

← Older revision		Revision as of 22:07, 24 May 2024
Line 20:		Line 20:
	== Editor Plugins ==		== Editor Plugins ==

	Plugin can be located in top toolbar in "Plugins" section '''(1)'''. From there, you can either select one of the already existing plugins '''(3)''' or change their settings in Settings sub menu '''(2)'''. Plugins can be also ~~organized~~ in submenus '''(4)''', so you can conveniently gather multiple plugins.		Plugin can be located in top toolbar in "Plugins" section '''(1)'''. From there, you can either select one of the already existing plugins '''(3)''' or change their settings in Settings sub menu '''(2)'''. Plugins can be also organised in submenus '''(4)''', so you can conveniently gather multiple plugins.

	[[Image:armareforger-workbench-plugin-category-usage.png]]		[[Image:armareforger-workbench-plugin-category-usage.png]]
Line 78:		Line 78:
	'''At minimum''', new plugin needs to inherit from '''WorkbenchPlugin''' class. This class offers you ability to define behaviour of the plugin when it's '''launched''' ''(either by clicking on it or by CLI parameter)'' or when its '''settings are being changed'''.		'''At minimum''', new plugin needs to inherit from '''WorkbenchPlugin''' class. This class offers you ability to define behaviour of the plugin when it's '''launched''' ''(either by clicking on it or by CLI parameter)'' or when its '''settings are being changed'''.

	There are also few more ~~specialized~~ variants of '''WorkbenchPlugin''' class, which exposes additional API, like:		There are also few more specialised variants of '''WorkbenchPlugin''' class, which exposes additional API, like:

	* '''ResourceManagerPlugin'''		* '''ResourceManagerPlugin'''

Lou Montana: Fix category

2024-05-06T14:23:24Z

Fix category

← Older revision		Revision as of 16:23, 6 May 2024
Line 983:		Line 983:


	{{GameCategory\|armaR\|Modding\|Tutorials\|~~Official Tools~~}}		{{GameCategory\|armaR\|Modding\|Tutorials\|Scripting\|Workbench}}

Lou Montana: Some wiki formatting

2023-06-19T16:37:21Z

Some wiki formatting

← Older revision		Revision as of 18:37, 19 June 2023
Line 118:		Line 118:
	=== Workbench Attribute ===		=== Workbench Attribute ===

	'''WorkbenchPluginAttribute''' defines how & where the plugin is going to be visible. We already have display name defined via '''name''' attribute & '''wbModules''' parameter to show this plugin only in '''Resource Manager'''. There are few more attributes which are quite handy when developing plugins.		'''WorkbenchPluginAttribute''' defines how & where the plugin is going to be visible. We already have display name defined ''via'' '''name''' attribute & '''wbModules''' parameter to show this plugin only in '''Resource Manager'''. There are few more attributes which are quite handy when developing plugins.

	{{Feature\|informative\|		{{Feature\|informative\|
Line 231:		Line 231:
	* Space is added after each capital letter		* Space is added after each capital letter

	{{hl\|m_bCopyToClipboard}} will then be displayed as {{hl\|Copy to Clipboard}}.		{{hl\|m_bCopyToClipboard}} will then be displayed as {{hl\|Copy To Clipboard}}.
	}}		}}

Line 446:		Line 446:
	O:\PathToReforger\ArmaReforgerWorkbenchSteam.exe -wbmodule=ResourceManager -plugin=SampleResourceManagerPlugin		O:\PathToReforger\ArmaReforgerWorkbenchSteam.exe -wbmodule=ResourceManager -plugin=SampleResourceManagerPlugin

	Furthermore, you can also read custom command line parameters which are passed to the Workbench via '''GetCmdLine''' method! To do so, add additional parameter in your shortcut after '''-plugin=SampleResourceManagerPlugin''' (see [[Arma Reforger:Startup Parameters\|Startup Parameters]]).		Furthermore, you can also read custom command line parameters which are passed to the Workbench ''via'' '''GetCmdLine''' method! To do so, add additional parameter in your shortcut after '''-plugin=SampleResourceManagerPlugin''' (see [[Arma Reforger:Startup Parameters\|Startup Parameters]]).

	O:\PathToReforger\ArmaReforgerWorkbenchSteam.exe -wbmodule=ResourceManager -plugin=SampleResourceManagerPlugin -myParameter="$ArmaReforger:Prefabs\Vehicles"		O:\PathToReforger\ArmaReforgerWorkbenchSteam.exe -wbmodule=ResourceManager -plugin=SampleResourceManagerPlugin -myParameter="$ArmaReforger:Prefabs\Vehicles"
Line 766:		Line 766:
	* Usage of '''WorkbenchToolAttribute''' (which shares available parameters with plugin - see Workbench Attribute) to expose it to '''World Editor'''		* Usage of '''WorkbenchToolAttribute''' (which shares available parameters with plugin - see Workbench Attribute) to expose it to '''World Editor'''
	* Inheritance from '''WorldEditorTool''' class, which has different pool of methods available compared to plugins		* Inheritance from '''WorldEditorTool''' class, which has different pool of methods available compared to plugins
	* They cannot be launched via CLI parameter		* They cannot be launched ''via'' CLI parameter
	* They can use description parameter '''(2)'''		* They can use description parameter '''(2)'''
	* They are not grouped in categories like plugins, therefore category parameter is not relevant for them		* They are not grouped in categories like plugins, therefore category parameter is not relevant for them
Line 785:		Line 785:
	=== Using World Editor API ===		=== Using World Editor API ===

	When performing any operations to entities, you need to call '''BeginEntityAction''', which marks start of logical edit actions. Use m_API.'''EndEntityAction'''(); to mark end of edit actions. All transformations between '''BeginEntityAction & EndEntityAction''' are used by '''World Editor''' history stack - such actions can be reverted by user either via '''Undo last action''' button or shortcut (Ctrl+Z).		When performing any operations to entities, you need to call '''BeginEntityAction''', which marks start of logical edit actions. Use m_API.'''EndEntityAction'''(); to mark end of edit actions.
			All transformations between '''BeginEntityAction & EndEntityAction''' are used by '''World Editor''' history stack - such actions can be reverted by user either ''via'' '''Undo last action''' button or shortcut ({{Controls\|Ctrl\|Z}}).

	In below example code is creating a new entity and applies random scale to it.		In below example code is creating a new entity and applies random scale to it.
Line 857:		Line 858:
	// Delete all entities created by this tool		// Delete all entities created by this tool
	m_API.BeginEntityAction("Changing scale of entities");		m_API.BeginEntityAction("Changing scale of entities");
	foreach (~~int currentIndex,~~ IEntity entity : m_aEntities)		foreach (IEntity entity : m_aEntities)
	{		{
	m_API.ModifyEntityKey(entity, "scale", Math.RandomFloat(0.5, 2).ToString());		m_API.ModifyEntityKey(entity, "scale", Math.RandomFloat(0.5, 2).ToString());

Lou Montana: Remove after class' semicolons

2023-05-19T10:42:49Z

Remove after class' semicolons

← Older revision		Revision as of 12:42, 19 May 2023
Line 423:		Line 423:
	}		}
	}		}
	};		}
	</enforce>		</enforce>
	</spoiler>		</spoiler>
Line 642:		Line 642:
	super.Run();		super.Run();
	}		}
	};		}
	</enforce>		</enforce>
	</spoiler>		</spoiler>
Line 691:		Line 691:
	System.ExportToClipboard(file);		System.ExportToClipboard(file);
	}		}
	};		}
	</enforce>		</enforce>

Line 754:		Line 754:
	Print(selectedEntitiesCount);		Print(selectedEntitiesCount);
	}		}
	};		}
	</enforce>		</enforce>

Line 780:		Line 780:
	class SampleWorldEditorTool : WorldEditorTool		class SampleWorldEditorTool : WorldEditorTool
	{		{
	};		}
	</enforce>		</enforce>

Line 977:		Line 977:
	m_aEntities = null;		m_aEntities = null;
	}		}
	};		}
	</enforce>		</enforce>
	</spoiler>		</spoiler>

Lou Montana: Fix typo, Fix code examples

2023-01-26T15:18:21Z

Fix typo, Fix code examples

Show changes

Lou Montana: Fix typo

2023-01-26T14:41:37Z

Fix typo

← Older revision		Revision as of 16:41, 26 January 2023
Line 84:		Line 84:
	* '''LocalizationEditorPlugin'''		* '''LocalizationEditorPlugin'''

	Let's start with '''SampleResourceManagerPlugin.c''' and try to create some minimum code for new ~~Wokrbench~~ plugin which is visible in Resource Manager plugins tab.		Let's start with '''SampleResourceManagerPlugin.c''' and try to create some minimum code for new Workbench plugin which is visible in Resource Manager plugins tab.

	One of the requirements was already listed above but let's summarize all ingredients necessary to create a new plugin:		One of the requirements was already listed above but let's summarize all ingredients necessary to create a new plugin:

Lou Montana: Text replacement - "ArmaReforgerWorkbench.exe" to "ArmaReforgerWorkbenchSteam.exe"

2022-09-14T13:25:39Z

Text replacement - "ArmaReforgerWorkbench.exe" to "ArmaReforgerWorkbenchSteam.exe"

← Older revision		Revision as of 15:25, 14 September 2022
Line 440:		Line 440:

	To do so, first specify in '''wbModule''' name of the module which plugin relays on (in this case its '''ResourceManager''') and then type name of the plugin in '''-plugin''' parameter.		To do so, first specify in '''wbModule''' name of the module which plugin relays on (in this case its '''ResourceManager''') and then type name of the plugin in '''-plugin''' parameter.
	O:\PathToReforger\~~ArmaReforgerWorkbench~~.exe -wbmodule=ResourceManager -plugin=SampleResourceManagerPlugin		O:\PathToReforger\ArmaReforgerWorkbenchSteam.exe -wbmodule=ResourceManager -plugin=SampleResourceManagerPlugin

	Furthermore, you can also read custom command line parameters which are passed to the Workbench via '''GetCmdLine''' method! To do so, add additional parameter in your shortcut after '''-plugin=SampleResourceManagerPlugin''' (see [[Arma Reforger:Startup Parameters\|Startup Parameters]]).		Furthermore, you can also read custom command line parameters which are passed to the Workbench via '''GetCmdLine''' method! To do so, add additional parameter in your shortcut after '''-plugin=SampleResourceManagerPlugin''' (see [[Arma Reforger:Startup Parameters\|Startup Parameters]]).

	O:\PathToReforger\~~ArmaReforgerWorkbench~~.exe -wbmodule=ResourceManager -plugin=SampleResourceManagerPlugin -myParameter="$ArmaReforger:Prefabs\Vehicles"		O:\PathToReforger\ArmaReforgerWorkbenchSteam.exe -wbmodule=ResourceManager -plugin=SampleResourceManagerPlugin -myParameter="$ArmaReforger:Prefabs\Vehicles"

	After that, you can fetch '''myParameter''' from the script via the {{hl\|GetCmdLine()}} method.		After that, you can fetch '''myParameter''' from the script via the {{hl\|GetCmdLine()}} method.