World Editor – Arma Reforger
Lou Montana (talk | contribs) m (Text replacement - "|Modding|Tools|Official Tools" to "|Modding|Official Tools") |
Lou Montana (talk | contribs) m (Text replacement - "ized" to "ised") |
||
(9 intermediate revisions by 3 users not shown) | |||
Line 13: | Line 13: | ||
=== Create new World === | === Create new World === | ||
Create an entirely new world or a sub-scene of the currently loaded world. | Create an entirely new world or a sub-scene of the currently loaded world. Shortcut: {{Controls|Ctrl|N}} | ||
=== Load World === | === Load World === | ||
Load an existing world. | Load an existing world. Shortcut: {{Controls|Ctrl|O}} | ||
=== Save World === | === Save World === | ||
Save the currently loaded world. | Save the currently loaded world. Shortcut: {{Controls|Ctrl|S}} | ||
=== Go to World File === | === Go to World File === | ||
Line 29: | Line 29: | ||
=== Undo last action === | === Undo last action === | ||
Undo the last applied action to the world. Shortcut: {{Controls|Ctrl|Z}} | Undo the last applied action to the world. Shortcut: {{Controls|Ctrl|Z}} | ||
=== Redo last action === | === Redo last action === | ||
Reapply the last undone action. Shortcut: {{Controls|Ctrl|Y}} | Reapply the last undone action. Shortcut: {{Controls|Ctrl|Y}} | ||
=== Copy selected object === | === Copy selected object === | ||
Copy the currently selected object(s). Shortcut: {{Controls|Ctrl|C}} | Copy the currently selected object(s). Shortcut: {{Controls|Ctrl|C}} | ||
=== Paste on same position === | === Paste on same position === | ||
Paste the copied object(s) in the same position of the copied object. | Paste the copied object(s) in the same position of the copied object. Shortcut: {{Controls|Ctrl|Shift|V}} | ||
=== Cut selected object === | === Cut selected object === | ||
Cut the currently selected object(s). Shortcut: {{Controls|Ctrl|X}} | Cut the currently selected object(s). Shortcut: {{Controls|Ctrl|X}} | ||
=== Play Game === | === Play Game === | ||
Line 56: | Line 56: | ||
* '''Play in fullscreen''' - make the game play in full screen | * '''Play in fullscreen''' - make the game play in full screen | ||
* '''Play from camera position''' - place a player-controlled unit right on viewport's camera position | * '''Play from camera position''' - place a player-controlled unit right on viewport's camera position. Default unit is controlled by [[Arma_Reforger:Resource_Manager:_Options#Chimera_Global_Config|'''Default Player Controller''']] parameter in '''[[Arma Reforger:Resource Manager: Options#Chimera Global Config|Resource Manager options]]'''. | ||
* '''Server localhost''' - start the game with a background server.{{Feature|important|Connection is possible with direct IP - a real address, '''not''' a loopback address like e.g {{hl|127.0.0.1}}!}} | * '''Server localhost''' - start the game with a background server.{{Feature|important|Connection is possible with direct IP - a real address, '''not''' a loopback address like e.g {{hl|127.0.0.1}}!}} | ||
* '''Server localhost + PeerTool''' - start the game with a background server and local clients. Clients are created accordingly to PeerTools settings and connected to the local server. | * '''Server localhost + PeerTool''' - start the game with a background server and local clients. Clients are created accordingly to PeerTools settings and connected to the local server. | ||
{{Feature|informative|For Multiplayer Debugging, see {{ | {{Feature|informative|For Multiplayer Debugging, see {{Link|Arma Reforger:Script Editor#Debugging}}.}} | ||
=== Toggle Gizmo Space === | === Toggle Gizmo Space === | ||
Switch object manipulation tools (e.g. move, rotate) between World reference and Object reference. Shortcut: {{Controls|X}} | Switch object manipulation tools (e.g. move, rotate) between World reference and Object reference. Shortcut: {{Controls|X}} | ||
=== Entity select filter === | === Entity select filter === | ||
Line 77: | Line 77: | ||
=== Ground Manipulation Tool === | === Ground Manipulation Tool === | ||
Move the selected object(s) to the surface under the cursor, such as '''terrain''' surface, '''object''' surface or '''water''' surface. | Move the selected object(s) by dragging it with the mouse pointer to the surface under the cursor, such as '''terrain''' surface, '''object''' surface or '''water''' surface. Shortcut: {{Controls|Q}} | ||
{{Feature|informative|Not to be confused with {{ | {{Feature|informative|Not to be confused with {{Link|#Terrain Tool}}.}} | ||
=== Move Tool === | === Move Tool === | ||
Move the selected object(s) on the screen's plane: moving the mouse up will move the object higher compared to the current screen, mouse down lower, left and right to the screen's left and right, always keeping the same distance from the screen's plane. | Move the selected object(s) on the screen's plane: moving the mouse up will move the object higher compared to the current screen, mouse down lower, left and right to the screen's left and right, always keeping the same distance from the screen's plane. Shortcut: {{Controls|W}} | ||
This tool also provides the '''move''' widget on the selected object(s), represented by arrows along X, Y and Z axes (in world or object reference, based on '''Gizmo Space'''). Click and drag to change the values. | This tool also provides the '''move''' widget on the selected object(s), represented by colored arrows along <span style="color: red;">X</span>, <span style="color: green;">Y</span> and <span style="color: blue;">Z</span> axes (in world or object reference, based on '''Gizmo Space'''). Click and drag to change the values. | ||
=== Rotate Tool === | === Rotate Tool === | ||
Line 91: | Line 91: | ||
Rotate the selected object(s). | Rotate the selected object(s). | ||
This tool provides the '''rotate''' widget on the selected object(s), represented by | This tool provides the '''rotate''' widget on the selected object(s), represented by colored angular arcs between the axes <span style="color: red;">X</span>, <span style="color: green;">Y</span> and <span style="color: blue;">Z</span> (in world or object reference, based on '''Gizmo Space'''). Click and drag to change the values. Shortcut: {{Controls|E}} | ||
=== Scale Tool === | === Scale Tool === | ||
Line 97: | Line 97: | ||
Scale the selected object(s), meaning to shrink or expand the object. | Scale the selected object(s), meaning to shrink or expand the object. | ||
This tool provides the '''scale''' widget represented by a vertical bar along the Y axis. Click and drag to change the value. | This tool provides the '''scale''' widget represented by a vertical green bar along the <span style="color: green;">Y</span> axis. Click and drag to change the value. Shortcut: {{Controls|R}} | ||
=== Vector Entity Tool === | === Vector Entity Tool === | ||
Draw a polyline (multiple straight segments) or a spline (curve from points), used by various generators (forests, walls, lakes etc.). | Draw a polyline (multiple straight segments) or a spline (curve from points), used by various generators (forests, walls, lakes etc.). Shortcut: {{Controls|V}} | ||
=== Bounding Volume Tool === | === Bounding Volume Tool === | ||
Line 109: | Line 109: | ||
=== Terrain Tool === | === Terrain Tool === | ||
See | See {{Link|Arma Reforger:World Editor: Terrain Creation Tool#Sculpt}}. Shortcut: {{Controls|Ctrl|T}} | ||
=== Navmesh Tool === | === Navmesh Tool === | ||
Line 235: | Line 235: | ||
==== Unsorted ==== | ==== Unsorted ==== | ||
The | The uncategorised available settings. | ||
=== Tool Properties === | === Tool Properties === | ||
Line 246: | Line 246: | ||
=== Navigation === | === Navigation === | ||
With the mouse wheel alone {{Controls|MMB}} you can move the camera forward and backward. | |||
By | With the right mouse button {{Controls|RMB}} pressed: | ||
* By moving the mouse, you can change the orientation of the camera. | |||
* The mouse wheel {{Controls|MMB}} changes the speed at which the camera moves - scroll up to increase the speed, scroll down to decrease it. | |||
* Use the {{Controls|W}} and {{Controls|S}} keys to move the camera forward and backward along the camera orientation at the set speed. | |||
* Use the {{Controls|A}} and {{Controls|D}} keys to move the camera sideways. | |||
* Use the {{Controls|Q}} and {{Controls|Z}} keys to move the camera up and down. | |||
{{Controls|LMB}} Double-clicking an entity in the Hierarchy subwindow focuses the camera on that entity. Pressing the {{Controls|F}} key focuses on the currently selected entity as well. | |||
== Resource Browser/Prefab Library == | == Resource Browser/Prefab Library == | ||
Line 256: | Line 261: | ||
Both Resource Browser and Prefab Library are content browsers, and use a color code underlight for entity ({{hl|.et}}) types: | Both Resource Browser and Prefab Library are content browsers, and use a color code underlight for entity ({{hl|.et}}) types: | ||
* '''blue''': regular | * '''blue''': regular prefabs | ||
* '''purple''': Prefab Library entity | * '''purple''': Prefab Library entity | ||
* '''orange''': editable Prefab (used by in-game editor) | * '''orange''': [[Arma Reforger:Game Master: Editable Entities Configuration|editable Prefab]] (used by in-game editor) | ||
=== Resource Browser === | === Resource Browser === | ||
Line 264: | Line 269: | ||
The Resource Browser provides a view of all the data present and available in the game's data as well as the user's profile directory. | The Resource Browser provides a view of all the data present and available in the game's data as well as the user's profile directory. | ||
It shows the project's data structure (see [[Arma Reforger:Directory Structure|Directory Structure]]) and displays every data type (e.g. config, textures but also prefabs, etc.). | It shows the project's data structure (see [[Arma Reforger:Directory Structure|Directory Structure]]) and displays every data type (e.g. config, textures but also [[Arma Reforger:Prefabs Basics#Prefab|prefabs]], etc.). | ||
=== Prefab Library === | === Prefab Library === | ||
The Prefab Library offers an interface to browse Prefabs that are available in the game's data. | The Prefab Library offers an interface to browse [[Arma Reforger:Prefabs Basics#Prefab|Prefabs]] that are available in the game's data. | ||
Unlike the Resource Browser, it does not display content from sub-directories in the Entity Tab. | Unlike the Resource Browser, it does not display content from sub-directories in the Entity Tab. Prefab Library is also not available in Resource Manager, since its closely tied to world creation process. | ||
Prefabs are sorted by categories, represented by directories present in '''Data\PrefabLibrary''' (see Directory Structure): | Prefabs are sorted by categories, represented by directories present in '''Data\PrefabLibrary''' (see Directory Structure): | ||
Line 292: | Line 297: | ||
This tab is filled only when an entity is highlighted in the Entity Tab. | This tab is filled only when an entity is highlighted in the Entity Tab. | ||
{| class="wikitable" | {| class="wikitable valign-top" | ||
! Entry | |||
! Description | |||
|- | |||
| Place By | | Place By | ||
| Two options: | | Two options: |
Latest revision as of 22:07, 24 May 2024
Top Bar
The top bar contains World Editor quick access buttons grouped in three sections:
- Basic Actions
- Basic Tools
- Scripted Tools
These sections can be enabled or disabled using the right-click contextual menu on the top bar.
Create new World
Create an entirely new world or a sub-scene of the currently loaded world. Shortcut: Ctrl + N
Load World
Load an existing world. Shortcut: Ctrl + O
Save World
Save the currently loaded world. Shortcut: Ctrl + S
Go to World File
Display the loaded world into the Resource Browser.
Undo last action
Undo the last applied action to the world. Shortcut: Ctrl + Z
Redo last action
Reapply the last undone action. Shortcut: Ctrl + Y
Copy selected object
Copy the currently selected object(s). Shortcut: Ctrl + C
Paste on same position
Paste the copied object(s) in the same position of the copied object. Shortcut: Ctrl + ⇧ Shift + V
Cut selected object
Cut the currently selected object(s). Shortcut: Ctrl + X
Play Game
Play the current world. Default shortcut: F5
Multiple options appear by clicking on the side arrow:
- Play inside viewport - make the game play within the actual viewport
- Play in fullscreen - make the game play in full screen
- Play from camera position - place a player-controlled unit right on viewport's camera position. Default unit is controlled by Default Player Controller parameter in Resource Manager options.
- Server localhost - start the game with a background server.
- Server localhost + PeerTool - start the game with a background server and local clients. Clients are created accordingly to PeerTools settings and connected to the local server.
Toggle Gizmo Space
Switch object manipulation tools (e.g. move, rotate) between World reference and Object reference. Shortcut: X
Entity select filter
Set entity cursor selection from every, active or inactive layer(s).
Select parent entities
Select parent entities when selecting a child entity.
Ground Manipulation Tool
Move the selected object(s) by dragging it with the mouse pointer to the surface under the cursor, such as terrain surface, object surface or water surface. Shortcut: Q
Move Tool
Move the selected object(s) on the screen's plane: moving the mouse up will move the object higher compared to the current screen, mouse down lower, left and right to the screen's left and right, always keeping the same distance from the screen's plane. Shortcut: W
This tool also provides the move widget on the selected object(s), represented by colored arrows along X, Y and Z axes (in world or object reference, based on Gizmo Space). Click and drag to change the values.
Rotate Tool
Rotate the selected object(s).
This tool provides the rotate widget on the selected object(s), represented by colored angular arcs between the axes X, Y and Z (in world or object reference, based on Gizmo Space). Click and drag to change the values. Shortcut: E
Scale Tool
Scale the selected object(s), meaning to shrink or expand the object.
This tool provides the scale widget represented by a vertical green bar along the Y axis. Click and drag to change the value. Shortcut: R
Vector Entity Tool
Draw a polyline (multiple straight segments) or a spline (curve from points), used by various generators (forests, walls, lakes etc.). Shortcut: V
Bounding Volume Tool
Edit the entity's Bounding Box property with a visual tool.
Terrain Tool
See World Editor: Terrain Creation Tool - Sculpt. Shortcut: Ctrl + T
Generates navmesh, AI navigation grids.
Open Weather Editor
Open the Weather Editor panel.
Measure Tool
Measure length along one or multiple 3D lines (only works on a terrain entity).
Import Objects
Import objects from a CSV file.
See Objects Importer Tool dedicated article.
Autotest Tool
Run test classes through the Testing Framework.
Polyline Area Tool
Edit the selected polyline to make it a rectangle/circle according to provided parameters.
Windows Prefabs Generator Tool
Generate prefabs for destroyable windows.
Batch Prefabs operations tool
Coords Tool
Quickly navigate to a set of coordinates or generate a World Editor link to current position/orientation.
enfusion://WorldEditor/worlds/TutorialWorld/TutorialWorld.ent;16.3078,30.6084,14.5955;-10.8,48,0
Autospawner Tool
Spawn prefabs/XOBs from the Resource Browser's selected directory on a grid into an active layer.
Used for debug.
Export Map data
Export data of various types from the current world in profile directory (Documents\My Games\ArmaReforger\profile)
Import Shapefile
Import vector data from SHP file.
Export Geographic data
Export vector data as Geographical data in profile directory (Documents\My Games\ArmaReforger\profile)
Hierarchy/Create
Hierarchy
This sub-panel lists entities present in the world. Entities are grouped into layers for clarity.
Red = Entity
Blue = Prefab
Create
This sub-panel is a quick access to scripted entities that can be created in the world. Such entities can be user-defined by the EntityEditorProps class attribute.
Viewport
This is the 3D world render that allows to edit terrain or preview a mission setup.
By default, pressing Esc leaves the preview; F10 is a hardcoded equivalent to Esc (within World Editor) and can be used as a counterpart.
Object Properties/Tool Properties
Object Properties
This sub-panel is divided in sections - appearing sub-panels depend on the Entity's type; only the most common are described here:
Entity information
The Entity's root type is listed on the left, and on the right is a field to name the entity to be able to refer to it by script.
Components are then listed under the class.
The scope of changes brought in this interface can be set to the entity instance, the entity definition itself, modded entities, or the parent prefab(s).
Transformation
A way to change a lot of position and orientation values:
- coordinates
- angles
- scale (in range 0..1000)
General
Flags
- Traceable: the Entity can be detected via tracing methods
- Visible: the Entity is invisible in-game (still being visible in World Editor)
- Static: the Entity is expected to remain in position and will not be moved around
- Feature: the Entity is a "feature" of the terrain and will be drawn no matter the distance
- Proxy: the Entity is a sub-element of a prefab and should be hidden when the parent prefab is
- Editor Only: the Entity is present only in the editor
- Relative Y: the Entity's altitude will be relative to the surface below it
Script
Provide script "slots" for events and/or other cases
Unsorted
The uncategorised available settings.
Tool Properties
This sub-panel changes depending on the currently selected tool.
Viewport
With the mouse wheel alone you can move the camera forward and backward.
With the right mouse button pressed:
- By moving the mouse, you can change the orientation of the camera.
- The mouse wheel
changes the speed at which the camera moves - scroll up to increase the speed, scroll down to decrease it.
- Use the W and S keys to move the camera forward and backward along the camera orientation at the set speed.
- Use the A and D keys to move the camera sideways.
- Use the Q and Z keys to move the camera up and down.
Double-clicking an entity in the Hierarchy subwindow focuses the camera on that entity. Pressing the F key focuses on the currently selected entity as well.
Resource Browser/Prefab Library
Both Resource Browser and Prefab Library are content browsers, and use a color code underlight for entity (.et) types:
- blue: regular prefabs
- purple: Prefab Library entity
- orange: editable Prefab (used by in-game editor)
Resource Browser
The Resource Browser provides a view of all the data present and available in the game's data as well as the user's profile directory.
It shows the project's data structure (see Directory Structure) and displays every data type (e.g. config, textures but also prefabs, etc.).
Prefab Library
The Prefab Library offers an interface to browse Prefabs that are available in the game's data.
Unlike the Resource Browser, it does not display content from sub-directories in the Entity Tab. Prefab Library is also not available in Resource Manager, since its closely tied to world creation process.
Prefabs are sorted by categories, represented by directories present in Data\PrefabLibrary (see Directory Structure):
- Decals
- Generators
- Infrastructure
- Props
- Rocks
- Structures
- Vegetation
- Walls
Directory Tab
This shows the directory structure and allows the wanted directory to be picked.
Entity Tab
This lists the entities found in the open directory.
Details Tab
This tab is filled only when an entity is highlighted in the Entity Tab.
Entry | Description |
---|---|
Place By | Two options:
|
Random Yaw | Determine if a random yaw (Y-axis rotation, direction) should be applied on object's placement. Randomization is applied in a 0..360° range |
Align To Normal | Set if yes or no the entity should be placed perpendicular (normal) to the surface on which it is |
Random Scale | Define whether or not the entity should be randomly scaled, between min-max set values |
Random Vert Offset | Random Vertical Offset - define whether or not the entity should have a random vertical offset, between min-max (possibly negative) set values |
Random Pitch Angle | Define if and how much of a random pitch ("front/back roll") should be applied to the entity |
Random Roll Angle | Define if and how much of a random roll ("left/right (barrel) roll") should be applied to the entity |
Log Console
The Log Console displays error, warning and informative messages. It can be cleaned by pressing the Clear Console button.
It also displays three buttons that can be combined:
- Show only error messages: only shows "Error" and "Fatal" logs
- Show only warning messages: only shows "Warning" logs
- Show only info messages: only shows "Spam", "Verbose", "Debug", "Normal" logs
If no buttons are selected, the Log Console shows all the messages.
The last button, Filter Options, allows for advanced filtering as shown on the side.