Changes between Version 20 and Version 21 of ScriptBuilder_ReferenceManual
- Timestamp:
- 02/13/2020 10:04:35 AM (6 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
ScriptBuilder_ReferenceManual
v20 v21 1 1 = Table of Contents = 2 ||[[#ScenarioOverviewWindow|Scenario Overview Window]]|| 3 ||[[#IncidentEditorWindow|Incident Editor Window]] || 4 ||[[#EventEditorWindow|Event Editor Window]] || 5 ||[[#incidentPalette|Incident Pool Window]] || 6 ||[[#unitsSub|Units]] || 7 8 2 || [[#ScenarioOverviewWindow|Scenario Overview Window]] || 3 ||[[#IncidentEditorWindow|Incident Editor Window]] || 4 ||[[#EventEditorWindow|Event Editor Window]] || 5 ||[[#incidentPalette|Incident Pool Window]] || 6 ||[[#unitsSub|Units #unitsSub|Units]] || 9 7 10 8 The TMC Academy Traffic Management Center Simulator attempts to re-create any and all scenarios that could be played out on a California roadway, in order to train management center personnel to respond to incidents and events occurring on said roadways. This requires the simulator to duplicate, as close as possible, the form and feel of the real working environment, as to well-prepare the students for working in the field. This user manual is directed towards the !ScriptBuilder component of the simulator, which is tasked with editing and creating new scenarios for the Simulation Manager to run. In its core, the Simulation Manager uses an XML file to store the scenario that is being simulated. Due to the clumsy nature of XML, editing said file is difficult and tedious. Thus, this application, !ScriptBuilder, was created in order to facilitate the editing and creation of scenarios for the Simulation Manager. … … 32 30 This menu bar accesses all of the different menus that are available to modify the current Scenario. 33 31 34 ==== Scenario 32 ==== Scenario ==== 35 33 [[Image(wiki:ScriptBuilder_ReferenceManual:overviewScenarioMenu.png, 150px)]] 36 34 37 This menu contains tools to open, save, and create scenarios. 38 ||New || Creates a new scenario. If the current scenario is not saved, then a dialog box confirming the creation of a new window will appear.|| 39 ||Open || Opens an existing scenario from a selected XML script in the file chooser. || 40 ||Save || Saves the scenario that is currently being edited. If it has not been saved before, the "Save As" menu appears. || 41 ||Save As|| Saves the scenario to a specified filename in the file chooser. || 35 This menu contains tools to open, save, and create scenarios. 42 36 43 ==== Generate 44 Not really sure what to put in this section 37 ||New || Creates a new scenario. If the current scenario is not saved, then a dialog box confirming the creation of a new window will appear.|| 38 ||Open || Opens an existing scenario from a selected XML script in the file chooser. || 39 ||Save || Saves the scenario that is currently being edited. If it has not been saved before, the "Save As" menu appears. || 40 || Save As || Saves the scenario to a specified filename in the file chooser. || 45 41 46 ==== Incidents 42 ==== Generate ==== 43 Reserved for future use. 44 45 ==== Incidents ==== 47 46 [[Image(wiki:ScriptBuilder_ReferenceManual:overviewIncidentMenu.png, 150px)]] 48 47 49 48 This menu contains tools to create, modify, delete, load, and save individual incidents. 50 49 51 ||New Incident... || Adds a new incident to the scenario, bringing up the [[#incidentProperties | incident properties]] window.||50 ||New Incident... || Adds a new incident to the scenario, bringing up the [[#incidentProperties | incident properties]] window. || 52 51 ||Edit Incident... || Opens a dialog box with a chooser to select which incident to edit, then opens the [[#incidentProperties | incident properties]] window of that incident. || 53 ||Delete Incident || Opens a dialog box with a chooser to select which incident to edit, and on conformation, deletes the incident.||54 ||Save Incident... || Opens a dialog box to select which incident to save, and the opens a file chooser to save the singular incident (typically to incident pool) 55 ||Load Incident... || Opens the [[#incidentPalette | incident palette]] window in order to add pre-fabricated incidents to the scenario. 52 ||Delete Incident || Opens a dialog box with a chooser to select which incident to edit, and on conformation, deletes the incident. || 53 ||Save Incident... || Opens a dialog box to select which incident to save, and the opens a file chooser to save the singular incident (typically to incident pool) || 54 ||Load Incident... || Opens the [[#incidentPalette | incident palette]] window in order to add pre-fabricated incidents to the scenario. || 56 55 57 ==== Units 58 This menu contains a tool to optionally load in extra units .56 ==== Units ==== 57 This menu contains a tool to optionally load in extra units (CHP patrollers). The tool has a default set of units that are embedded into every script when it is saved. This option allows the author to provide an external file containing additional units that are to included in the script. 59 58 60 59 [[Image(wiki:ScriptBuilder_ReferenceManual:overviewUnitMenu.png, 200px)]] 61 60 62 || Load Additional Units...|| Opens a file chooser to load in extra units from an external units XML file to be used in the scenario ||61 || Load Additional Units... || Opens a file chooser to load in extra units from an external units XML file to be used in the scenario || 63 62 64 === Scenario Overview Window Timeline 65 63 === Scenario Overview Window Timeline === 66 64 [[Image(wiki:ScriptBuilder_ReferenceManual:overviewTimeline.png, 800px)]] 67 65 68 The main content of the scenario overview window is a timeline that displays all of the incidents that are contained currently in the scenario. It is automatically updated any time an incident or an event within an incident is added to the scenario. This timeline displays events contained at certain times as triangles indicating either one or more events at that time. 66 The main content of the scenario overview window is a timeline that displays all of the incidents that are contained currently in the scenario. It is automatically updated any time an incident or an event within an incident is added to the scenario. This timeline displays events contained at certain times as triangles indicating either one or more events at that time. 69 67 70 68 [[Image(wiki:ScriptBuilder_ReferenceManual:overviewRightClickMenu.png, 250px)]] … … 72 70 Right-clicking on the incident of choice opens up a menu, allowing edits to the incident properties, and the events themselves in the incident to be made. 73 71 74 ||Events 75 ||Properties || Opens the [[#incidentProperties | incident properties]] window. 72 ||Events || Opens the [[#IncidentEditorWindow | incident editor window]], allowing for the incident to be edited. || 73 ||Properties || Opens the [[#incidentProperties | incident properties]] window. || 76 74 77 === Incident Properties #incidentProperties 78 75 === Incident Properties === #incidentProperties 79 76 [[Image(wiki:ScriptBuilder_ReferenceManual:incidentPropertiesWindow.png, 250px)]] 80 77 81 ||Incident Number || Number identifier of incident.||82 ||Incident Name || Name of incident||83 ||Incident Color 84 ||Incident Location || Location of incident.||85 ||Incident Type || Type of incident.||86 ||Incident Description || Short description of incident. 87 ||Incident Start Time || Time between scenario start and start of the incident.||88 ||Incident Length || Length of the incident (will be populated once events are added).||78 ||Incident Number || Number identifier of incident. || 79 ||Incident Name || Name of incident || 80 ||Incident Color || Identifying color of the incident (for the purposes of the !ScriptBuilder only. || 81 ||Incident Location || Location of incident. || 82 ||Incident Type || Type of incident. || 83 ||Incident Description || Short description of incident. || 84 ||Incident Start Time || Time between scenario start and start of the incident. || 85 ||Incident Length || Length of the incident (will be populated once events are added). || 89 86 90 87 Selecting "Cancel" will NOT save any changes made, while selecting "Ok" will. … … 94 91 == Incident Palette Window == #incidentPalette 95 92 == Units == #unitsSub 96 97 98 99 100 93 {{{ 101 94 Script Builder tutorial
