Unified Driver Surveyor

From TrainzOnline
(Difference between revisions)
Jump to: navigation, search
(Saving Games, Sessions and Routes)
(Resetting Rules)
Line 34: Line 34:
  
 
==Resetting Rules==
 
==Resetting Rules==
Rules are used to "program" what happens within a session. For example, a Cinematic Camera Rule will define which item the camera is attached to and the path and speed the camera will take when the rule is triggered.
+
Session Rules control gameplay behaviour and logic within a Session. For example, the Cinematic Camera Rule will change the camera target and animate the camera position for a period when executed.
  
In UDS, Rules can now be reset to their original state, so that the Rule can be re-run if required.  
+
With the addition of UDS, an interface has been added to reset Rules to their original state, either for the whole list or individually. This allows you to reset gameplay within a Session, which is extremely useful for Session testing and development.
  
For example, if you've already hit a trigger required in a Trigger Check rule (and it shows as complete), but you adjust the session and now need to hit that trigger again, then you can manually reset the Trigger Check rule (in Edit Session) to make it active again.
+
For example if a Trigger Check rule has already been executed, but you edit the Session and now need to hit that trigger again, then you can manually reset the Trigger Check rule (in Edit Session) in order to retest that rule.
  
Another example is adding new Driver Commands to the Driver Setup rule. If the status shows as "Complete was-complete" then the new instructions will not be executed. To fix this, right click on the rule (in Edit Session in Surveyor) then Reset. This will change the rule to Paused. Click the Tick to save your changes, then switch modes to Driver
+
Another example is adding new Driver Commands to the Driver Setup rule. If the status shows as "Complete was-complete" then the new instructions will not be executed. To change this, right click on the rule (in Edit Session in Surveyor), select Reset, and this will change the rule to Paused. Click the Tick to save your changes, then switch modes to Driver and the Driver Setup rule will execute again.
  
 
==Using Undo==
 
==Using Undo==

Revision as of 17:50, 27 June 2019

Unified Driver Surveyor (UDS) replaces the concept of "Quickdrive" and greatly expands upon the capabilities previously provided. In short, the system allows you to switch back and forward between Driver Mode and Editor (Surveyor) Mode instantly. When you switch mode, the User Interface changes and functionality changes accordingly.

Contents

Change Modes

When in Driver, click the Tools button on the menu bar, then select "Surveyor Mode" to change to editing mode. The User Interface will change to the traditional Surveyor tool tabs and the new Surveyor Menubar options along the top. (A warning will appear the first time, and this can be hidden for future mode switches).

You will also notice that items that show only in Surveyor will now be visible, such as trackmarks, spline points, direction arrows on trains etc.

When in Surveyor, click the Tools button on the menu bar, then deselect "Surveyor Mode" to change to Driver Mode. The User Interface will change to the traditional Driver Mode.

Changes to existing behaviour

  • The Quickdrive option in the menu is removed. You can use "Create Session" to gain access to all of the Surveyor Tools prior to commencing your driving/operating session.
  • The Quickdrive button in Surveyor is removed, and it's default keyboard shortcut (Ctrl-F2) is now mapped to the Surveyor Mode toggle .
  • The Surveyor Mode toggle allows you to swap instantly from Driver to Surveyor and back again without any delay or loading screen.
  • A game pause control has been added to Surveyor (in the Tools Menu).
  • Switching modes does not pause the game automatically, so after switching from Driver to Surveyor your trains will keep moving.
  • The "Edit Trains" option is removed from Tools menu in Driver (replaced by Surveyor Mode).
  • Achievement progress is disabled if you activate Surveyor mode.
  • Session Rules can now be manually reset after entering Driver (see below for more details).
  • A number of Session Rules have been updated to correct flaws exposed by UDS, but many have not. See Session Rule Implementation for a programmers guide to correct Rule behaviour.

Saving Games, Sessions and Routes

The save options provided will be determined by which edits have been made.

  • If no edits have been made, then "Save" will prompt to "Save Driver Session" and create a "Saved Game" (asset kind "savegame").
  • A Save Game can be loaded from the View Sessions menu but cannot be edited directly.
  • After you load your saved game into Driver, you can still switch to Surveyor and edit as before.
  • If edits have been made, then wherever possible, saving will prompt to generate a savegame asset by default.
  • If edits have been made which are not compatible with the savegame asset type, you will be prompted save the Route and/or Session as appropriate.
  • Exit Driver will return you to the menu. If you want to return to Surveyor, simply change mode instead.

More to follow...

Resetting Rules

Session Rules control gameplay behaviour and logic within a Session. For example, the Cinematic Camera Rule will change the camera target and animate the camera position for a period when executed.

With the addition of UDS, an interface has been added to reset Rules to their original state, either for the whole list or individually. This allows you to reset gameplay within a Session, which is extremely useful for Session testing and development.

For example if a Trigger Check rule has already been executed, but you edit the Session and now need to hit that trigger again, then you can manually reset the Trigger Check rule (in Edit Session) in order to retest that rule.

Another example is adding new Driver Commands to the Driver Setup rule. If the status shows as "Complete was-complete" then the new instructions will not be executed. To change this, right click on the rule (in Edit Session in Surveyor), select Reset, and this will change the rule to Paused. Click the Tick to save your changes, then switch modes to Driver and the Driver Setup rule will execute again.

Using Undo

Undo is found in the Edit menu in Surveyor. Alternatively use the hotkeys Ctrl-Z and Ctrl-Y.

Given that trains can be in motion in Surveyor, Undoing certain actions (such as laying track) will result in derailments. However, it should be possible to use Redo to re-lay the track and the train will also be replaced.

It is likely that edge cases can be found where Undo, Redo does not do everything as you expect, so use common sense when using this option.

Practical examples:

Adding or Replacing Rolling Stock

Switch to Surveyor mode, open the Trains Tab, select a loco or rolling stock and place on the track (or open the Consist tab to create or place a whole train).

NOTE: Beware of trains in motion (we do not recommend editing moving trains).

Adding or Replacing Track

The normal restrictions of not being able to move track that has a train on it still apply. TIP: Lay a short section of track nearby, move your train to the new track, make your edits, them move the train back again and delete your temporary track.

Adding or Replacing Trackside Objects

Adding or moving signals, trackmarks or triggesis now so much quicker and easier.

Adding or Replacing Scenery Objects or Splines

Driving along and notice something missing or out of place? Switch to Surveyor, add, move or replace the item(s) then switch back to Driver mode.

Changing/Editing Environment Settings

With UDS you now have full control over weather, sky, lighting, colour etc. Note that certain rules (such as the weather rule) may override your Surveyor settings when the Driver session starts (of if you reset all rules).

Changing/Editing Session Rules

It is important to note that editing rules that are marked with a status of complete will not be executed when you switch to Driver mode. See Resetting Rules above for more detail.

Go back.png Go back to:

Personal tools