Arma Reforger:Resource Manager Plugin - Revision history

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

2025-02-26T12:31:57Z

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

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


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

Lou Montana: Text replacement - "[[OFPEC_tags" to "[[Scripting Tags"

2024-10-02T11:01:40Z

Text replacement - "[[OFPEC_tags" to "[[Scripting Tags"

← Older revision		Revision as of 13:01, 2 October 2024
Line 8:		Line 8:

	* Open [[Arma_Reforger:Script_Editor\|Script Editor]]		* Open [[Arma_Reforger:Script_Editor\|Script Editor]]
	* In an addon, create a new script in {{hl\|WorkbenchGame/ResourceManager}} - name it {{hl\|[[~~OFPEC_tags~~\|TAG_]]TutorialPlugin.c}} (must end with {{hl\|Plugin}} by convention)		* In an addon, create a new script in {{hl\|WorkbenchGame/ResourceManager}} - name it {{hl\|[[Scripting Tags\|TAG_]]TutorialPlugin.c}} (must end with {{hl\|Plugin}} by convention)
	* Double-click the file to open it		* Double-click the file to open it
	* Press {{Controls\|Ctrl\|T}} to use the {{Link\|Arma Reforger:Script Editor: Fill From Template Plugin\|Script Template plugin}}		* Press {{Controls\|Ctrl\|T}} to use the {{Link\|Arma Reforger:Script Editor: Fill From Template Plugin\|Script Template plugin}}
Line 16:		Line 16:
	* In the <enforce inline>Run()</enforce> method, write <enforce inline>Print("It works!");</enforce> and save the file		* In the <enforce inline>Run()</enforce> method, write <enforce inline>Print("It works!");</enforce> and save the file
	* Reload Workbench scripts via '''Reload WB Scripts''' option located in ''Plugins→Settings'' menu (default shortcut: {{Controls\|Ctrl\|Shift\|R}})		* Reload Workbench scripts via '''Reload WB Scripts''' option located in ''Plugins→Settings'' menu (default shortcut: {{Controls\|Ctrl\|Shift\|R}})
	* The {{hl\|[[~~OFPEC_tags~~\|TAG_]]TutorialPlugin}} plugin should appear in the Resource Manager's Plugins list, available in the top bar - click on the plugin entry		* The {{hl\|[[Scripting Tags\|TAG_]]TutorialPlugin}} plugin should appear in the Resource Manager's Plugins list, available in the top bar - click on the plugin entry
	* "It works!" gets printed in the output console.		* "It works!" gets printed in the output console.

Lou Montana: Text replacement - "Script Template plugin" to "{{Link|Arma Reforger:Script Editor: Fill From Template Plugin|Script Template plugin}}"

2024-05-07T14:50:24Z

Text replacement - "Script Template plugin" to "{{Link|Arma Reforger:Script Editor: Fill From Template Plugin|Script Template plugin}}"

← Older revision		Revision as of 16:50, 7 May 2024
Line 10:		Line 10:
	* In an addon, create a new script in {{hl\|WorkbenchGame/ResourceManager}} - name it {{hl\|[[OFPEC_tags\|TAG_]]TutorialPlugin.c}} (must end with {{hl\|Plugin}} by convention)		* In an addon, create a new script in {{hl\|WorkbenchGame/ResourceManager}} - name it {{hl\|[[OFPEC_tags\|TAG_]]TutorialPlugin.c}} (must end with {{hl\|Plugin}} by convention)
	* Double-click the file to open it		* Double-click the file to open it
	* Press {{Controls\|Ctrl\|T}} to use the ~~[[Arma_Reforger~~:~~Script_Editor~~:~~_Fill_From_Template_Plugin~~\|Script Template plugin]]		* Press {{Controls\|Ctrl\|T}} to use the {{Link\|Arma Reforger:Script Editor: Fill From Template Plugin\|Script Template plugin}}
	** In its window, select "Class Type: WorkbenchPlugin", '''set the parent class to {{Link/Enfusion\|armaR\|ResourceManagerPlugin}}''' and leave the other fields blank/default		** In its window, select "Class Type: WorkbenchPlugin", '''set the parent class to {{Link/Enfusion\|armaR\|ResourceManagerPlugin}}''' and leave the other fields blank/default
	** A Workbench plugin skeleton is inserted.<!--		** A Workbench plugin skeleton is inserted.<!--

Reyhard at 09:08, 7 May 2024

2024-05-07T09:08:35Z

← Older revision		Revision as of 11:08, 7 May 2024
Line 7:		Line 7:
	== Setup ==		== Setup ==

	* Open Script Editor		* Open [[Arma_Reforger:Script_Editor\|Script Editor]]
	* In an addon, create a new script in {{hl\|WorkbenchGame/ResourceManager}} - name it {{hl\|~~TAG_TutorialPlugin~~.c}} (must end with {{hl\|Plugin}} by convention)		* In an addon, create a new script in {{hl\|WorkbenchGame/ResourceManager}} - name it {{hl\|[[OFPEC_tags\|TAG_]]TutorialPlugin.c}} (must end with {{hl\|Plugin}} by convention)
	* Double-click the file to open it		* Double-click the file to open it
	* Press {{Controls\|Ctrl\|T}} to use the Script Template plugin		* Press {{Controls\|Ctrl\|T}} to use the [[Arma_Reforger:Script_Editor:_Fill_From_Template_Plugin\|Script Template plugin]]
	** In its window, select "Class Type: WorkbenchPlugin", '''set the parent class to {{Link/Enfusion\|armaR\|ResourceManagerPlugin}}''' and leave the other fields blank/default		** In its window, select "Class Type: WorkbenchPlugin", '''set the parent class to {{Link/Enfusion\|armaR\|ResourceManagerPlugin}}''' and leave the other fields blank/default
	** A Workbench plugin skeleton is inserted.<!--		** A Workbench plugin skeleton is inserted.<!--
	* In the {{hl\|WorkbenchPluginAttribute}}, replace <enforce inline>wbModules: { "ResourceManager" }</enforce> by <enforce inline>wbModules: { "ScriptEditor" }</enforce>-->		* In the {{hl\|WorkbenchPluginAttribute}}, replace <enforce inline>wbModules: { "ResourceManager" }</enforce> by <enforce inline>wbModules: { "ScriptEditor" }</enforce>-->
	* In the <enforce inline>Run()</enforce> method, write <enforce inline>Print("It works!");</enforce> and save the file		* In the <enforce inline>Run()</enforce> method, write <enforce inline>Print("It works!");</enforce> and save the file
	* ~~Press~~ {{Controls\|Ctrl\|Shift\|R}} ~~to reload scripts~~		* Reload Workbench scripts via '''Reload WB Scripts''' option located in ''Plugins→Settings'' menu (default shortcut: {{Controls\|Ctrl\|Shift\|R}})
	* The {{hl\|~~TAG_TutorialPlugin~~}} plugin should appear in the Resource Manager's Plugins list, available in the top bar - click on the plugin entry		* The {{hl\|[[OFPEC_tags\|TAG_]]TutorialPlugin}} plugin should appear in the Resource Manager's Plugins list, available in the top bar - click on the plugin entry
	* "It works!" gets printed in the output console.		* "It works!" gets printed in the output console.

Lou Montana: Use ResourceManagerPlugin as a parent instead

2024-04-29T12:56:34Z

Use ResourceManagerPlugin as a parent instead

← Older revision		Revision as of 14:56, 29 April 2024
Line 11:		Line 11:
	* Double-click the file to open it		* Double-click the file to open it
	* Press {{Controls\|Ctrl\|T}} to use the Script Template plugin		* Press {{Controls\|Ctrl\|T}} to use the Script Template plugin
	** In its window, select "Class Type: WorkbenchPlugin", leave the other fields blank/default		** In its window, select "Class Type: WorkbenchPlugin", '''set the parent class to {{Link/Enfusion\|armaR\|ResourceManagerPlugin}}''' and leave the other fields blank/default
	** A Workbench plugin skeleton is inserted.<!--		** A Workbench plugin skeleton is inserted.<!--
	* In the {{hl\|WorkbenchPluginAttribute}}, replace <enforce inline>wbModules: { "ResourceManager" }</enforce> by <enforce inline>wbModules: { "ScriptEditor" }</enforce>-->		* In the {{hl\|WorkbenchPluginAttribute}}, replace <enforce inline>wbModules: { "ResourceManager" }</enforce> by <enforce inline>wbModules: { "ScriptEditor" }</enforce>-->
Line 33:		Line 33:
	<enforce>		<enforce>
	[WorkbenchPluginAttribute(name: "Tutorial Plugin", wbModules: { "ResourceManager" }, resourceTypes: { "et", "c" })]		[WorkbenchPluginAttribute(name: "Tutorial Plugin", wbModules: { "ResourceManager" }, resourceTypes: { "et", "c" })]
	class TAG_TutorialPlugin : ~~WorkbenchPlugin~~		class TAG_TutorialPlugin : ResourceManagerPlugin
	{		{
	//------------------------------------------------------------------------------------------------		//------------------------------------------------------------------------------------------------
Line 62:		Line 62:
	<enforce methods="WorkbenchSearchResourcesCallbackMethod">		<enforce methods="WorkbenchSearchResourcesCallbackMethod">
	[WorkbenchPluginAttribute(name: "Tutorial Plugin", wbModules: { "ResourceManager" }, awesomeFontCode: 0xF188)]		[WorkbenchPluginAttribute(name: "Tutorial Plugin", wbModules: { "ResourceManager" }, awesomeFontCode: 0xF188)]
	class TAG_TutorialPlugin : ~~WorkbenchPlugin~~		class TAG_TutorialPlugin : ResourceManagerPlugin
	{		{
	protected ref array<ResourceName> m_aResourceNames;		protected ref array<ResourceName> m_aResourceNames;

Lou Montana: Page creation

2024-04-29T10:01:46Z

Page creation

New page

{{TOC|side}}
This tutorial teaches how to create a {{Link|Arma Reforger:Resource Manager}}-specific plugin.

{{Feature|important|Please read {{Link|Arma Reforger:Workbench Plugin}} before following this tutorial.}}

== Setup ==

* Open Script Editor
* In an addon, create a new script in {{hl|WorkbenchGame/ResourceManager}} - name it {{hl|TAG_TutorialPlugin.c}} (must end with {{hl|Plugin}} by convention)
* Double-click the file to open it
* Press {{Controls|Ctrl|T}} to use the Script Template plugin
** In its window, select "Class Type: WorkbenchPlugin", leave the other fields blank/default
** A Workbench plugin skeleton is inserted.
* In the <enforce inline>Run()</enforce> method, write <enforce inline>Print("It works!");</enforce> and save the file
* Press {{Controls|Ctrl|Shift|R}} to reload scripts
* The {{hl|TAG_TutorialPlugin}} plugin should appear in the Resource Manager's Plugins list, available in the top bar - click on the plugin entry
* "It works!" gets printed in the output console.

== Contextual Menu Option ==

The Resource '''Browser'''<nowiki/>'s Contextual Menu can provide a Plugin option allowing to run code on the selected resource(s) of the defined type(s).

{{Feature|informative|The Plugin Contextual Menu is only available in Resource Manager, not any other Workbench module.}}

In the {{Link/Enfusion|armaR|WorkbenchPluginAttribute}}, the {{hl|resourceTypes}} parameter must be filled, e.g <enforce inline>resourceTypes: { "et", "c" }</enforce>.

The <enforce inline methods="OnResourceContextMenu">OnResourceContextMenu</enforce> method must be overridden to work with said resources.

<enforce>
[WorkbenchPluginAttribute(name: "Tutorial Plugin", wbModules: { "ResourceManager" }, resourceTypes: { "et", "c" })]
class TAG_TutorialPlugin : WorkbenchPlugin
{
//------------------------------------------------------------------------------------------------
override void OnResourceContextMenu(notnull array<ResourceName> resources)
{
Print("Resource context menu action has been called! Here are the selected resources:");
foreach (ResourceName resource : resources)
{
if (resource.EndsWith("c"))
Print("- Script File: " + resource);
else
Print("- Prefab File: " + resource);
}
}
}
</enforce>

== ResourceManager Module API ==

{{Feature|informative|See the {{Link/Enfusion|armaR|ResourceManager}} class.}}

The Resource Manager API allows to register resources, rebuild them, get the selected ones or get their meta file content.
In the below code:
* the <enforce inline methods="GetResourceBrowserSelection">GetResourceBrowserSelection</enforce> method is used to temporarily store Resource Browser-selected resources in <enforce inline>m_aResourceNames</enforce> and their file path in <enforce inline>m_aFilePaths</enforce>
* the <enforce inline methods="GetMetaFile">GetMetaFile</enforce> method is used to get the current resource's {{hl|.meta}} file as a {{Link/Enfusion|armaR|MetaFile}} instance.

<enforce methods="WorkbenchSearchResourcesCallbackMethod">
[WorkbenchPluginAttribute(name: "Tutorial Plugin", wbModules: { "ResourceManager" }, awesomeFontCode: 0xF188)]
class TAG_TutorialPlugin : WorkbenchPlugin
{
protected ref array<ResourceName> m_aResourceNames;
protected ref array<string> m_aFilePaths;

//------------------------------------------------------------------------------------------------
override void Run()
{
ResourceManager resourceManager = Workbench.GetModule(ResourceManager);

m_aResourceNames = {};
m_aFilePaths = {};
resourceManager.GetResourceBrowserSelection(WorkbenchSearchResourcesCallbackMethod, false); // non-recursive search

if (m_aFilePaths.IsEmpty())
{
Print("No Resources selected in Resource Browser");
return;
}

MetaFile metaFile;
foreach (int i, ResourceName filePath : m_aFilePaths)
{
metaFile = resourceManager.GetMetaFile(filePath);
if (!metaFile) // e.g directory
continue;

PrintFormat(
"#%1: %3 (dir %2)",
i,
metaFile.GetSourceFilePath(), // returns the directory tree, e.g $MyMod:Path/To/
metaFile.GetResourceID()); // returns the file's ResourceName, equal to 'resName' below
}
}

//------------------------------------------------------------------------------------------------
// \param[in] resName
// \param[in] filePath is in format $MyMod:Path/To/File.ext
protected void WorkbenchSearchResourcesCallbackMethod(ResourceName resName, string filePath = "")
{
m_aResourceNames.Insert(resName);
m_aFilePaths.Insert(filePath);
}
}
</enforce>

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