World Editor: Coords Tool – Arma Reforger

From Bohemia Interactive Community
m (Some wiki formatting)
 
Line 1: Line 1:
{{TOC|side}}
{{TOC|side}}
The '''Coords Tool''' is a {{Link|Arma Reforger:World Editor}} tool that allows terrain creators to quickly navigate to specific coordinates and save important locations.


 
When creating terrains and scenes in {{armaR}}, it is often needed to:
== Description ==
 
The '''Coords Tool''' is a World Editor tool 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
* Return to specific locations to check or modify elements
* Share precise positions with other team members
* Share precise positions with other team members
Line 20: Line 13:
* Navigate instantly to coordinates
* Navigate instantly to coordinates
* Keep a history of visited positions
* Keep a history of visited positions
== Tool Access ==
'''Menu''': Tools → Coords Tool
'''Shortcut''': None by default




Line 33: Line 19:
[[File:Coords_Tool_Interface.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 can be accessed through '''Menu''': Tools &rarr; Coords Tool.<br>
 
It consists of three main sections: {{Link|#Coordinates}}, {{Link|#Options}} and {{Link|#Data}}.


=== Coordinates ===
=== Coordinates ===
Line 40: Line 26:
* '''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


=== 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 {{hl|https://enfusionengine.com/api/redirect?to{{=}}}} prefix to generated links, allowing them to be used in web browsers
 


=== Data ===
=== Data ===
Line 53: Line 37:


== Usage ==
== Usage ==


=== Navigate to Manual Coordinates ===
=== Navigate to Manual Coordinates ===
Line 67: Line 50:
# 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 {{hl|<nowiki>enfusion://WorldEditor/...</nowiki>}} is copied to the clipboard
# You can share this link with other developers
# You can share this link with other developers


Line 74: Line 57:
=== Navigate from Clipboard ===
=== Navigate from Clipboard ===


# Copy an enfusion:// link (received from a colleague or generated previously)
# Copy an {{hl|enfusion://}} link (received from a colleague or generated previously) to the clipboard (e.g {{Controls|Ctrl|C}})
# Click '''Go to clipboard link'''
# Click '''Go to clipboard link'''
# The camera moves to this position
# The camera moves to this position


'''Accepted formats:'''
'''Accepted formats:'''
* <code>enfusion://WorldEditor/worlds/...;X,Y,Z;Pitch,Yaw,Roll</code>
* {{hl|<nowiki>enfusion://WorldEditor/worlds/...;X,Y,Z;Pitch,Yaw,Roll</nowiki>}}
* <code>https://enfusionengine.com/api/redirect?to=enfusion://...</code>
* {{hl|<nowiki>https://enfusionengine.com/api/redirect?to=enfusion://...</nowiki>}}
* <code>X,Y,Z;Pitch,Yaw,Roll</code> (simplified format)
* X,Y,Z;Pitch,Yaw,Roll (simplified format, works across all terrains)
 


=== Save an Entry to History ===
=== Save an Entry to History ===
Line 89: Line 71:
# 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: Link #X (world_name)
#* The complete position link
#* The complete position link
# The entry appears at the top of the '''Entries''' list
# The entry appears at the top of the '''Entries''' list
Line 101: Line 83:
== Practical Use Cases ==
== Practical Use Cases ==


=== Bug Documentation ===


=== Example 1: Bug Documentation ===
Problematic position found &rarr; Add entry &rarr; Share link in bug report


<code style="display: block">Problematic position found → Add entry → Share link in bug report</code>
=== Collaborative Work ===


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


=== Example 2: Collaborative Work ===
=== Recurring Test Points ===
 
<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</code>
 
 
=== Example 3: Recurring Test Points ===


Save multiple entries for:
Save multiple entries for:
Line 130: Line 109:
! Meaning
! Meaning
|-
|-
| <code>Camera set to Position = X Y Z, Rotation = P Y R</code>
| Camera set to Position = X Y Z, Rotation = P Y R
| Successful navigation
| Successful navigation
|-
|-
| <code>Link copied to clipboard: enfusion://...</code>
| Link copied to clipboard: enfusion://...
| Link successfully copied
| Link successfully copied
|-
|-
| <code>Current position is last log entry</code>
| Current position is last log entry
| This position is already the last entry
| This position is already the last entry
|-
|-
| <code>String is in invalid format...</code>
| String is in invalid format...
| Pasted link format is incorrect
| Pasted link format is incorrect
|-
|-
| <code>Error obtaining the link</code>
| Error obtaining the link
| Error generating the link
| Error generating the link
|}
|}
Line 150: Line 129:


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


Line 156: Line 135:
== Tips ==
== Tips ==


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


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


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

Latest revision as of 21:42, 18 November 2025

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

When creating terrains and scenes in Arma Reforger, it is often needed 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 can be accessed through Menu: Tools → Coords Tool.
It consists of three main sections: Coordinates, Options and Data.

Coordinates

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

Options

  • Use Web Prefix: Adds the https://enfusionengine.com/api/redirect?to= prefix to generated links, allowing them to be used in web browsers

Data

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


Usage

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 - see Workbench Links.

Navigate from Clipboard

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

Accepted formats:

  • enfusion://WorldEditor/worlds/...;X,Y,Z;Pitch,Yaw,Roll
  • https://enfusionengine.com/api/redirect?to=enfusion://...
  • X,Y,Z;Pitch,Yaw,Roll (simplified format, works across all terrains)

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

Bug Documentation

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

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

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 (unless simple coordinates are used)
  • 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 organisation
  • Use the simple format X,Y,Z;Pitch,Yaw,Roll for quick annotations in your notes