Merge branch 'feature-parks'

src/RealTime/Core/RealTimeCore.cs

@@ -243,6 +243,7 @@ public void Stop()
             SimulationHandler.CitizenProcessor = null;
             SimulationHandler.Statistics?.Close();
             SimulationHandler.Statistics = null;
+            ParkPatches.SpareTimeBehavior = null;
 
             WorldInfoPanelPatches.CitizenInfoPanel?.Disable();
             WorldInfoPanelPatches.CitizenInfoPanel = null;
@@ -294,6 +295,7 @@ private static List<IPatch> GetMethodPatches()
                 UIGraphPatches.VisibleEndTime,
                 UIGraphPatches.BuildLabels,
                 WeatherManagerPatch.SimulationStepImpl,
+                ParkPatches.DistrictParkSimulation,
             };
 
             if (Compatibility.IsModActive(Compatibility.CitizenLifecycleRebalanceId))
@@ -342,6 +344,8 @@ private static bool SetupCustomAI(
             var travelBehavior = new TravelBehavior(gameConnections.BuildingManager);
             var workBehavior = new WorkBehavior(config, gameConnections.Random, gameConnections.BuildingManager, timeInfo, travelBehavior);
 
+            ParkPatches.SpareTimeBehavior = spareTimeBehavior;
+
             var realTimePrivateBuildingAI = new RealTimeBuildingAI(
                 config,
                 timeInfo,

src/RealTime/CustomAI/Constants.cs

@@ -29,6 +29,9 @@ internal static class Constants
         /// <summary>A chance in percent for a citizen to go shopping in the night.</summary>
         public const uint NightShoppingChance = 20u;
 
+        /// <summary>A chance in percent for a citizen to go to a leisure building in the night instead of usual entertainment.</summary>
+        public const uint NightLeisureChance = 70u;
+
         /// <summary>A chance in percent for a tourist to find a hotel for sleepover.</summary>
         public const uint FindHotelChance = 60;
 

src/RealTime/CustomAI/ISpareTimeBehavior.cs

@@ -9,6 +9,11 @@ namespace RealTime.CustomAI
     /// </summary>
     internal interface ISpareTimeBehavior
     {
+        /// <summary>
+        /// Gets a value indicating whether the fireworks in the parks are allowed at current time.
+        /// </summary>
+        bool AreFireworksAllowed { get; }
+
         /// <summary>
         /// Gets the probability whether a citizen with specified age would go relaxing on current time.
         /// </summary>

src/RealTime/CustomAI/RealTimeBuildingAI.cs

@@ -463,6 +463,15 @@ private bool ShouldSwitchBuildingLightsOff(ushort buildingId, ItemClass.Service
                 case ItemClass.Service.Monument:
                     return false;
 
+                case ItemClass.Service.Beautification when subService == ItemClass.SubService.BeautificationParks:
+                    byte parkId = buildingManager.GetParkId(buildingId);
+                    if (parkId == 0 || (buildingManager.GetParkPolicies(parkId) & DistrictPolicies.Park.NightTours) == 0)
+                    {
+                        goto default;
+                    }
+
+                    return false;
+
                 default:
                     return !workBehavior.IsBuildingWorking(service, subService);
             }

src/RealTime/CustomAI/RealTimeResidentAI.Visit.cs

@@ -16,6 +16,8 @@ private bool ScheduleRelaxing(ref CitizenSchedule schedule, uint citizenId, ref
             Citizen.AgeGroup citizenAge = CitizenProxy.GetAge(ref citizen);
 
             uint relaxChance = spareTimeBehavior.GetRelaxingChance(citizenAge, schedule.WorkShift, schedule.WorkStatus == WorkStatus.OnVacation);
+            relaxChance = AdjustRelaxChance(relaxChance, ref citizen);
+
             if (!Random.ShouldOccur(relaxChance) || WeatherInfo.IsBadWeather)
             {
                 return false;
@@ -33,7 +35,7 @@ private bool ScheduleRelaxing(ref CitizenSchedule schedule, uint citizenId, ref
             }
 
             schedule.Schedule(ResidentState.Relaxing);
-            schedule.Hint = TimeInfo.IsNightTime
+            schedule.Hint = TimeInfo.IsNightTime && Random.ShouldOccur(NightLeisureChance)
                 ? ScheduleHint.RelaxAtLeisureBuilding
                 : ScheduleHint.None;
 
@@ -93,6 +95,8 @@ private bool DoScheduledRelaxing(ref CitizenSchedule schedule, TAI instance, uin
                 schedule.WorkShift,
                 schedule.WorkStatus == WorkStatus.OnVacation);
 
+            relaxChance = AdjustRelaxChance(relaxChance, ref citizen);
+
             ResidentState nextState = Random.ShouldOccur(relaxChance)
                     ? ResidentState.Relaxing
                     : ResidentState.Unknown;
@@ -278,5 +282,14 @@ private bool RescheduleVisit(ref CitizenSchedule schedule, uint citizenId, ref T
 
             return false;
         }
+
+        private uint AdjustRelaxChance(uint relaxChance, ref TCitizen citizen)
+        {
+            ushort visitBuilding = CitizenProxy.GetCurrentBuilding(ref citizen);
+
+            return (BuildingMgr.GetBuildingSubService(visitBuilding) == ItemClass.SubService.BeautificationParks)
+                ? relaxChance * 2
+                : relaxChance;
+        }
     }
 }

src/RealTime/CustomAI/RealTimeTouristAI.cs

@@ -329,7 +329,7 @@ private uint GetTouristGoingOutChance(ref TCitizen citizen, TouristTarget target
                 case TouristTarget.Shopping:
                     return spareTimeBehavior.GetShoppingChance(age);
 
-                case TouristTarget.Relaxing when TimeInfo.IsNightTime || WeatherInfo.IsBadWeather:
+                case TouristTarget.Relaxing when WeatherInfo.IsBadWeather:
                     return 0u;
 
                 case TouristTarget.Party:

src/RealTime/CustomAI/SpareTimeBehavior.cs

@@ -46,6 +46,11 @@ public SpareTimeBehavior(RealTimeConfig config, ITimeInfo timeInfo)
             vacationChances = new uint[Enum.GetValues(typeof(Citizen.Wealth)).Length];
         }
 
+        /// <summary>
+        /// Gets a value indicating whether the fireworks in the parks are allowed at current time.
+        /// </summary>
+        public bool AreFireworksAllowed => timeInfo.CurrentHour >= timeInfo.SunsetHour && timeInfo.CurrentHour < config.GoToSleepHour;
+
         /// <summary>Sets the duration (in hours) of a full simulation cycle for all citizens.
         /// The game calls the simulation methods for a particular citizen with this period.</summary>
         /// <param name="cyclePeriod">The citizens simulation cycle period, in game hours.</param>

src/RealTime/GameConnection/BuildingManagerConnection.cs

@@ -373,6 +373,32 @@ public void DeactivateVisually(ushort buildingId)
             building.Info?.m_buildingAI.BuildingDeactivated(buildingId, ref building);
         }
 
+        /// <summary>Gets the ID of the park area where the building with specified ID is located. Returns 0 if the building
+        /// is not in a park.</summary>
+        /// <param name="buildingId">The ID of the building to get the park ID of.</param>
+        /// <returns>An ID of the park where the building is located, or 0.</returns>
+        public byte GetParkId(ushort buildingId)
+        {
+            if (buildingId == 0)
+            {
+                return 0;
+            }
+
+            Vector3 position = BuildingManager.instance.m_buildings.m_buffer[buildingId].m_position;
+            return DistrictManager.instance.GetPark(position);
+        }
+
+        /// <summary>Gets the policies for a park with specified ID. Returns <see cref="DistrictPolicies.Park.None"/>
+        /// if the specified park ID is 0 or invalid.</summary>
+        /// <param name="parkId">The ID of the park to get policies of.</param>
+        /// <returns>The policies of the park.</returns>
+        public DistrictPolicies.Park GetParkPolicies(byte parkId)
+        {
+            return parkId == 0
+                ? DistrictPolicies.Park.None
+                : DistrictManager.instance.m_parks.m_buffer[parkId].m_parkPolicies;
+        }
+
         private static bool BuildingCanBeVisited(ushort buildingId)
         {
             uint currentUnitId = BuildingManager.instance.m_buildings.m_buffer[buildingId].m_citizenUnits;

src/RealTime/GameConnection/IBuildingManagerConnection.cs

@@ -153,5 +153,17 @@ ushort FindActiveBuilding(
         /// <summary>Visually deactivates the building with specified ID without affecting its production or coverage.</summary>
         /// <param name="buildingId">The building ID.</param>
         void DeactivateVisually(ushort buildingId);
+
+        /// <summary>Gets the ID of the park area where the building with specified ID is located. Returns 0 if the building
+        /// is not in a park.</summary>
+        /// <param name="buildingId">The ID of the building to get the park ID of.</param>
+        /// <returns>An ID of the park where the building is located, or 0.</returns>
+        byte GetParkId(ushort buildingId);
+
+        /// <summary>Gets the policies for a park with specified ID. Returns <see cref="DistrictPolicies.Park.None"/>
+        /// if the specified park ID is 0 or invalid.</summary>
+        /// <param name="parkId">The ID of the park to get policies of.</param>
+        /// <returns>The policies of the park.</returns>
+        DistrictPolicies.Park GetParkPolicies(byte parkId);
     }
 }

src/RealTime/GameConnection/Patches/ParkPatches.cs

@@ -0,0 +1,57 @@
+// <copyright file="ParkPatches.cs" company="dymanoid">
+// Copyright (c) dymanoid. All rights reserved.
+// </copyright>
+
+namespace RealTime.GameConnection.Patches
+{
+    using System.Reflection;
+    using RealTime.CustomAI;
+    using SkyTools.Patching;
+
+    /// <summary>
+    /// A static class that provides the patch objects for the Park Life DLC related methods.
+    /// </summary>
+    internal static class ParkPatches
+    {
+        /// <summary>Gets the patch for the district park simulation method.</summary>
+        public static IPatch DistrictParkSimulation { get; } = new DistrictPark_SimulationStep();
+
+        /// <summary>Gets or sets the city spare time behavior.</summary>
+        public static ISpareTimeBehavior SpareTimeBehavior { get; set; }
+
+        private sealed class DistrictPark_SimulationStep : PatchBase
+        {
+            protected override MethodInfo GetMethod()
+            {
+                return typeof(DistrictPark).GetMethod(
+                    "SimulationStep",
+                    BindingFlags.Instance | BindingFlags.Public,
+                    null,
+                    new[] { typeof(byte) },
+                    new ParameterModifier[0]);
+            }
+
+            [System.Diagnostics.CodeAnalysis.SuppressMessage("Redundancy", "RCS1213", Justification = "Harmony patch")]
+            private static void Postfix(byte parkID)
+            {
+                if (SpareTimeBehavior == null)
+                {
+                    return;
+                }
+
+                ref DistrictPark park = ref DistrictManager.instance.m_parks.m_buffer[parkID];
+
+                if (!SpareTimeBehavior.AreFireworksAllowed)
+                {
+                    park.m_flags &= ~DistrictPark.Flags.SpecialMode;
+                    return;
+                }
+
+                if (park.m_dayNightCount == 6 || (park.m_parkPolicies & DistrictPolicies.Park.FireworksBoost) != 0)
+                {
+                    park.m_flags |= DistrictPark.Flags.SpecialMode;
+                }
+            }
+        }
+    }
+}

src/RealTime/RealTime.csproj

@@ -113,6 +113,7 @@
     <Compile Include="GameConnection\IToolManagerConnection.cs" />
     <Compile Include="GameConnection\ITransferManagerConnection.cs" />
     <Compile Include="GameConnection\IWeatherManagerConnection.cs" />
+    <Compile Include="GameConnection\Patches\ParkPatches.cs" />
     <Compile Include="GameConnection\Patches\TransferManagerPatch.cs" />
     <Compile Include="GameConnection\Patches\UIGraphPatches.cs" />
     <Compile Include="GameConnection\Patches\WeatherManagerPatch.cs" />