New: Implement permissive sections

Route command .SectionP

Author: leezer3

assets/Languages/en-US.xlf

@@ -1466,6 +1466,15 @@
 					<trans-unit id="delimiter">
 						<source>\x20</source>
 					</trans-unit>
+					<trans-unit id="signal_access_invalid">
+						<source>The next section is not a permissive section.</source>
+					</trans-unit>
+					<trans-unit id="signal_access_denied">
+						<source>The next section is a permissive section, but access is not currently possible. Please wait and retry.</source>
+					</trans-unit>
+					<trans-unit id="signal_access_granted">
+						<source>Access to the next section has been granted.</source>
+					</trans-unit>
 					<trans-unit id="signal_proceed">
 						<source>You may proceed at [speed] [unit] with extreme caution.</source>
 					</trans-unit>

source/OpenBVE/System/Input/ProcessControls.Digital.cs

@@ -1380,6 +1380,9 @@ private static void ProcessDigitalControl(double TimeElapsed, ref Control Contro
 								break;
 						}
 						break;
+					case Translations.Command.AccessPermissiveSection:
+						TrainManager.PlayerTrain.ContactSignaller();
+						break;
 				}
 			}
 			else if (Control.DigitalState == DigitalControlState.Released)

source/OpenBveApi/Interface/Input/Commands.cs

@@ -315,7 +315,10 @@ public enum Command
 			/// <summary>Uncouples the rear coupling of a car</summary>
 			UncoupleRear,
 			/// <summary>Controls the DSD</summary>
-			DriverSupervisionDevice
+			DriverSupervisionDevice,
+			// Added in 1.11.2.0
+			/// <summary>Press to request permission from the signaller to access a permissive section</summary>
+			AccessPermissiveSection
 		}
 
 		/// <summary>Defines the possible command types</summary>

source/Plugins/Route.CsvRw/Namespaces/Track/Track.Commands.cs

@@ -29,6 +29,9 @@ internal enum TrackCommand
 		Section,
 		/// <summary>Adds a signalling section</summary>
 		SectionS,
+		/// <summary>Adds a permissive signalling section</summary>
+		/// <remarks>Must be value based</remarks>
+		SectionP,
 		/// <summary>Adds a signal object</summary>
 		SigF,
 		/// <summary>Adds a signal object</summary>

source/Plugins/Route.CsvRw/Namespaces/Track/Track.cs

@@ -461,6 +461,7 @@ private void ParseTrackCommand(TrackCommand Command, string[] Arguments, string
 					break;
 				case TrackCommand.Section:
 				case TrackCommand.SectionS:
+				case TrackCommand.SectionP:
 				{
 					if (!PreviewOnly)
 					{
@@ -531,7 +532,16 @@ private void ParseTrackCommand(TrackCommand Command, string[] Arguments, string
 								}
 							}
 
-							Data.Blocks[BlockIndex].Sections[n] = new Section(Data.TrackPosition, aspects, departureStationIndex, valueBased ? SectionType.ValueBased : SectionType.IndexBased);
+							SectionType type;
+							if (valueBased)
+							{
+								type = Command == TrackCommand.SectionP ? SectionType.PermissiveValueBased : SectionType.ValueBased;
+							}
+							else
+							{
+								type = Command == TrackCommand.SectionP ? SectionType.PermissiveIndexBased : SectionType.IndexBased;
+							}
+							Data.Blocks[BlockIndex].Sections[n] = new Section(Data.TrackPosition, aspects, departureStationIndex, type);
 
 
 							CurrentSection++;

source/RouteManager2/CurrentRoute.cs

@@ -170,7 +170,7 @@ public void UpdateSection(Section Section, out Section PreviousSection)
 			int zeroAspect = 0;
 			bool setToRed = false;
 
-			if (Section.Type == SectionType.ValueBased)
+			if (Section.Type == SectionType.ValueBased || Section.Type == SectionType.PermissiveValueBased)
 			{
 				// value-based
 				zeroAspect = 0;
@@ -312,6 +312,19 @@ public void UpdateSection(Section Section, out Section PreviousSection)
 				setToRed = true;
 			}
 
+			if ((Section.Type == SectionType.PermissiveValueBased || Section.Type == SectionType.PermissiveIndexBased) && Section.SignallerPermission == false)
+			{
+				// with a permissive section, check to see if the *previous* section holds the player train
+				// ignore for AI trains (we'll assume they can contact the signaller silently)
+				for (int i = 0; i < Section.PreviousSection.Trains.Length; i++)
+				{
+					if (Section.PreviousSection.Trains[i].Type == TrainType.LocalPlayerTrain || Section.PreviousSection.Trains[i].Type == TrainType.RemotePlayerTrain)
+					{
+						setToRed = true;
+					}
+				}
+			}
+
 			// free sections
 			int newAspect = -1;
 
@@ -344,7 +357,7 @@ public void UpdateSection(Section Section, out Section PreviousSection)
 			// change aspect
 			if (newAspect == -1)
 			{
-				if (Section.Type == SectionType.ValueBased)
+				if (Section.Type == SectionType.ValueBased || Section.Type == SectionType.PermissiveValueBased)
 				{
 					// value-based
 					Section n = Section.NextSection;

source/RouteManager2/SignalManager/Section.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Linq;
+using System.Runtime.CompilerServices;
 using OpenBveApi.Runtime;
 using OpenBveApi.Trains;
 
@@ -46,6 +47,8 @@ public class Section
 
 		internal double RedTimer;
 
+		public bool SignallerPermission;
+
 		/// <summary>Whether this section has been announced with accessibility in use</summary>
 		public bool AccessibilityAnnounced;
 

source/RouteManager2/SignalManager/SectionTypes.cs

@@ -4,9 +4,15 @@
 	public enum SectionType
 	{
 		/// <summary>A section aspect may have any value</summary>
-		ValueBased, 
-		
+		ValueBased,
+		/// <summary>A section aspect may have any value</summary>
+		/// <remarks>The section is held at red until the permissive key is pressed</remarks>
+		PermissiveValueBased,
+		/// <summary>Section aspect count upwards from zero (0,1,2,3....)</summary>
+		IndexBased,
 		/// <summary>Section aspect count upwards from zero (0,1,2,3....)</summary>
-		IndexBased
+		/// <remarks>The section is held at red until the permissive key is pressed</remarks>
+		PermissiveIndexBased
+
 	}
 }

source/TrainManager/Train/TrainBase.cs

@@ -10,6 +10,7 @@
 using OpenBveApi.Routes;
 using OpenBveApi.Runtime;
 using OpenBveApi.Trains;
+using RouteManager2;
 using RouteManager2.MessageManager;
 using RouteManager2.SignalManager;
 using RouteManager2.Stations;
@@ -1162,5 +1163,30 @@ public override void Couple(AbstractTrain Train, bool Front)
 			string message = Translations.GetInterfaceString(HostApplication.OpenBve, Front ? new[] { "notification", "couple_front" } : new[] { "notification", "couple_rear" }).Replace("[number]", trainBase.Cars.Length.ToString());
 			TrainManagerBase.currentHost.AddMessage(message, MessageDependency.None, GameMode.Normal, MessageColor.White, TrainManagerBase.CurrentRoute.SecondsSinceMidnight + 5.0, null);
 		}
+
+		public void ContactSignaller()
+		{
+			Section sct = TrainManagerBase.CurrentRoute.Sections[CurrentSectionIndex].NextSection;
+			if (sct.Type != SectionType.PermissiveValueBased && sct.Type != SectionType.PermissiveIndexBased)
+			{
+				// not a valid section to access
+				string s = Translations.GetInterfaceString(HostApplication.OpenBve, new[] { "message", "signal_access_invalid" });
+			}
+			else
+			{
+				if (sct.IsFree())
+				{
+					// section is free of trains, so can be permissively accessed
+					string s = Translations.GetInterfaceString(HostApplication.OpenBve, new[] { "message", "signal_access_granted" });
+					sct.SignallerPermission = true;
+				}
+				else
+				{
+					// not free, access denied
+					string s = Translations.GetInterfaceString(HostApplication.OpenBve, new[] { "message", "signal_access_denied" });
+					sct.SignallerPermission = false;
+				}
+			}
+		}
 	}
 }