RW Creator Manual - Web
RW Creator Manual - Web
1 INTRODUCTION........................................................... 3
1.1 The Tools Included with RailWorks ................................................. 3 1.2 General Tips ................................................................................ 3 1.3 Learning More ............................................................................. 3
2 WORLD EDITOR........................................................... 4
2.1 Getting started ............................................................................ 4
Note that the tools described herein can be used to change the material in any of the routes supplied with RailWorks. RailSimulator.com Limited will not be able to provide support for these elements of the product if you have changed it from the version initially supplied. This guide can only cover some of the features of the tools. We are continually developing the tools and adding to the documentation available for the product. Check www.railsimulator.com for the latest revisions to this manual and for additional guidance material. Before contacting us for help, we recommend that you check the website for: Updated manuals Fixes to known problems in the product (patches) Lists of Frequently Asked Questions (FAQs) Be aware that you need a high degree of specialist knowledge of railway systems, computer simulation and programming to fully use these tools. To use the tools described, your system must have the recommended specifications. Increasing your systems RAM, processor speed, sound cards, graphics cards and hard disk space, plus obtaining the latest hardware drivers, will further enhance the performance of the tools. Notes This documentation is Copyright RailSimulator.com Limited 2009. Use of the information in this manual and the tools provided in RailWork is subject to the terms of the End User Licence Agreement (EULA) which is displayed when the product is installed. All trademarks are copyright of their respective owners. Although RailSimulator.com Limited has taken reasonable care in the preparation of this manual, this information is provided as is and is subject to change. Please check www.railsimulator.com for any corrections or updates to this manual. Note that no guarantee as to the accuracy contained herein is given or implied by RailSimulator.com Limited.
Toolbox Tab (panel 1) ............................................................. 5 Browser Tab (panel 2) ............................................................. 6 Options Tab (panel 3) ............................................................. 6 Navigation Tab (panel 4) ........................................................ 6 Properties Tab (panel 5) ......................................................... 6 Status Bar (panel 6) ................................................................ 6 Tool Tip (panel 7) .................................................................... 6 Mode Select / Lock (panel 8) .................................................. 6
2.3 Tools common to all Toolbox activities ............................................ 7 2.4 Manipulating Objects using the World Editor .................................... 7
2.4.1 2.4.2 2.4.3 2.4.4 2.4.5 2.4.6 2.5.1 2.5.2 2.5.3 2.5.4 2.5.5
Object Placement .................................................................... 7 Object Selection ...................................................................... 7 Object Movement ..................................................................... 7 Selecting Multiple Objects ....................................................... 7 General Object Properties ....................................................... 8 Specific Object Types .............................................................. 8 Linear Object Placement ......................................................... 8 Linear Object Selection ........................................................... 9 Linear Object Movement ......................................................... 9 Linear Object Properties .......................................................... 9 Track Views ............................................................................. 9
2.7.2 Linear Object Toolbox Options ............................................. 10 2.7.3 Painting Toolbox Options ...................................................... 11 2.7.4 Scenario Editor Options ......................................................... 11
2.8 Properties Tab ........................................................................... 11
4.6.3 Fuel / Freight Pickup Instruction .......................................... 21 4.6.4 Placing a Consist Operation Instruction ............................... 22
5 PACKAGER................................................................. 23
5.1 Introduction .............................................................................. 23 5.2 Creating a Package ..................................................................... 23
2.8.1 Standard and Linear Objects ................................................. 12 2.8.2 Track Linked Objects ............................................................. 12 2.8.3 Track Properties .................................................................... 12
Creating a New Scenario ....................................................... 16 Editing an Existing Scenario ................................................. 16 Editing Scenario Properties ................................................... 16 Deleting a Scenario ............................................................... 17
4.3 Placing a Player Train ................................................................. 17 4.4 Adding a Driver .......................................................................... 17 4.5 Adding Intermediate Goals ........................................................... 18
Adding and Changing Intermediate Goals ............................ 18 Sequences of Similar Goals ................................................... 18 Setting and Changing Properties .......................................... 18 Multiple Destinations in One Instruction .............................. 19 Destination Specific Parameters ........................................... 19 Viewing Intermediate Goals .................................................. 19
4.6.1 Stop At Destination Instruction ............................................ 19 4.6.2 Pick Up Passengers Instruction ............................................. 20
1 Introduction
This manual helps you create your own virtual railway world with Rail Simulator 2: RailWorks. Using the tools described here, you will be able to create your own routes and scenarios, then create a package for distribution to other RailWorks users.
This manual serves as an introduction to creating your own virtual world. There are some things that are beyond the scope of this book and which are better described in the on-line reference material. Before you start exploring those areas, it is a good idea to fully understand the basics of route and Scenario creation in RailWorks. Note that, in particular, this manual does not explain the Asset Editor (nor the Blueprint Editor that is embedded in it). These tools require extensive knowledge of railway systems and software development tools and allow you to create your own rolling-stock, in-game assets, signalling systems etc.
Allows the characteristics of assets to be specified in great detail. Not described in this manual.
\ProgramFiles\Steam\steamapps\common\railworks\Content\Routes
If you change something in the supplied routes that makes
the software. This is nearly always quicker than trying to diagnose the fault. Switch on the Infrastructure Lock (see note below) to prevent accidental amendments to key Scenario data.
Please note that if you change any of the routes supplied with
The Scenario Editor (part of the World Editor) The Packager The Asset Editor
RailWorks 2 Creator Manual For more information about these tools and other advanced development topics please visit the RailWorks web site at www.railsimulator.com Here you will find:
2 World Editor
The World Editor allows you to create new routes or modify existing routes. This section introduces key World Editor tools and how to use them for simple route creation.
2.1 Getting started
The quickest way to create a new route is to base it on an existing route: 1. From the Routes Screen select the New Route option. 2. You will then see a list of route templates. Select a route template to use as a basis for your route. 3. Click on the Create link, and enter a name for your new route. Your new route will load and you will be placed in the World Editor. If you exit the World Editor you will notice that your new route appears in the list of available routes in the Routes screen. To subsequently edit your route: 1. From the Routes screen, select the route you just created. 2. Click on the Free Play link. 3. Once the route has loaded, move the mouse to the bottom of the screen to bring up the Main menu. 4. From the Main menu, click on the World Editor icon to open your editing tools.
The RailWorks Reference Manual wiki (a copy of which is also supplied with your game). This is continually being updated with new features. Tutorial Videos. A set of demonstration videos is supplied with your game, but see the web site for more. Forums. Register on the online forums to exchange tips and advice with other RailWorks users. Online Support and FAQs.
You can also access the World Editor at any time you are in the game and driving a train (during Free Roam Driving or when running a Scenario) by bringing up this menu and clicking on the World Editor icon.
RailWorks 2 Creator Manual Once you have entered the World Editor, you can use the following keyboard commands to move the camera (your point of view) freely around the route: Up/down/left/right arrow keys <CTRL> + up and down arrow keys Hold the right mouse button and move the mouse <SHIFT> + arrow keys Move the camera forwards, backwards and sideways. Move the camera up and down in the y axis Pivot the camera view Speed up camera movements
Saving Press the <F2> key at any time to save your route. You are also prompted to save: When you switch from the World Editor back to driving mode. When you open or close the Scenario toolbox. Exiting Press the Mode Switch button at the bottom right of the screen to return to the simulation. The numbers in the image above show you the position of the following tabs: 1. Toolbox tab 2. Browser tab 3. Options tab 4. Navigation tab 5. Properties tab 6. Status bar 7. Tool Tip 8. Mode Select/Lock tab Each of these is described in detail in the sections that follow. 2.2.1 Toolbox Tab (panel 1) Click on one of the icons at the top to display that toolboxs features. The four toolboxes are: Objects (house icon) Linear Objects (track icon) Painting (brush icon) Scenarios (train icon)
RailWorks 2 Creator Manual Which icon you have selected dictates the contents of the Browser tab underneath it. See next section below. 2.2.2 Browser Tab (panel 2) The Browser tab contains the objects that can be placed into the world when the Objects or Linear Objects toolboxes are selected in the Toolbox tab, and has three areas. At the top area is a set of icons representing available objects by category. The middle area contains a scrolled list of assets or objects you can use in your world. The bottom area shows the asset that iscurrently selected.
To jump to a route marker location, select one of the flags and click on the white arrow button.
2.2.5 Properties Tab (panel 5) The Properties tab allows you to change the properties of certain objects. The Properties tab opens automatically whenever you have performed an action that permits property editing.
2.2.3 Options Tab (panel 3) This Options tab shows the available options for each tool from the Toolbox tab, and changes as you select different tools. Also on this tab are radio buttons to toggle on/off the 1024m tiles boundary lines; series and point markers (if any have been set up for the route) and controls for the grid system overlay. 2.2.4 Navigation Tab (panel 4) The Navigation tab shows information on direction and orientation and consists of the following: 2.2.6 Status Bar (panel 6) The information displayed on the status bar depends on the toolbox currently selected on the toolbox panel. 2.2.7 Tool Tip (panel 7) Some objects in the simulation display information in the form of a tool tip, which hovers when the mouse is held over the object. Track information is displayed in the form of a tool tip. 2.2.8 Mode Select / Lock (panel 8)
Compass Longitude and Latitude Display 2D Map Route Marker button Shows the direction you are looking in Shows your current longitude and latitude. To jump to a different location, enter new coordinates into these fields, and press on the white arrow button. Toggles the 2D map on and off. Clicking on this icon opens a set of user-defined flags, or route markers, in the Properties panel. Use a route marker for quickly moving to certain parts of the route.
The panel at the bottom right of the screen provides two functions. The lock icon allows you to lock certain functionality to prevent you accidentally changing items in a route that will prevent the functioning of pre-existing Scenarios. To unlock the route, click the lock. To re-engage it, click the lock again. The Mode Switch icon takes you back to driving mode. If you are editing a route in Free Play mode and have not selected a train then the camera will remain detached when you return to driving mode, allowing you to fly
around the route and view it with the correct lighting and effects. If you entered the World Editor from a Scenario, or had already selected a train in Free Roam Driving, you will be returned to the locomotive when switching to drive mode.
RailWorks 2 Creator Manual in the Browser tab. Move over the 3D world and the object appears on the cursor ready for placement. Left click to place the object. Left click and drag to rotate the object before its placed. Once placed, another object of the same type becomes available on the cursor for repetitive placement. Right click to exit object placement. 2.4.2 Object Selection To manipulate an object in the 3D world, hold the mouse cursor over the object to highlight it, and left click on it to select it. 2.4.3 Object Movement A transform gizmo appears above a selected object, enabling detailed movement of the object: Left click and hold on the red arrow to move the object in the z axis. The green arrow moves it in the x axis. The blue arrow moves it in the y axis. The circular arrow rotates the object. The yellow ball allows you to free pivot the object. Double click the yellow ball to reset the object to its default orientation. Additional movement controls are from the keyboard. These tend to move the object more slowly offering finer control than using the transform gizmo: Key Movement
Moves the object up and down. Rotates the selected object clockwise and anticlockwise. Moves the object along the terrain towards and away from the camera. Snaps the object from its original height to the terrain height.
Paste
Display
Delete
Measure
Undo
Redo
2.4.4 Selecting Multiple Objects Holding the left mouse button and dragging the cursor over the terrain makes a circular lasso appear and widen. Release the left mouse button to select all objects within the lasso.
To select multiple objects with more precision, hold the <CTRL> key and left click on the individual objects. Whichever method you use to select multiple objects, a single transform gizmo is displayed that controls all of the selected objects. 2.4.5 General Object Properties Double left click on an object to open the Properties tab for that object. 2.4.6 Specific Object Types Some objects in the Objects toolbox have unique methods of placement, selection and movement: Track-Linked Objects Track-linked objects are objects/assets that have a specific connection with a point or area of a track, but which are not actually part of the track, such a water tower. To place a track-linked object: 1. Select the Objects toolbox to display a list of specific Objects in the Browser tab. 2. Select a track-linked object from this list. 3. Left click to place the object near the track, then move the mouse cursor towards the track. 4. A track link appears on the track. Left click to place this link. For objects which can span multiple tracks, such as mileposts, left click and hold, then drag across parallel tracks. A link appears on each track you move the mouse cursor over. Some signals have multiple links, which need to be placed at various places on the track network. Left click as many times as required on the relevant tracks to place all the track links. Track Markers Track markers are placed along the track for navigation in Scenarios. 1. Select the Object toolbox. 2. Select a linear marker from the available Objects in the Browser tab. Left click to place the start point. 3. Move the mouse and left click to mark the end point.
RailWorks 2 Creator Manual 4. Select an area marker from the Browser tab and left click to place it. When placed markers are selected, transform gizmos become visible along the edges. Water Tile/Decal Placement Select a water or decal tile (such as a tunnel hole decal) from the Browser tab and left click to place it. When water or decals are selected, transform gizmos become visible along the edges. Ambient Sounds Localised and ambient sounds are placed in the same way as normal objects. In the World Editor you can hear each sound as you move the camera close to it. There is also a sphere indicating the audible range of the sound.
RailWorks 2 Creator Manual 2.5.2 Linear Object Selection You can only select linear objects when the Object or Linear Object Toolbox is open. Select linear objects in the same way as other objects. 2.5.3 Linear Object Movement When you select a linear object, a transform gizmo appears as it does with other objects but without the yellow ball for orientation as linear objects cannot be tilted in this way. Some linear objects (mainly linear water objects) can be widened using the extra transform gizmo that appears. 2.5.4 Linear Object Properties Double left click on a linear object to open the Properties panel. Linear Object Tools
Select Tool Changes the properties of specific areas of linear objects (where available). Select the tool, left click on the linear object once to start the selection then drag the mouse along the linear object. Once the required length is selected left click again to finish and view the properties for that section. Splits linear objects into sections. Select the tool and place the cursor above a linear object to see a marker showing where the split will occur. Left click to complete the split. To split linear objects of multiple widths, such as four parallel tracks, place the cursor above the outer linear object. Hold the left mouse button and drag the mouse cursor perpendicular to the linear object so it spans the other linear objects. A series of indications appear of where the splits will occur. Left click again to complete the splits. Joins sections of linear objects of the same type together. Select the tool, left click on one of the linear objects you want to join, then click on the other object. Runs a linear object parallel to another linear object. After selecting a section of linear object using the select tool, select the offset tool and then select a type of linear object from the browser list. Left click on the end indicator of the yellow offset lines on the side you want the offset to occur. Welds valid junctions on track linear objects. When you select the Weld tool, a grey box indicator appears above all junctions that can be welded. Left click an indicator box to weld that junction Gradient Tool Cross Over Tool automatically. Important Note: You must weld any separate sections of track to form a continuous line. A train will derail if it runs over unwelded tracks. Creates cross over junctions on track linear objects. Select the tool then select a track linear object from the Browser tab and move over to a section of multiple tracks. An indicator appears representing the start of the cross over junction. Left click on a track and move the mouse over to a parallel track. An indicator appears, showing where the cross over will be placed. Left click again to complete the cross over. Click on the indicator above the cross over to create a symmetrical double cross over. Edits the gradient of a linear object. Select the tool and move the mouse cursor over a linear object. A gradient point appears under the cursor, along with any existing gradient points on the linear object. Click on the left mouse button to place a new gradient point; left click on an existing gradient point to select it ready for editing. Drag the mouse to alter the gradient points vertical setting. Drag over to parallel linear objects to create multiple perpendicular gradient points. To delete a gradient point, left click on it and press the <DELETE> key. To snap a gradient point to the terrain, select it and press L. Blend Tool Creates a blend of texture between two different types of track that are joined together. Select the tool, left click on the two tracks objects and they are blended together automatically.
Split Tool
Join Tool
2.5.5 Track Views To view a tracks properties, press the <SPACE> key to toggle between the following track properties: Fully rendered track (as it will appear in the game) Line type Line direction Line speed Track sounds Track-linked objects view
Offset Tool
Weld Tool
RailWorks 2 Creator Manual cameras current location, press T. When using this tool, you may find the camera is underground after the terrain extraction is complete. You can obtain SRTM data from ftp://e0srp01u.ecs.nasa.gov/srtm/version2 in the form of .hgt files. Place the .hgt files into this directory: ...\Program
Files\Steam\steamapps\common\railworks\DEM\SRTM\
You will need to create this folder if it is not already present. Note that RailSimulator.com Limited cannot guarantee future access to this site.
2.7 Options
This section describes the options that appear in the Options tab when each toolbox is open. 2.7.1 Common Options The following options are available for all toolboxes.
Tile Boundaries This allows you to switch on and off the display of tile boundaries in the 3D world. The tile the camera is currently above is highlighted with a white border and its number is displayed on the status panel. This allows you to switch on and off the display of route marker lines and flags. This allows you to toggle an overlay grid on and off. When switched on, a grid appears underneath the camera and objects in the world will then snap to a corner of the grid when moved. In the field next to this button you can enter a new value to modify the grid spacing (measured in metres).
Smooth Tool
Level Tool
Route Markers Noise Tool Creates undulations in the terrain. Select the tool, click and hold the left mouse button and move the cursor over the area of terrain where you want to create undulations. Snaps the terrain to linear objects. Select the tool, click and hold the left mouse button and move the cursor over a linear object to snap the terrain to that object. Paints the terrain with different textures. Select the tool, select a texture from the browser list then click and hold the left mouse button and move the cursor over the area of terrain you want to paint.
Grid
Snap Tool
2.7.2 Linear Object Toolbox Options When using the Linear Object toolbox the following additional options are available:
Parallel This allows you to define the number of parallel linear objects that can be placed. This allows the smooth transition from straight track to curved track.
Terrain Extraction Feature To allow you to create representative landscapes, RailWorks provides the ability to import publicly available mapping data. The facility is only available when the Object or Linear Object toolboxes are open and it allows you to insert an area of SRTM (Shuttle Radar Topography Mission) data. To automatically create nine tiles of realworld terrain data underneath the
Easement
10
Height Level
This defines the height above sea level that the terrain levels off to when using the height tool. If it is switched off, the terrain will level to the height of the area where you first start levelling. This defines the base width of flat terrain painted around the track when using the snap tool. This defines the cutting angle used to taper up the terrain when using the snap tool. This defines the embankment angle used to taper down the terrain when using the snap tool.
Cutting Angle
Manual Junctions
Embankment Angle
2.7.4 Scenario Editor Options When using the Scenario Editor, the following additional option is available.
2.7.3 Painting Toolbox Options When using the painting toolbox, the following additional options are available.
Brush Shape This allows you to choose between a square or circular brush for use with the paint tools. This allows you to change the brush size (measured in metres) to suit your current paint tool. This allows you to change how the edges appear when using painting tools. A low fall off value creates a harsh edge; a high fall off value creates a soft edge. This changes the transparency of the tool, making a stronger or weaker brush stroke. This increases the speed of the smooth and noise tools. Higher values are faster. Consist Select Enabling this allows you to select whole consists by clicking a single part of rolling stock within that consist.
Brush Size
For more information about creating Scenarios, see Creating and Editing
Scenarios.
Strength
This section describes the properties displayed when the Properties tab is open and you double click on an item in the world. You can change the properties as described below.
Speed
11
RailWorks 2 Creator Manual 2.8.1 Standard and Linear Objects All standard and linear objects have the following properties:
X,Y,Z Position Height Above Terrain Detail level Enter new coordinates and press the <ENTER> key to change an objects position on the terrain. Enter a distance and press the <ENTER> key to change the height an object appears above the terrain. This sets whether an object is visible when the simulation is run in low detail. Enter a new value and press the <ENTER> key. This displays an objects location and source file name. Line Direction Secondary Speed Limit and then change the track primary speed in the Properties tab before laying track. This allows you to change the secondary speed limit to the correct speed limit for a specific area of track. Select track for placement and then change the track secondary speed in the Properties tab before laying track. This allows you to change the line type. There are four predefined line types to choose from: Main Line Yard Passenger Freight Select track for placement and then change the track line type in the Properties tab before laying track. This allows you to change the line direction. There are two predefined line directions to choose from: Both Up / Down Toggle Select track for placement and then change the track direction in the Properties tab before laying track. This allows you to change the electrification. There are four predefined electrification types to choose from: None Overhead Wires Third Rail Fourth Rail Select track for placement and then change the track electrification in the Properties tab before laying track. When you select the overhead wires property, overhead wires are visibly added to the track. However, when you add third and fourth rails, these elements are not currently represented visually. Track Sound This allows you to change the track bed rumble, assigning a specific sound to the track. Select track for placement and then change the track bed rumble in the Properties tab before laying track.
Line Type
Object Name
2.8.2 Track Linked Objects These also have some of the following properties, depending on the particular object:
Milepost Speed Signs Marker Name This allows you to specify the number that appears on a milepost. This displays the speed limit which appears on a speed sign based on the properties of the track on which it is placed. Track markers contain a name field which allows you to enter an individual name for each siding, platform, and destination you place. These names must be unique and are used as navigation points in Scenarios. This allows you to enter an individual name for each transfer point, such as diesel refuel points, water towers or container cranes. These unique names are used as reference during Scenario creation. Electrification
Transfer Points
2.8.3 Track Properties For trains to run over the whole network effectively, the following track properties need to be set up correctly:
Track Type This allows you to choose which track type you laid. Select track for placement and then change the track type in the Properties tab before laying track. This allows you to change the primary speed limit to the correct speed limit for a specific area of track. Select track for placement
12
The image to the left shows where the base width (the flat area) (2) before the cutting (1) and embankment (3) values are applied. The cutting angle (affecting any terrain above track height) and embankment angle (affecting any value below track height takes effect) are applied depending on the value entered in those fields. The brush size is simply the size of the area affected by the settings. In the context of cuttings and embankments, brush falloff has little effect (you will notice the effect of falloff when raising or lowering large areas with a large brush size). Similarly, the choice of a square or round brush is largely irrelevant. 3.2.1 Using the Height Tool to Improve Terrain Models The Snap Tool described above is the main choice when creating cuttings and embankments but there will almost always be a need to make minor adjustments after the terrain has been modelled to get better results, especially when jagged, saw-toothed edges are inadvertently created. The Height Tool is the best and most accurate tool for fixing such areas. It allows you to raise and lower terrain by moving the mouse up and down. Select the Height tool from the Toolbox tab, having first selected the Painting toolbox.
3.2 Using the Snap tool to Snap your terrain to your track
The Snap Tool is used to deform the terrain so it snaps to the height of the track, or any other linear object within the tools radius. The Snap tool is accessed from the Toolbox tab, having first selected Linear Tools. The Snap tool has several settings which you can adjust. See the following image for an example of its use.
13
14
RailWorks 2 Creator Manual 5. Set intermediate goals Intermediate goals can include: stopping; waiting; picking up passengers, loading freight or fuel; or attaching or delivering individual wagons. These intermediate goals break the Scenario into manageable chunks and provide additional challenges for the player. 6. Perform a basic test Before going any further, fully test the Scenario with just one train. Ensure you are happy with all aspects of the Scenario before you add other trains. 7. Add AI (RailWorks controlled) trains To make your Scenario more realistic, add AI trains that run without user intervention. This creates additional challenges for the player. 8. Perform a full test Now test your scenario.
These provide a simple framework for exploring routes under different conditions. They provide a starting point, a time of day, a season and weather, but do not need to have any specific objective. Any train in a Free Roam Scenario can be driven by first clicking on it. There are no computer controlled (AI) trains in a Free Roam Scenario. In addition to setting environmental parameters, Standard Scenarios have a set of detailed objectives for the player to achieve. Only one train can be driven, with any other trains controlled by RailWorks.
Standard Scenarios
Free Roam and Standard Scenarios are represented by different Scenario markers.
15
RailWorks 2 Creator Manual 4.2.1 Creating a New Scenario If you are not already in the World Editor, go to the Routes screen and select a route on which to base your Scenario. Click on the Scenario link to go the Scenario screen. Choose any Scenario for that route, and then click on the Edit link. Once you are in the World Editor, 1. Click on the Scenario icon in the ToolBox Tab. 2. Select the type of Scenario marker (Free Roam or Standard) you require in the Browser Tab. 3. Choose where on the route you wish to place the start point for the Scenario. Tip: In Free Roam Scenarios, the marker will be used to determine the initial camera position, so it is a good idea to set it about 20 metres from where you expect to place your train. 4. Click the left mouse button to place the Scenario marker. 5. Click the right mouse button to prevent further Scenario markers being placed. 6. Double Click the scenario marker to open and edit the Scenario properties. 7. Set up the Scenario properties see section Editing Scenario Properties below. 8. Save the Scenario by pressing the <F2> key. 4.2.2 Editing an Existing Scenario If you are not using the World Editor, first select a route on which to base your Scenario, then click on the Scenario you wish to change and then press Edit. The simulation will load directly into Scenario Editor. Simply double click on the Scenario marker to change its properties. If you are already using the World Editor, first click on the Scenario icon in the Toolbox, then find the Scenario marker you wish to edit and double click on it. 4.2.3 Editing Scenario Properties To edit the Scenario properties, double left click the Scenario marker. This will reveal the Properties tab, detailing the properties of the Scenario. The image on the left shows the new scenario marker showing default properties.
Weather Season
Important note: Make sure you click on the correct Scenario marker. Markers for other Scenarios on the route may be visible. If you accidentally double click a different Scenario marker you will switch to editing that Scenario. A Scenario has the following properties:
Scenario Name Description Briefing This is the name which is displayed in the Scenario list for the route. The description that appears in the Scenario screen when a Scenario is selected. Once the Scenario has been selected and has loaded, the text in this field is the first thing a player will see, and will also appear when the player uses the Assignment Assistant. This can contain more technical information than the Description. This is the date of the Scenario in form dd/mm/yyyy, and is displayed in the Scenario. The numbers entered here will not determine the season or weather and are purely for information purposes. This value will indicate to a player the relative difficulty of the Scenario, where 1 is easy and 3 is hard. This information is provided as a guide and has no other impact on the Scenario. This is an estimate, in minutes, of the approximate duration of the Scenario. This information is provided as a guide for people wanting to play the Scenario and has no other impact on the Scenario. This is the start time of the Scenario, based on the 24 hour clock. The values entered here will determine the look of the route generated by RailWorks. Hint: Make sure you set the start time before placing any trains because changing this value afterwards will mean you have to update the start times of the trains too. There are a variety of pre-defined weather patterns to choose from. Selecting a season will affect the textures on the route as well as dawn and dusk times and general lighting, but will not affect the weather.
Date
Rating
Duration
Start Time
16
To save the Scenario, either press the <F2> key or start playing the Scenario by pressing the large Play button on the Mode Select/Lock tab at the bottom right of the screen. If you start driving, RailWorks will switch to the time of day and the season that the new Scenario specifies. 4.2.4 Deleting a Scenario You can not delete Scenarios from within the World Editor. Return to the Scenario screen, highlight the Scenario you want to remove and press the <DELETE> key.
RailWorks 2 Creator Manual If you have a combination of locomotive and tender or additional rolling stock, you can reverse the whole consist by holding down the <Ctrl> key, then clicking on each element you wish to reverse, then clicking on the orange arrow.
17
This section describes information that is common to all intermediate goals. Features specific to one type of goal will be considered separately. 4.5.1 Adding and Changing Intermediate Goals To add intermediate goals to your Scenario: 1. Select the desired instruction from the Scenario Tools in the Toolbox tab. 2. Click on the player locomotive. You will see the instruction icon placed behind the driver icon at the front of the locomotive. Further instructions will stack in the order in which they are placed. Instructions are carried out in order from front to back. If you want to change the order of the instructions, left click and drag it along to a new position. To delete an intermediate goal, select it and press the <DELETE> key or use the Delete icon. 4.5.2 Sequences of Similar Goals Particular commands, such as pick up passengers, may be repeated many times, so there is a shorthand way of achieving this by adding multiple instructions. See Multiple Destinations in One Instruction below. 4.5.3 Setting and Changing Properties Double-click the Instruction icon floating over the train to open the Properties tab. The following properties are common for all instructions:
Add Instruction Intermediate goals are based on performing an action (or even arriving) at a particular location. This instruction and the associated field specify the goal location. Multiple locations may be specified. To add an instruction, click on the green plus sign, and then select the name of a valid destination. You can navigate using the World Editor or using the 2D map to find the location. To delete one of the locations from the list, select the location you want to remove and then press the Delete icon. Click the magnifying glass icon to bring up a list of nearby destinations (use the 2D map for destinations that are further away).
Destination Property To set the destination: 1. Click the Set Destination icon in Scenario properties. 2. Select a valid destination in the World Editor. A valid destination can be a platform marker, a siding marker, a destination marker or a portal. Alternatively you can open the 2D map by pressing 9, pressing the Set Destination icon and selecting a location on the 2D map. If the train is a player train, the destination should be the same as the destination on the final instruction specified on the Scenario marker. AI Trains If the train is controlled by RailWorks then simply set the destination of where you want the train to go. The train will then set off at the time specified and try to find a path to its destination. Note: If there is no valid way of reaching the destination, perhaps due to signalling or the directionality of tracks, the AI train will get stuck. Change the destination or create intermediate goals to avoid this. Once an AI train has reached the destination it will stop.
18
The Consist Operation Instruction has a slightly different Properties tab. The image left shows the Properties tab for the Stop at Destination intermediate goal:
The average expected performance is set to 75% by default. Adjusting this value higher will create a stricter timetable and changing the value lower will create a more relaxed timetable. If this value is edited the anticipated arrival and departure times on this and all subsequent instructions will be updated. Editing this value is a good way to control the speeds of AI traffic on the route.
4.5.6 Viewing Intermediate Goals By pressing the Play button you can check the Assignment Assistant and see the instructions as the end user would when playing the scenario.
4.5.4 Multiple Destinations in One Instruction Using multiple destinations in one instruction is a useful shorthand and allows you to concatenate a number of similar instructions. In addition, the success, failure and completion messages apply to the whole sequence, so if you concatenated 5 passenger pickup instructions into one instruction, then no message would be displayed until the final destination is reached. If, rather than concatenating the destinations, you had specified these as individual steps, you would be able to issue messages after each destination. 4.5.5 Destination Specific Parameters Each individual instruction destination type shows information on the Properties tab, depending on the type of instruction that it is. You can edit these properties further by clicking on the instruction. The following properties are common to all instructions:
Handle Off Path If selected, RailWorks calculates the best path for the train based on all the values contained in the Scenario and then measures the player against that. Deviating from this path for a player trains results in an error, which could cause the player to fail the Scenario.
The image left shows how a single Stop At Destination instruction appears in the Description tab.
The image right shows how the same instruction appears in the assignments tab. Notice the large red cross indicates that the instruction has not been completed yet.
19
RailWorks 2 Creator Manual A valid destination for this type of instruction can be a platform marker, a siding marker or a destination marker. The Stop At Destination instruction would be treated as being unsuccessful if the player failed to stop at the required destination. If there are multiple destinations listed, failure to stop at any one of them will cause the unsuccessful message to be displayed. A Stop At Destination instruction containing multiple elements shows the name of the individual destinations, the anticipated arrival time, the anticipated departure time, the average expected performance % and the speed needed to complete the instruction. The following further options can be specified on individual elements of the Stop At Destination Instructions: TimeTabled
By default, instructions do not have to adhere to a strict timetable so the Time Table icon is covered with a red cross. If you wish the Scenario to fail if the calculated timetable is not met, click on the alarm clock icon to clear the cross. The player will fail the Scenario if the timetable target is not met. This is the speed at which the player needs to be travelling to complete the instruction. The default speed is 0MPH which is stationary. However, this value can be changed when destination needs to be passed at a certain speed. Using a Stop At Destination instruction with a speed of 1MPH is a good way to ensure the train takes a certain path. The train will be travelling at a speed of over 1MPH and thus will automatically complete the instruction and move to the next. This turns this instruction into a waypoint follower and is especially useful for controlling the exact paths of AI trains. You can use this mechanism to force the AI Train to follow a series of small steps and accurately control the timing of the steps. Instructions set to a speed of over 0MPH will not show up in the Assignment Assistant. However, they do appear in the Drivers Guide as a Next Destination.
If you try to add a destination that the train cannot access (this may be due to directionality of the track, or a break in the track) then the expected arrival and departure times are not displayed and are replaced with exclamation marks.
When this error happens, select another destination or carefully check the tracks between your train and the destination. Some reasons for this failure include: wrong track directionality; another train in the way; a gap in the track. 4.6.2 Pick Up Passengers Instruction Use a Pick Up Passengers instruction to specify the player should stop to collect passengers. All destination elements in a Pick Up Passengers instruction should be platforms. The player will fail the scenario if they fail to stop at the required destination or pull away before passenger boarding is complete. The separate elements of each destination instruction in the list show the name of the location of the Passenger Pick Up, the predicted arrival time, the predicted departure time and the average expected performance %.
MPH
The predicted arrival and departure times are not enforced unless the Time Tabled option is enabled (by clicking the crossed out alarm clock). Once the instruction becomes a timetabled instruction, these times determine whether the instruction is assessed as being successfully complete.
20
In a timetabled instruction, the arrival time is based on the start of the passenger loading process. This means that even if the process of passenger loading (which lasts 20-30 seconds) completes after the scheduled time, the instruction will still count as successful as long as it starts by the specified time. If you want to edit the arrival time (perhaps to make the Scenario harder or easier), you must alter the performance value, which is set to 75% by default. This is a value indicating how hard your train is expected to work. If your timetable is based on a lower value, such as 50%, then the time will increase, as RailWorks allows the player to take longer to reach the destination. To make timetabled Scenarios tougher, increase the performance value to reduce the expected arrival time. Departure times can be edited manually and are not based on the % performance value. On the Assignment Assistant menu the instructions will display and behave differently depending on whether the instruction is timetabled or not.
RailWorks 2 Creator Manual The player will fail a Fuel/Freight Pickup instruction if they fail to stop at the required destination or collect the fuel. The separate Fuel / Freight instructions in the list show the name of the transfer point and the average expected performance %. Setting Coal/Water/Diesel levels You can display the fuel levels of a diesel locomotive by double clicking the locomotive itself. In the case of some steam trains, you must double click the tender. Electric trains have no such properties. Examples of the fuel level properties tab are shown below:
A timetabled instruction lists both arrival and departure times. These times will remain fixed and not update. Non-timetabled instructions will periodically update the arrival and departure times based on current performance. 4.6.3 Fuel / Freight Pickup Instruction The Fuel/Freight Pickup instruction is used in freight scenarios to collect and deliver goods or refuel. To set a FuelFreight Pickup Instruction, click the green plus sign on the Properties tab, and select a valid Fuel/Freight Marker from the World Editor or from the 2D Map. The name of the marker will then appear in the list.
There is a sliding bar which you can use to set the start fuel level percentage for the locomotive in the scenario. If your scenario involves refuelling or filling with water, you might want to consider reducing the initial levels at the start of the scenario to enforce early refuelling. The number in the bottom field is the number displayed on the locomotive or tender and can also be edited from this properties tab.
21
Setting Wagon Load State By double clicking each freight wagon you can display its properties window and set whether its initial state is loaded or unloaded. You cannot load freight, such as coal, onto an already loaded wagon nor unload freight from an empty wagon.
RailWorks 2 Creator Manual 4.6.4 Placing a Consist Operation Instruction Consist Operation instructions allow you to set goals that involve collection and delivery of rolling stock into yards. Consist Operation Properties Tab Consist Operation properties are different to other Intermediate goals. The properties for Consist Operations are as follows:
Add to front
Viewing Fuel/freight Pickup Instructions By pressing the Play button you can check the Assignment Assistant and see the instructions as the end user would when playing the Scenario. How the instruction is worded is based on the type of transfer point that was selected: For a freight container crane the instruction displays as Pick up a Freight Container from <transfer point name> For fuel (coal / diesel / water) the instruction displays as Pick up Fuel <fuel type> from <transfer point name>; for example, Pick up Fuel (Coal) from Bath Coaling Stage. On the 2D map, water transfer points display as a water droplet, whereas diesel and freight transfer points display as a fuel pump, along with the name of the refuelling point being listed.
Add to Back Drop Off Operation Order
Use this button to create an instruction where the player must add rolling stock to the front of the locomotive. Click this button then click each item of rolling stock you want to hook up. Then click the siding, platform or destination where this rolling stock currently resides. The instruction will then be created with the numbers of the rolling stock listed. Use this button to create an instruction where the player must add rolling stock to the back of the locomotive. This button creates an instruction where rolling stock must be dropped off at a certain location. This is a check box that is on by default. With the box checked, the order in which the player completes the consist operation instructions is important. When it is unchecked the instructions can be completed in any order. Errors in the operation order are reported at the end of the Scenario. A message typed here will display as a pop-up when the operation is complete if no success or failure message is present. Consist operations normally generally have clear pass or fail criteria so text should be entered in the success/failure fields instead. This is the suggested duration of the instruction in minutes. Adjusting the length of time in this field will have an effect for the Arrive and Depart fields and the estimated timing of subsequent instructions. Exceeding this time will not fail the instruction; it is present as a guideline only. This message is displayed if the instruction is completed successfully.
Display message
Duration
22
5 Packager
5.1 Introduction
Routes, Scenarios and other assets (rolling stock etc) in RailWorks are made up of many individual elements, and so sharing material that you have created would be very laborious. The Packager provides the ability to aggregate large numbers of individual assets into Packages a single file containing lots of assets. Packages created with RailWorks have a *.rwp extension. Important note: When creating a package you must respect the ownership of material created by other individuals or companies. Under the terms of your end user licence, the assets provided with RailWorks can be freely included in any package you create, but other assets supplied by RailSimulator.com Limited or third parties may not permit you to do this. RailWorks enforces this protection by preventing you from including assets in your package that were originally supplied to you with the protection flag set.
Editing Individual Consist Operation Instructions Each separate Consist Operation instruction you create will show the location of the consist operation, the suggested duration, and the rolling stock involved. If more than one instruction is listed then there is a scroll bar which is used to view additional instructions. In this example, the first few wagon numbers (141203, 141205, etc) of the instruction are listed for reference, as well as the location (Cole Siding 3) where the consist operation will happen. Note that when the user is playing the scenario all of the wagon numbers will be displayed on the Assignment Assistant. Once the elements of the Consist Operation have been inserted, the following toggle is displayed for each elements individual properties
Train Order This is a toggled icon. When it is selected, the sequence in which the rolling stock is arranged is important. When it is off, the order of the rolling stock of the train can be in any order. Errors in the train order are reported to the user at the end of the Scenario.
The left hand side of the Packager screen shows your current assets listed in a directory structure. Clicking on a plus symbol will expand the tree structure so that individual files of a route or asset can be viewed. The right hand side shows the contents of the package you are creating. By default it is empty. You can build up a list of the required items that will be built into the package by checking the boxes next to the assets you wish to include in the package and click the right arrow button to include them. If you include assets that you then decide you do not need, simply check the box next to them in the right hand window and then click the left arrow button which removes them from the list.
23
RailWorks 2 Creator Manual When you have assembled all your assets, enter a name in the Author field and decide whether you wish this package to be protected or unprotected. Unprotected packages can be shared freely and the contents of these packages can be used by other route creators. If the package is flagged as protected then other content creators cannot use the assets within their own new packages. To finish the process, click the Create Package button where a dialogue will be displayed listing all assets within this package. Check the list and press OK if the list is correct. A name and location for the package to be saved can now be selected. A progress bar will be displayed while the package is being created.
24