Tanin69/Sandbox – User

From Bohemia Interactive Community
(Created page with "= Coords Tool - Coordinate Navigation Tool = == Description == The '''Coords Tool''' is a World Editor plugin for Enfusion that allows terrain creators to quickly navigate to specific coordinates and save important locations. == Usefulness for Terrain Creators == When creating terrains and scenes in Arma Reforger, you often need to: * Return to specific locations to check or modify elements * Share precise positions with other team members * Document points of intere...")
 
No edit summary
Line 1: Line 1:
= Coords Tool - Coordinate Navigation Tool =
= Coords Tool =
 


== Description ==
== Description ==


The '''Coords Tool''' is a World Editor plugin for Enfusion that allows terrain creators to quickly navigate to specific coordinates and save important locations.
The '''Coords Tool''' is a World Editor plugin for Enfusion that allows terrain creators to quickly navigate to specific coordinates and save important locations.


== Usefulness for Terrain Creators ==
== Usefulness for Terrain Creators ==
Line 14: Line 16:


The Coords Tool facilitates these tasks by allowing you to:
The Coords Tool facilitates these tasks by allowing you to:
* ✅ Save positions with a simple click
* Save positions with a simple click
* ✅ Generate shareable links (enfusion:// protocol)
* Generate shareable links (enfusion:// protocol)
* ✅ Navigate instantly to coordinates
* Navigate instantly to coordinates
* ✅ Keep a history of visited positions
* Keep a history of visited positions
 


== User Interface ==
== User Interface ==


[[File:WE_plugin_Coord_Tool_UI.png|thumb|400px|Coords Tool Interface]]
[[File:Coords_Tool_Interface.png|thumb|400px|Coords Tool Interface]]


The tool consists of three main sections:
The tool consists of three main sections:


=== 1. Coordinates ===
 
=== Coordinates ===
 
* '''Position''': X, Y, Z coordinates in world space
* '''Position''': X, Y, Z coordinates in world space
* '''Rotation''': Camera angles (Pitch, Yaw, Roll) in degrees
* '''Rotation''': Camera angles (Pitch, Yaw, Roll) in degrees


=== 2. Options ===
=== Options ===
 
* '''Use Web Prefix''': Adds the <code>https://enfusionengine.com/api/redirect?to=</code> prefix to generated links, allowing them to be used in web browsers
* '''Use Web Prefix''': Adds the <code>https://enfusionengine.com/api/redirect?to=</code> prefix to generated links, allowing them to be used in web browsers


=== 3. Data ===
=== Data ===
 
* '''Entries''': List of saved positions (most recent entry at the top)
* '''Entries''': List of saved positions (most recent entry at the top)


== Features ==
== Features ==


=== Navigate to Manual Coordinates ===
=== Navigate to Manual Coordinates ===
Line 41: Line 50:
# Enter the '''Position''' coordinates (X, Y, Z)
# Enter the '''Position''' coordinates (X, Y, Z)
# Enter the '''Rotation''' (Pitch, Yaw, Roll) if needed
# Enter the '''Rotation''' (Pitch, Yaw, Roll) if needed
# Click '''« Go to coords »'''
# Click '''Go to coords'''
# The camera instantly moves to this position
# The camera instantly moves to this position


=== Copy Current Position ===
=== Copy Current Position ===


# Position your camera at the desired location
# Position your camera at the desired location
# Click '''« Copy link to clipboard »'''
# Click '''Copy link to clipboard'''
# A link in the format <code>enfusion://WorldEditor/...</code> is copied to the clipboard
# A link in the format <code>enfusion://WorldEditor/...</code> is copied to the clipboard
# You can share this link with other developers
# You can share this link with other developers


'''Link format:'''
'''Link format:'''
<syntaxhighlight>
 
enfusion://WorldEditor/worlds/world_name.ent;X,Y,Z;Yaw,Pitch,Roll
<enforce>enfusion://WorldEditor/worlds/world_name.ent;X,Y,Z;Yaw,Pitch,Roll</enforce>
</syntaxhighlight>
 


=== Navigate from Clipboard ===
=== Navigate from Clipboard ===


# Copy an enfusion:// link (received from a colleague or generated previously)
# Copy an enfusion:// link (received from a colleague or generated previously)
# Click '''« Go to clipboard link »'''
# Click '''Go to clipboard link'''
# The camera moves to this position
# The camera moves to this position


Line 66: Line 76:
* <code>https://enfusionengine.com/api/redirect?to=enfusion://...</code>
* <code>https://enfusionengine.com/api/redirect?to=enfusion://...</code>
* <code>X,Y,Z;Pitch,Yaw,Roll</code> (simplified format)
* <code>X,Y,Z;Pitch,Yaw,Roll</code> (simplified format)


=== Save an Entry to History ===
=== Save an Entry to History ===


# Position your camera
# Position your camera
# Click '''« Add entry »'''
# Click '''Add entry'''
# A new entry is created with:
# A new entry is created with:
#* An automatic name: <code>Link #X (world_name)</code>
#* An automatic name: <code>Link #X (world_name)</code>
Line 79: Line 90:
# Open the entry in the '''Entries''' list
# Open the entry in the '''Entries''' list
# Copy the content of the '''Link''' field
# Copy the content of the '''Link''' field
# Click '''« Go to clipboard link »'''
# Click '''Go to clipboard link'''
 


== Practical Use Cases ==
== Practical Use Cases ==


=== Example 1: Bug Documentation ===
=== Example 1: Bug Documentation ===
<pre>
 
Problematic position found → Add entry → Share link in bug report
<code style="display: block">Problematic position found → Add entry → Share link in bug report</code>
</pre>
 


=== Example 2: Collaborative Work ===
=== Example 2: Collaborative Work ===
<pre>
 
Creator A: Finds a good viewpoint → Copy link to clipboard → Sends to Creator B
<code style="display: block">Creator A: Finds a good viewpoint → Copy link to clipboard → Sends to Creator B
Creator B: Pastes the link → Go to clipboard link → Sees exactly the same view
Creator B: Pastes the link → Go to clipboard link → Sees exactly the same view</code>
</pre>
 


=== Example 3: Recurring Test Points ===
=== Example 3: Recurring Test Points ===
Save multiple entries for:
Save multiple entries for:
* Player spawn point
* Player spawn point
Line 100: Line 114:
* Map boundaries
* Map boundaries
* Problem areas
* Problem areas


== Console Messages ==
== Console Messages ==
Line 106: Line 121:


{| class="wikitable"
{| class="wikitable"
! Message !! Meaning
! Message
! Meaning
|-
|-
| <code>Camera set to Position = X Y Z, Rotation = P Y R</code> || Successful navigation
| <code>Camera set to Position = X Y Z, Rotation = P Y R</code>
| Successful navigation
|-
|-
| <code>Link copied to clipboard: enfusion://...</code> || Link successfully copied
| <code>Link copied to clipboard: enfusion://...</code>
| Link successfully copied
|-
|-
| <code>Current position is last log entry</code> || This position is already the last entry
| <code>Current position is last log entry</code>
| This position is already the last entry
|-
|-
| <code>String is in invalid format...</code> || Pasted link format is incorrect
| <code>String is in invalid format...</code>
| Pasted link format is incorrect
|-
|-
| <code>Error obtaining the link</code> || Error generating the link
| <code>Error obtaining the link</code>
| Error generating the link
|}
|}


== Limitations ==
== Limitations ==
Line 124: Line 146:
* Coordinates are specific to the currently open terrain
* Coordinates are specific to the currently open terrain
* Links only work if the terrain is accessible to the recipient
* Links only work if the terrain is accessible to the recipient


== Tips ==
== Tips ==


{{Tip|Enable "Use Web Prefix" to create clickable links in web browsers (useful for wikis and documentation)}}
{{Feature|informative|Enable "Use Web Prefix" to create clickable links in web browsers (useful for wikis and documentation)}}
 
{{Feature|informative|Entries can be manually renamed for better organization}}


{{Tip|Entries can be manually renamed for better organization}}
{{Feature|informative|Use the simple format <code>X,Y,Z;Pitch,Yaw,Roll</code> for quick annotations in your notes}}


{{Tip|Use the simple format <code>X,Y,Z;Pitch,Yaw,Roll</code> for quick annotations in your notes}}


== Plugin Access ==
== Plugin Access ==


'''Menu''': Tools → Coords Tool (icon 📍)
'''Menu''': Tools → Coords Tool


'''Shortcut''': None by default
'''Shortcut''': None by default


== See Also ==
== See Also ==


* [[World Editor]]
* [[Enfusion Engine]]
* [[Enfusion Engine]]
* [[Arma Reforger Modding]]
* {{Link|https://community.bistudio.com/wiki/Arma_Reforger:Modding}}
 


[[Category:World Editor]]
[[Category:{{armaR}}: Enfusion|{{uc:{{PAGENAME}}}}]]
[[Category:Enfusion Tools]]
[[Category:{{armaR}}: World Editor|{{uc:{{PAGENAME}}}}]]
[[Category:Arma Reforger]]

Revision as of 21:57, 15 November 2025

Coords Tool

Description

The Coords Tool is a World Editor plugin for Enfusion that allows terrain creators to quickly navigate to specific coordinates and save important locations.


Usefulness for Terrain Creators

When creating terrains and scenes in Arma Reforger, you often need to:

  • Return to specific locations to check or modify elements
  • Share precise positions with other team members
  • Document points of interest or issues to resolve
  • Test different camera views

The Coords Tool facilitates these tasks by allowing you to:

  • Save positions with a simple click
  • Generate shareable links (enfusion:// protocol)
  • Navigate instantly to coordinates
  • Keep a history of visited positions


User Interface

Coords Tool Interface

The tool consists of three main sections:


Coordinates

  • Position: X, Y, Z coordinates in world space
  • Rotation: Camera angles (Pitch, Yaw, Roll) in degrees

Options

Data

  • Entries: List of saved positions (most recent entry at the top)


Features

Navigate to Manual Coordinates

  1. Enter the Position coordinates (X, Y, Z)
  2. Enter the Rotation (Pitch, Yaw, Roll) if needed
  3. Click Go to coords
  4. The camera instantly moves to this position


Copy Current Position

  1. Position your camera at the desired location
  2. Click Copy link to clipboard
  3. A link in the format enfusion://WorldEditor/... is copied to the clipboard
  4. You can share this link with other developers

Link format:

enfusion://WorldEditor/worlds/world_name.ent;X,Y,Z;Yaw,Pitch,Roll


Navigate from Clipboard

  1. Copy an enfusion:// link (received from a colleague or generated previously)
  2. Click Go to clipboard link
  3. The camera moves to this position

Accepted formats:


Save an Entry to History

  1. Position your camera
  2. Click Add entry
  3. A new entry is created with:
    • An automatic name: Link #X (world_name)
    • The complete position link
  4. The entry appears at the top of the Entries list

Using a saved entry:

  1. Open the entry in the Entries list
  2. Copy the content of the Link field
  3. Click Go to clipboard link


Practical Use Cases

Example 1: Bug Documentation

Problematic position found → Add entry → Share link in bug report


Example 2: Collaborative Work

Creator A: Finds a good viewpoint → Copy link to clipboard → Sends to Creator B Creator B: Pastes the link → Go to clipboard link → Sees exactly the same view


Example 3: Recurring Test Points

Save multiple entries for:

  • Player spawn point
  • Main city center
  • Map boundaries
  • Problem areas


Console Messages

The tool displays messages in the Workbench console:

Message Meaning
Camera set to Position = X Y Z, Rotation = P Y R Successful navigation
Link copied to clipboard: enfusion://... Link successfully copied
Current position is last log entry This position is already the last entry
String is in invalid format... Pasted link format is incorrect
Error obtaining the link Error generating the link


Limitations

  • History is not persistent (lost when Workbench closes)
  • Coordinates are specific to the currently open terrain
  • Links only work if the terrain is accessible to the recipient


Tips

ⓘ
Enable "Use Web Prefix" to create clickable links in web browsers (useful for wikis and documentation)
ⓘ
Entries can be manually renamed for better organization
ⓘ
Use the simple format X,Y,Z;Pitch,Yaw,Roll for quick annotations in your notes


Plugin Access

Menu: Tools → Coords Tool

Shortcut: None by default


See Also

Retrieved from "https://community.bistudio.com/wiki?title=User:Tanin69/Sandbox&oldid=376736"