Workbench Links – Arma Reforger

From Bohemia Interactive Community
Jump to navigation Jump to search
(Fix yesterday's test results and add ProcAnimEditor)
m (Fix)
 
Line 4: Line 4:


{{Feature|important|Using a Workbench link requires registering the {{hl|enfusion://}} protocol in Windows; see the {{Link|Arma Reforger:Resource Manager: Options#Register .22enfusion:.2F.2F.22 protocol|Register enfusion:// protocol}} section for more information.}}
{{Feature|important|Using a Workbench link requires registering the {{hl|enfusion://}} protocol in Windows; see the {{Link|Arma Reforger:Resource Manager: Options#Register .22enfusion:.2F.2F.22 protocol|Register enfusion:// protocol}} section for more information.}}
== Supported Modules ==
* {{Link|Arma Reforger:Resource Manager}} (ResourceManager)
* {{Link|Arma Reforger:Behavior Editor}} (BehaviorEditor)
* {{Link|Arma Reforger:Script Editor}} (ScriptEditor)
* {{Link|Arma Reforger:World Editor}} (WorldEditor)




== Format ==
== Format ==


A Workbench link is composed of the {{hl|enfusion://}} protocol, the Module to open, eventually an addon ID, the relative file path and eventual parameters:
A Workbench link is composed of the {{hl|enfusion://}} protocol followed by the Module name to open; eventually an addon ID, the relative file path and eventual parameters separated by a semicolon:
* {{Color|blue|enfusion://}}{{Color|darkorange|ResourceManager}}'''/'''{{Color|green|~ArmaReforger:}}{{Color|#555|Configs/Factions/BLUFOR.conf}}
* {{Color|blue|enfusion://}}{{Color|darkorange|ResourceManager}}'''/'''{{Color|green|~ArmaReforger:}}{{Color|#555|Configs/Factions/BLUFOR.conf}}
* {{Color|blue|enfusion://}}{{Color|darkorange|ScriptEditor}}'''/'''{{Color|#555|scripts/Game/Editor/Containers/UIInfo/SCR_UIInfo.c}}''';'''{{Color|red|8}}
* {{Color|blue|enfusion://}}{{Color|darkorange|ScriptEditor}}'''/'''{{Color|#555|scripts/Game/Editor/Containers/UIInfo/SCR_UIInfo.c}}''';'''{{Color|red|8}}
* {{Color|blue|enfusion://}}{{Color|darkorange|WorldEditor}}'''/'''{{Color|#555|worlds/arland/arland.ent}}''';'''{{Color|red|3458.4,34.5587,2820.21}}''';'''{{Color|darkred|-15.107,297.881,0}}''';'''{{Color|teal|46247}}<!-- ''';'''{{Color|purple|0.000129365,1989,8,20}} -->
* {{Color|blue|enfusion://}}{{Color|darkorange|WorldEditor}}'''/'''{{Color|#555|worlds/arland/arland.ent}}''';'''{{Color|red|3458.4,34.5587,2820.21}}''';'''{{Color|darkred|-15.107,297.881,0}}''';'''{{Color|teal|46247}}<!-- ''';'''{{Color|purple|0.000129365,1989,8,20}} -->


{| class="wikitable align-center-col-1"
 
{| class="wikitable" style="margin: auto"
! Module
! Module
! Module Name
! Base Link
! Parameters
! Parameters
|-
|-
| [[Arma Reforger:Resource Manager|ResourceManager]]
| {{Link|Arma Reforger:Resource Manager}}
| ResourceManager
| {{Color|blue|enfusion://}}{{Color|darkorange|ResourceManager}}
| {{n/a}}
| {{n/a}}
|-
|-
| [[Arma Reforger:Script Editor|ScriptEditor]]
| {{Link|Arma Reforger:Script Editor}}
| ScriptEditor
| {{Color|blue|enfusion://}}{{Color|darkorange|ScriptEditor}}
|
|
* file line number
* file line number
|-
|-
| [[Arma Reforger:World Editor|WorldEditor]]
| {{Link|Arma Reforger:World Editor}}
| WorldEditor
| {{Color|blue|enfusion://}}{{Color|darkorange|WorldEditor}}
|
|
* camera's world position (x, y, z)
* camera's world position (x, y, z)
Line 40: Line 41:
* daytime (in range 0..1), year, month, day
* daytime (in range 0..1), year, month, day
-->
-->
|-
| colspan="4" class="align-center" style="padding: 1em" | The following modules do not support a file parameter - a link can only be used to open the associated editor.
|-
| {{Link|Arma Reforger:Particle Editor}}
| ParticleEditor
| {{Color|blue|enfusion://}}{{Color|darkorange|ParticleEditor}}
| rowspan="6" {{n/a}}
|-
| {{Link|Arma Reforger:Animation Editor}}
| AnimEditor
| {{Color|blue|enfusion://}}{{Color|darkorange|AnimEditor}}
|-
| {{Link|Arma Reforger:Audio Editor}}
| AudioEditor
| {{Color|blue|enfusion://}}{{Color|darkorange|AudioEditor}}
|-
| {{Link|Arma Reforger:Behavior Editor}}
| BehaviorEditor
| {{Color|blue|enfusion://}}{{Color|darkorange|BehaviorEditor}}
|-
| {{Link|Arma Reforger:String Editor}}
| ''Localization''Editor
| {{Color|blue|enfusion://}}{{Color|darkorange|LocalizationEditor}}
|-
| {{Link|Arma Reforger:Procedural Animation Editor}}
| ProcAnimEditor
| {{Color|blue|enfusion://}}{{Color|darkorange|ProcAnimEditor}}
|}
|}


A link can be prefixed with {{hl|<nowiki>https://enfusionengine.com/api/redirect?to=</nowiki>}}; the {{Link|https://enfusionengine.com|Enfusion Engine website}} provides a redirection for platforms that do not see {{hl|enfusion://}} as a valid protocol (e.g Discord).


{{Feature|important|
{{Feature|informative|
The following editor links do not take any arguments:
A link can be found prefixed with {{hl|<nowiki>https://enfusionengine.com/api/redirect?to=</nowiki>}};
* {{Color|blue|enfusion://}}{{Color|darkorange|ParticleEditor}}
the {{Link|https://enfusionengine.com|Enfusion Engine website}} provides a redirection for platforms that do not see {{hl|enfusion://}} as a valid protocol (e.g Discord).
* {{Color|blue|enfusion://}}{{Color|darkorange|AnimEditor}}
* {{Color|blue|enfusion://}}{{Color|darkorange|AudioEditor}}
* {{Color|blue|enfusion://}}{{Color|darkorange|BehaviorEditor}}
* {{Color|blue|enfusion://}}{{Color|darkorange|LocalizationEditor}}
* {{Color|blue|enfusion://}}{{Color|darkorange|ProcAnimEditor}}
}}
}}




== Link Creation ==
== Link Creation ==
Link creation is not available in the following editors, yet properly-formatted links work for them:
* {{Link|Arma Reforger:Audio Editor}}
* {{Link|Arma Reforger:Behavior Editor}}
The following editors do not take any file argument:
* {{Link|Arma Reforger:Animation Editor}}
* {{Link|Arma Reforger:Particle Editor}}
* {{Link|Arma Reforger:String Editor}}


=== {{Link|Arma Reforger:Resource Manager}} ===
=== {{Link|Arma Reforger:Resource Manager}} ===


Create a link by clicking on any resource in '''Resource Browser''' with {{Controls|RMB}} then selecting '''Copy Link''' option from the context menu.
Create a link by clicking on any resource in '''Resource Browser''' with {{Controls|RMB}} then selecting '''Copy Link''' option from the context menu.
[[Image:armareforger-resource-manager-options-rm-link-create.jpg|thumb|right|200px|Creating a link in Resource Browser]]
[[Image:armareforger-resource-manager-options-rm-link-create.jpg|thumb|right|300px|Creating a link in Resource Browser]]
[[Image:armareforger-resource-manager-options-rm-link.jpg|thumb|left|600px| Example:
[[Image:armareforger-resource-manager-options-rm-link.jpg|thumb|left|800px| Example: {{Link|enfusion://ResourceManager/~ArmaReforger:Assets/Props/Fabric/Flags/Flag_1_2.xob|enfusion://ResourceManager/~ArmaReforger:Assets/Props/Fabric/Flags/Flag_1_2.xob}}<br>
[enfusion://ResourceManager/~ArmaReforger:Assets/Props/Fabric/Flags/Flag_1_2.xob enfusion://ResourceManager/~ArmaReforger:Assets/Props/Fabric/Flags/Flag_1_2.xob]]]
{{Link|Arma Reforger:Resource Manager}} opens the {{Link|enfusion://ResourceManager/~ArmaReforger:Assets/Props/Fabric/Flags/Flag_1_2.xob}} file
]]


{{Clear}}
{{Clear}}
Line 78: Line 92:
Create a link by selecting from the top menu ''Edit →'' '''Copy link option''' or by using the {{Controls|Ctrl|Shift|L}} shortcut (can be changed in the {{Link|Arma Reforger:Resource Manager: Options#Shortcuts|shortcuts options section}})
Create a link by selecting from the top menu ''Edit →'' '''Copy link option''' or by using the {{Controls|Ctrl|Shift|L}} shortcut (can be changed in the {{Link|Arma Reforger:Resource Manager: Options#Shortcuts|shortcuts options section}})


[[Image:armareforger-resource-manager-options-se-link-create2.jpg|thumb|right|200px|Creating a link in Script Editor]]
[[Image:armareforger-resource-manager-options-se-link-create2.jpg|thumb|right|400px|Creating a link in Script Editor]]
[[Image:armareforger-resource-manager-options-se-link.jpg|thumb|left|600px|Example: {{Link|enfusion://ScriptEditor/scripts/Core/proto/EnWorld.c}} file is being open in Script Editor and current line is set to line 17
[[Image:armareforger-resource-manager-options-se-link.jpg|thumb|left|800px|Example: {{Link|enfusion://ScriptEditor/scripts/Core/proto/EnWorld.c;17|enfusion://ScriptEditor/scripts/Core/proto/EnWorld.c;17}}<br>
[enfusion://ScriptEditor/scripts/Core/proto/EnWorld.c;17 enfusion://ScriptEditor/scripts/Core/proto/EnWorld.c;17]
{{Link|Arma Reforger:Script Editor}} opens the {{Link|enfusion://ScriptEditor/scripts/Core/proto/EnWorld.c}} file at line {{Link|enfusion://ScriptEditor/scripts/Core/proto/EnWorld.c;17|17}}]]
]]


{{Clear}}
{{Clear}}
Line 88: Line 101:
Create a link by selecting from the top menu ''Game →'' '''Copy view link''' option or by using the {{Controls|Ctrl|Shift|L}} shortcut (can be changed in the {{Link|Arma Reforger:Resource Manager: Options#Shortcuts|shortcuts options section}})
Create a link by selecting from the top menu ''Game →'' '''Copy view link''' option or by using the {{Controls|Ctrl|Shift|L}} shortcut (can be changed in the {{Link|Arma Reforger:Resource Manager: Options#Shortcuts|shortcuts options section}})


[[Image:armareforger-resource-manager-options-we-link-create2.jpg|thumb|right|200px|Creating a link in World Editor]]
[[Image:armareforger-resource-manager-options-we-link-create2.jpg|thumb|right|400px|Creating a link in World Editor]]
[[Image:armareforger-resource-manager-options-we-link.jpg|thumb|left|600px|Example:
[[Image:armareforger-resource-manager-options-we-link.jpg|thumb|left|800px|Example: {{Link|enfusion://WorldEditor/worlds/GameMaster/GM_Eden.ent;5275.56,81.3831,6383.2;-4.2668,-283.292,0|enfusion://WorldEditor/worlds/GameMaster/GM_Eden.ent;5275.56,81.3831,6383.2;-4.2668,-283.292,0}}<br>
[enfusion://WorldEditor/worlds/GameMaster/GM_Eden.ent;5275.56,81.3831,6383.2;-4.2668,-283.292,0 enfusion://WorldEditor/worlds/GameMaster/GM_Eden.ent;5275.56,81.3831,6383.2;-4.2668,-283.292,0]
{{Link|Arma Reforger:Script Editor}} opens the {{Link|enfusion://WorldEditor/worlds/GameMaster/GM_Eden.ent}} file at world coordinates {{Link|enfusion://WorldEditor/worlds/GameMaster/GM_Eden.ent;5275.56,81.3831,6383.2|5275.56,81.3831,6383.2}} and camera angles {{Link|enfusion://WorldEditor/worlds/GameMaster/GM_Eden.ent;5275.56,81.3831,6383.2;-4.2668,-283.292,0|-4.2668,-283.292,0}}]]
]]
{{Clear}}
{{Clear}}




{{GameCategory|armaR|Modding|Official Tools}}
{{GameCategory|armaR|Modding|Official Tools}}

Latest revision as of 10:20, 2 August 2024

A Workbench link is a protocol link that allows to share a direct point to a resource/script/game world location.


⚠
Using a Workbench link requires registering the enfusion:// protocol in Windows; see the Register enfusion:// protocol section for more information.


Format

A Workbench link is composed of the enfusion:// protocol followed by the Module name to open; eventually an addon ID, the relative file path and eventual parameters separated by a semicolon:

  • enfusion://ResourceManager/~ArmaReforger:Configs/Factions/BLUFOR.conf
  • enfusion://ScriptEditor/scripts/Game/Editor/Containers/UIInfo/SCR_UIInfo.c;8
  • enfusion://WorldEditor/worlds/arland/arland.ent;3458.4,34.5587,2820.21;-15.107,297.881,0;46247


Module Module Name Base Link Parameters
Resource Manager ResourceManager enfusion://ResourceManager N/A
Script Editor ScriptEditor enfusion://ScriptEditor
  • file line number
World Editor WorldEditor enfusion://WorldEditor
  • camera's world position (x, y, z)
  • camera's angles (x, y, z) - angles in -180..+180 range, z is always 0
  • entity ID - to select a specific entity
The following modules do not support a file parameter - a link can only be used to open the associated editor.
Particle Editor ParticleEditor enfusion://ParticleEditor N/A
Animation Editor AnimEditor enfusion://AnimEditor
Audio Editor AudioEditor enfusion://AudioEditor
Behavior Editor BehaviorEditor enfusion://BehaviorEditor
String Editor LocalizationEditor enfusion://LocalizationEditor
Procedural Animation Editor ProcAnimEditor enfusion://ProcAnimEditor


ⓘ
A link can be found prefixed with https://enfusionengine.com/api/redirect?to=; the Enfusion Engine website provides a redirection for platforms that do not see enfusion:// as a valid protocol (e.g Discord).


Link Creation

Resource Manager

Create a link by clicking on any resource in Resource Browser with Right Mouse Button then selecting Copy Link option from the context menu.

Creating a link in Resource Browser
Example: enfusion://ResourceManager/~ArmaReforger:Assets/Props/Fabric/Flags/Flag_1_2.xob
Resource Manager opens the Flag_1_2.xob file

Script Editor

Create a link by selecting from the top menu Edit → Copy link option or by using the Ctrl + ⇧ Shift + L shortcut (can be changed in the shortcuts options section)

Creating a link in Script Editor
Example: enfusion://ScriptEditor/scripts/Core/proto/EnWorld.c;17
Script Editor opens the EnWorld.c file at line 17

World Editor

Create a link by selecting from the top menu Game → Copy view link option or by using the Ctrl + ⇧ Shift + L shortcut (can be changed in the shortcuts options section)

Creating a link in World Editor
Example: enfusion://WorldEditor/worlds/GameMaster/GM_Eden.ent;5275.56,81.3831,6383.2;-4.2668,-283.292,0
Script Editor opens the GM_Eden.ent file at world coordinates 5275.56,81.3831,6383.2 and camera angles -4.2668,-283.292,0
Retrieved from "https://community.bistudio.com/wiki?title=Arma_Reforger:Workbench_Links&oldid=365176"