Difference between revisions of "Tutorials/Map Editor/Introduction to the Map Editor/Basic Editor Functions"

From SCS Modding Wiki
Jump to navigation Jump to search
(Map Editor Basic Tools)
 
m (update - 50keda - 042324)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
{{TutorialNavigation|previous=Launching the Map Editor|next=Saving, Loading, Sectors, and Files}}
 +
 
{{TutorialInfoBox
 
{{TutorialInfoBox
 
| topic = Map Editor Intro Part 2
 
| topic = Map Editor Intro Part 2
Line 4: Line 6:
 
| tools =  
 
| tools =  
 
[[Documentation/Tools/Map_Editor|Map Editor]]
 
[[Documentation/Tools/Map_Editor|Map Editor]]
| icon_file = Deer 01 1.png
+
| icon_file = Editor toolbar full.png
 
}}
 
}}
 
Now that we have the map editor loaded up, I will explain what each button does in the main toolbar and some common uses of them. As well as some helpful shortcut keys and useful notes. Advanced items, and explanation of the editor tools will be found in later tutorials.
 
Now that we have the map editor loaded up, I will explain what each button does in the main toolbar and some common uses of them. As well as some helpful shortcut keys and useful notes. Advanced items, and explanation of the editor tools will be found in later tutorials.
Line 12: Line 14:
 
|- style="vertical-align: top"
 
|- style="vertical-align: top"
 
| width="10px" | '''MAP'''
 
| width="10px" | '''MAP'''
| width="25%" | [[File:Deer 01 2.png|upright]]
+
| width="25%" | [[File:Editor toolbar map.png|upright]]
 
|}
 
|}
  
Line 29: Line 31:
 
| '''Run Map''' || Closes the editor and starts the game with a preview profile to test the currently opened map
 
| '''Run Map''' || Closes the editor and starts the game with a preview profile to test the currently opened map
 
|}
 
|}
<br>
+
 
<br>
+
 
 
{| class="wikitable" width="100%"
 
{| class="wikitable" width="100%"
  
 
|- style="vertical-align: top"
 
|- style="vertical-align: top"
 
| width="10px" | '''Edit Mode'''
 
| width="10px" | '''Edit Mode'''
| width="25%" | [[File:Deer 01 3.png|upright]]
+
| width="25%" | [[File:Editor toolbar editmode.png|upright]]
 
|}
 
|}
  
Line 76: Line 78:
 
| '''Mute all sounds''' || Mutes all sound
 
| '''Mute all sounds''' || Mutes all sound
 
|}
 
|}
<br>
+
 
<br>
+
 
 
{| class="wikitable" width="100%"
 
{| class="wikitable" width="100%"
  
 
|- style="vertical-align: top"
 
|- style="vertical-align: top"
 
| width="10px" | '''Snap'''
 
| width="10px" | '''Snap'''
| width="25%" | [[File:Deer-01-4.png|upright]]
+
| width="25%" | [[File:Editor toolbar snap.png|upright]]
 
|}
 
|}
  
Line 97: Line 99:
 
| '''Snap to All Static Collisions''' || Items will fall to ground or another objects collision model; IE. stacking two models on top of each other  
 
| '''Snap to All Static Collisions''' || Items will fall to ground or another objects collision model; IE. stacking two models on top of each other  
 
|}
 
|}
<br>
+
 
<br>
+
 
 
{| class="wikitable" width="100%"
 
{| class="wikitable" width="100%"
  
 
|- style="vertical-align: top"
 
|- style="vertical-align: top"
 
| width="10px" | '''Selection'''
 
| width="10px" | '''Selection'''
| width="25%" | [[File:Deer-01-5.png|upright]]
+
| width="25%" | [[File:Editor toolbar selection.png|upright]]
 
|}
 
|}
  
Line 112: Line 114:
 
| '''Lasso Selection''' || Select items by clicking and drawing a free form shape around them. Holding CTRL adds item to selection and holding ALT removes items from selection
 
| '''Lasso Selection''' || Select items by clicking and drawing a free form shape around them. Holding CTRL adds item to selection and holding ALT removes items from selection
 
|}
 
|}
<br>
+
 
<br>
+
 
 
{| class="wikitable" width="100%"
 
{| class="wikitable" width="100%"
  
 
|- style="vertical-align: top"
 
|- style="vertical-align: top"
 
| width="10px" | '''Camera'''
 
| width="10px" | '''Camera'''
| width="25%" | [[File:Deer-01-6.png|upright]]
+
| width="25%" | [[File:Editor toolbar camera.png|upright]]
 
|}
 
|}
  
 
{| class="wikitable" width="100%"
 
{| class="wikitable" width="100%"
 
|-
 
|-
| '''Top Camera''' || Top down view of the world used for getting the big picture and creating general layout of an area; the grid can only be seen using this mode
+
| '''Top Camera''' || Top down view of the world used for getting the big picture and creating general layout of an area; The grid can only be seen using this mode
 
|-
 
|-
 
| '''Free Camera''' || Allows you to fly around the map with W, A, S, D, Q, E, Scroll Wheel up/down
 
| '''Free Camera''' || Allows you to fly around the map with W, A, S, D, Q, E, Scroll Wheel up/down
Line 129: Line 131:
 
| '''Freeze camera view''' || Works much like the pause option in game; flying around with the free camera or newly placed objects will not render until the camera is unfrozen
 
| '''Freeze camera view''' || Works much like the pause option in game; flying around with the free camera or newly placed objects will not render until the camera is unfrozen
 
|}
 
|}
<br>
+
 
<br>
+
 
 
{| class="wikitable" width="100%"
 
{| class="wikitable" width="100%"
  
 
|- style="vertical-align: top"
 
|- style="vertical-align: top"
 
| width="10px" | '''Tools'''
 
| width="10px" | '''Tools'''
| width="25%" | [[File:Deer-01-7.png|upright]]
+
| width="25%" | [[File:Editor toolbar tools.png|upright]]
 
|}
 
|}
  
Line 148: Line 150:
 
| '''Find''' || Dialog box for finding all types of items with all types of identifiers (sector, UID, city, position, etc.)
 
| '''Find''' || Dialog box for finding all types of items with all types of identifiers (sector, UID, city, position, etc.)
 
|}
 
|}
<br>
+
 
<br>
+
 
 
{| class="wikitable" width="100%"
 
{| class="wikitable" width="100%"
  
 
|- style="vertical-align: top"
 
|- style="vertical-align: top"
 
| width="10px" | '''Item Type'''
 
| width="10px" | '''Item Type'''
| width="25%" | [[File:Deer-01-8.png|upright]]
+
| width="25%" | [[File:Editor toolbar item type.png|upright]]
 
|}
 
|}
  
Line 209: Line 211:
 
| '''Visibility area'''|| Performance item, used in managing what is visible to the player and where; works in tandem with cut planes
 
| '''Visibility area'''|| Performance item, used in managing what is visible to the player and where; works in tandem with cut planes
 
|}
 
|}
<br>
+
 
<br>
+
 
 
{| class="wikitable" width="100%"
 
{| class="wikitable" width="100%"
  
 
|- style="vertical-align: top"
 
|- style="vertical-align: top"
| width="10px" | '''Grid''' Defined the grid size in meters; the grid can only be seen in the top camera view!
+
| width="10px" | '''Grid''' Defined the grid size in meters
| width="25%" | [[File:Deer-01-9.png|upright]]
+
 
 +
 
 +
{{Tip| the grid can only be seen in the top camera view}}
 +
| width="25%" | [[File:Editor toolbar grid.png|upright]]
 
|}
 
|}
<br>
+
 
<br>
+
 
 
{| class="wikitable" width="100%"
 
{| class="wikitable" width="100%"
  
 
|- style="vertical-align: top"
 
|- style="vertical-align: top"
 
| width="10px" | '''Rotation''' Rotation step of an object in degrees; hold Shift to take effect
 
| width="10px" | '''Rotation''' Rotation step of an object in degrees; hold Shift to take effect
| width="25%" | [[File:Deer-01-10.png|upright]]
+
| width="25%" | [[File:Editor toolbar rotation.png|upright]]
 
|}
 
|}
<br>
+
 
<br>
+
 
 
{| class="wikitable" width="100%"
 
{| class="wikitable" width="100%"
  
 
|- style="vertical-align: top"
 
|- style="vertical-align: top"
 
| width="10px" | '''Gizmo'''
 
| width="10px" | '''Gizmo'''
| width="25%" | [[File:Deer-01-11.png|upright]]
+
| width="25%" | [[File:Editor toolbar gizmo.png|upright]]
 
|}
 
|}
  
Line 246: Line 251:
 
| '''Circle'''|| Aligns the move/rotation gizmo to be follow a circle; useful for roads and other curved objects
 
| '''Circle'''|| Aligns the move/rotation gizmo to be follow a circle; useful for roads and other curved objects
 
|}
 
|}
<br>
+
 
<br>
+
 
 
That is everything covered on the main toolbar and should get you started in the right direction. In future tutorials, we will examine more advanced tools and map debugging items.  
 
That is everything covered on the main toolbar and should get you started in the right direction. In future tutorials, we will examine more advanced tools and map debugging items.  
<br>
+
 
<br>
+
 
 
== Helpful Notes ==
 
== Helpful Notes ==
 
'''F1 Key''' - Opens help dialog where you can find all types of key shortcuts to make your life easier along with a few quick references<br>
 
'''F1 Key''' - Opens help dialog where you can find all types of key shortcuts to make your life easier along with a few quick references<br>
Line 257: Line 262:
 
''Help! I can't click items or open the console/dialog box in the editor'' - Minimize the editor and go to desktop. When you go back to editor everything should be working<br>
 
''Help! I can't click items or open the console/dialog box in the editor'' - Minimize the editor and go to desktop. When you go back to editor everything should be working<br>
 
''My editor crashes randomly or while saving/loading'' - Check the editor.log.txt to see the nature of the crash<br>
 
''My editor crashes randomly or while saving/loading'' - Check the editor.log.txt to see the nature of the crash<br>
 +
 +
 +
{{TutorialNavigation|previous=Launching the Map Editor|next=Saving, Loading, Sectors, and Files}}

Latest revision as of 14:01, 23 April 2024

Basic Editor Functions
Editor toolbar full.png
Topic: Map Editor Intro Part 2
Difficulty: Easy
Tools: Map Editor

Now that we have the map editor loaded up, I will explain what each button does in the main toolbar and some common uses of them. As well as some helpful shortcut keys and useful notes. Advanced items, and explanation of the editor tools will be found in later tutorials.

MAP Editor toolbar map.png
New Map Starts a new map
Load Map Loads an existing map
Save Map Saves the current map
Export Map Used for exporting a selection of your map as Selection Binary Data (SBD) or as an OBJ (useful in modeling programs) This can be used to copy sections of map or to aid in making a custom prefab or modeled object. See the Advanced tutorial to learn more
Import Map Importing SBD into currently loaded map
Run Map Closes the editor and starts the game with a preview profile to test the currently opened map


Edit Mode Editor toolbar editmode.png
New Item Opens the respective dialog box depending on the selected Item type to add new item
Move Item Movement tool on item to move along X, Y, Z axis
Scale Item Scale tool on applicable item to move along X, Y, Z axis
Delete Item Deletes selected item(s)
Item Properties Opens the respective dialog box depending on selected Item type to modify whole item
Node Properties Displays info about selected node including Type, UID, Rotation, Position, Locked, Free Rotation etc.
Place Start Places the start point for previewing the map (pink car in ETS2 / pink truck in ATS)
Height Moves a selected object along the Z axis
Rotate X Rotates selected item along X, Y, Z axis
Rotate Y Rotates selected item along X, Y, Z axis
Rotate Z Rotates selected item along X, Y, Z axis
Brush Used to paint textures on terrain and road item terrain and remove vegetation
Ruler Tool used to measure distance in meters, can be clicked multiple times to draw segments
Terrain Picker <Defunct>
Scene Preview <Defunct>
Traffic tool Used to check AI traffic flow, can also help find errors with road connections, see speed limits
Vertex tool Used to manipulate vertices on terrain quads; can build terrain look and seal gaps
Mute all sounds Mutes all sound


Snap Editor toolbar snap.png
Snap to nodes Nodes will snap to other nodes; used for connecting road/prefab pieces or stacking models
Snap to vertices Vertices will snap to other vertices; used with the vertex tool
Snap to grid Items will snap to points on the editor's grid
Snap to ground Items will fall to ground or other lowest point; another objects collision is ignored
Snap to All Static Collisions Items will fall to ground or another objects collision model; IE. stacking two models on top of each other


Selection Editor toolbar selection.png
Box Selection Select items by clicking and draging a box around them. Holding CTRL adds item to selection and holding ALT removes items from selection
Lasso Selection Select items by clicking and drawing a free form shape around them. Holding CTRL adds item to selection and holding ALT removes items from selection


Camera Editor toolbar camera.png
Top Camera Top down view of the world used for getting the big picture and creating general layout of an area; The grid can only be seen using this mode
Free Camera Allows you to fly around the map with W, A, S, D, Q, E, Scroll Wheel up/down
Freeze camera view Works much like the pause option in game; flying around with the free camera or newly placed objects will not render until the camera is unfrozen


Tools Editor toolbar tools.png
Content browser This window shows all assets in the game separated into categories; lots of information can be seen here regarding a particular asset - see the advanced tutorial for more info
Weather editor Allows you to edit the weather, sunlight, color, clouds, and DOF
Settings Settings for the editor including scale, zoom speed, and auto save time
Find Dialog box for finding all types of items with all types of identifiers (sector, UID, city, position, etc.)


Item Type Editor toolbar item type.png
Bezier Patch Placeable piece of terrain that can be configured in a few ways; good for patching up odd holes in the terrain
Buildings Lines of models used for decoration and function (invisable walls, tree walls, fences, etc.)
Camera Path Path for a cutscene camera to travel along
Camera point A stationary point that a camera rotates around IE first garage, first truck, etc.
City Item that defines city name and city size; new cities must be setup in game DEF files
Curve Similar to building item, however, these items have more options and are more flexible for complex situations depedning on item
Cut plane Performance item, used for controlling visibility of objects on either side of a plane
Cutscene Item to control game, map, and cutscene events
Far model Performance item, controls visibility of items at certain distances
Ferry Rail/ferry item to teleport player from one point to another as defined in game DEF files
Gate Animated gate that follow certain parameters or triggers
Hookup Places a model hookup item; see the tutorial on hookups
Map area Drawn item with 3 or more points that define some area on the gps or "fake" road/prefab
Map Overlay Item that puts an overlay on the map - icon, landmark, text, etc.
Model Model item from /def/world/model.sii
Mover Mover item from /def/world/mover.sii; an object that is animated or follows a path IE train, animals, people
No weather area A defined area where weather is effected; IG. for marking no rain inside tunnel or inside building, etc.
Prefab Models that have advanced uses and complex layouts and parts; companies, services, fuel stations, highway interchanges, joints, intersections, junctions, etc.
Road Main item used for connecting items together and options for connected terrain
Sign Editable signs/boards and static (unediatable) signs
Terrain Similar to road piece, but no road
Traffic area Drawn item with 3 or more points that define some area regarding how traffic will behave in certain situations
Trajectory Item that effects how vehicles behave in certain situations; used mostly with oversized missions and other road events
Trigger Drawn item with 2 or more points that define some area that triggers some object, script, event IE sleeping area
Visibility area Performance item, used in managing what is visible to the player and where; works in tandem with cut planes


Grid Defined the grid size in meters


TIP: the grid can only be seen in the top camera view

Editor toolbar grid.png


Rotation Rotation step of an object in degrees; hold Shift to take effect Editor toolbar rotation.png


Gizmo Editor toolbar gizmo.png
Global Aligns the move/rotation gizmo to be pointed in Northern direction
Local Aligns the move/rotation gizmo to be pointed in relation to the object
View Aligns the move/rotation gizmo to be pointed in relation to the camera view
Curve <Defunct>
Circle Aligns the move/rotation gizmo to be follow a circle; useful for roads and other curved objects


That is everything covered on the main toolbar and should get you started in the right direction. In future tutorials, we will examine more advanced tools and map debugging items.


Helpful Notes

F1 Key - Opens help dialog where you can find all types of key shortcuts to make your life easier along with a few quick references
F5 Key - Opens the mini gps view on the top right of the editor to help visualize what you are doing
Where did my items go? - Hit the A key a few times to toggle between showing background map, items, and map + items
Help! I can't click items or open the console/dialog box in the editor - Minimize the editor and go to desktop. When you go back to editor everything should be working
My editor crashes randomly or while saving/loading - Check the editor.log.txt to see the nature of the crash