|
|
| (3 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| = 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 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 ==
| |
|
| |
| [[File:WE_plugin_Coord_Tool_UI.png|thumb|400px|Coords Tool Interface]]
| |
|
| |
| The tool consists of three main sections:
| |
|
| |
| === 1. Coordinates ===
| |
| * '''Position''': X, Y, Z coordinates in world space
| |
| * '''Rotation''': Camera angles (Pitch, Yaw, Roll) in degrees
| |
|
| |
| === 2. 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
| |
|
| |
| === 3. Data ===
| |
| * '''Entries''': List of saved positions (most recent entry at the top)
| |
|
| |
| == Features ==
| |
|
| |
| === Navigate to Manual Coordinates ===
| |
|
| |
| # Enter the '''Position''' coordinates (X, Y, Z)
| |
| # Enter the '''Rotation''' (Pitch, Yaw, Roll) if needed
| |
| # Click '''« Go to coords »'''
| |
| # The camera instantly moves to this position
| |
|
| |
| === Copy Current Position ===
| |
|
| |
| # Position your camera at the desired location
| |
| # Click '''« Copy link to clipboard »'''
| |
| # A link in the format <code>enfusion://WorldEditor/...</code> is copied to the clipboard
| |
| # You can share this link with other developers
| |
|
| |
| '''Link format:'''
| |
| <syntaxhighlight>
| |
| enfusion://WorldEditor/worlds/world_name.ent;X,Y,Z;Yaw,Pitch,Roll
| |
| </syntaxhighlight>
| |
|
| |
| === Navigate from Clipboard ===
| |
|
| |
| # Copy an enfusion:// link (received from a colleague or generated previously)
| |
| # Click '''« Go to clipboard link »'''
| |
| # The camera moves to this position
| |
|
| |
| '''Accepted formats:'''
| |
| * <code>enfusion://WorldEditor/worlds/...;X,Y,Z;Pitch,Yaw,Roll</code>
| |
| * <code>https://enfusionengine.com/api/redirect?to=enfusion://...</code>
| |
| * <code>X,Y,Z;Pitch,Yaw,Roll</code> (simplified format)
| |
|
| |
| === Save an Entry to History ===
| |
|
| |
| # Position your camera
| |
| # Click '''« Add entry »'''
| |
| # A new entry is created with:
| |
| #* An automatic name: <code>Link #X (world_name)</code>
| |
| #* The complete position link
| |
| # The entry appears at the top of the '''Entries''' list
| |
|
| |
| '''Using a saved entry:'''
| |
| # Open the entry in the '''Entries''' list
| |
| # Copy the content of the '''Link''' field
| |
| # Click '''« Go to clipboard link »'''
| |
|
| |
| == Practical Use Cases ==
| |
|
| |
| === Example 1: Bug Documentation ===
| |
| <pre>
| |
| Problematic position found → Add entry → Share link in bug report
| |
| </pre>
| |
|
| |
| === Example 2: Collaborative Work ===
| |
| <pre>
| |
| 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
| |
| </pre>
| |
|
| |
| === 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:
| |
|
| |
| {| class="wikitable"
| |
| ! Message !! Meaning
| |
| |-
| |
| | <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>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>Error obtaining the link</code> || 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 ==
| |
|
| |
| {{Tip|Enable "Use Web Prefix" to create clickable links in web browsers (useful for wikis and documentation)}}
| |
|
| |
| {{Tip|Entries can be manually renamed for better organization}}
| |
|
| |
| {{Tip|Use the simple format <code>X,Y,Z;Pitch,Yaw,Roll</code> for quick annotations in your notes}}
| |
|
| |
| == Plugin Access ==
| |
|
| |
| '''Menu''': Tools → Coords Tool (icon 📍)
| |
|
| |
| '''Shortcut''': None by default
| |
|
| |
| == See Also ==
| |
|
| |
| * [[World Editor]]
| |
| * [[Enfusion Engine]]
| |
| * [[Arma Reforger Modding]]
| |
|
| |
| [[Category:World Editor]]
| |
| [[Category:Enfusion Tools]]
| |
| [[Category:Arma Reforger]]
| |
