#region Copyright & License Information /* * Copyright (c) The OpenRA Developers and Contributors * This file is part of OpenRA, which is free software. It is made * available to you under the terms of the GNU General Public License * as published by the Free Software Foundation, either version 3 of * the License, or (at your option) any later version. For more * information, see COPYING. */ #endregion using System.Collections.Generic; using System.Linq; using OpenRA.Mods.Common.Widgets; using OpenRA.Traits; using OpenRA.Widgets; namespace OpenRA.Mods.Common.Traits { [TraitLocation(SystemActors.World)] [Desc("This trait allows setting a time limit on matches. Attach this to the World actor.")] public class TimeLimitManagerInfo : TraitInfo, ILobbyOptions, IRulesetLoaded { [TranslationReference] [Desc("Label that will be shown for the time limit option in the lobby.")] public readonly string TimeLimitLabel = "dropdown-time-limit.label"; [TranslationReference] [Desc("Tooltip description that will be shown for the time limit option in the lobby.")] public readonly string TimeLimitDescription = "dropdown-time-limit.description"; [Desc("Time Limit options that will be shown in the lobby dropdown. Values are in minutes.")] public readonly int[] TimeLimitOptions = { 0, 10, 20, 30, 40, 60, 90 }; [Desc("List of remaining minutes of game time when a text and optional speech notification should be made to players.")] public readonly Dictionary TimeLimitWarnings = new() { { 1, null }, { 2, null }, { 3, null }, { 4, null }, { 5, null }, { 10, null }, }; [Desc("Default selection for the time limit option in the lobby. Needs to use one of the TimeLimitOptions.")] public readonly int TimeLimitDefault = 0; [Desc("Prevent the time limit option from being changed in the lobby.")] public readonly bool TimeLimitLocked = false; [Desc("Whether to display the options dropdown in the lobby.")] public readonly bool TimeLimitDropdownVisible = true; [Desc("Display order for the time limit dropdown in the lobby.")] public readonly int TimeLimitDisplayOrder = 0; [Desc("Notification text for time limit warnings. The string '{0}' will be replaced by the remaining time in minutes, '{1}' is used for the plural form.")] public readonly string Notification = "{0} minute{1} remaining."; [Desc("ID of the LabelWidget used to display a text ingame that will be updated every second.")] public readonly string CountdownLabel = null; [Desc("Text to be shown using the CountdownLabel. The string '{0}' will be replaced by the time in hh:mm:ss format.")] public readonly string CountdownText = null; [Desc("Will prevent showing/playing the built-in time limit warnings when set to true.")] public readonly bool SkipTimeRemainingNotifications = false; [Desc("Will prevent showing/playing the built-in timer expired notification when set to true.")] public readonly bool SkipTimerExpiredNotification = false; void IRulesetLoaded.RulesetLoaded(Ruleset rules, ActorInfo info) { if (!TimeLimitOptions.Contains(TimeLimitDefault)) throw new YamlException("TimeLimitDefault must be a value from TimeLimitOptions"); } [TranslationReference] const string NoTimeLimit = "options-time-limit.no-limit"; [TranslationReference("minutes")] const string TimeLimitOption = "options-time-limit.options"; IEnumerable ILobbyOptions.LobbyOptions(MapPreview map) { var timelimits = TimeLimitOptions.ToDictionary(m => m.ToString(), m => { if (m == 0) return TranslationProvider.GetString(NoTimeLimit); else return TranslationProvider.GetString(TimeLimitOption, Translation.Arguments("minutes", m)); }); yield return new LobbyOption(map, "timelimit", TimeLimitLabel, TimeLimitDescription, TimeLimitDropdownVisible, TimeLimitDisplayOrder, timelimits, TimeLimitDefault.ToString(), TimeLimitLocked); } public override object Create(ActorInitializer init) { return new TimeLimitManager(init.Self, this); } } public class TimeLimitManager : INotifyTimeLimit, ITick, IWorldLoaded { [TranslationReference] const string TimeLimitExpired = "notification-time-limit-expired"; readonly TimeLimitManagerInfo info; readonly int ticksPerSecond; LabelWidget countdownLabel; CachedTransform countdown; int ticksRemaining; public int TimeLimit; public string Notification; public TimeLimitManager(Actor self, TimeLimitManagerInfo info) { this.info = info; Notification = info.Notification; ticksPerSecond = 1000 / self.World.Timestep; var tl = self.World.LobbyInfo.GlobalSettings.OptionOrDefault("timelimit", info.TimeLimitDefault.ToString()); if (!int.TryParse(tl, out TimeLimit)) TimeLimit = info.TimeLimitDefault; // Convert from minutes to ticks TimeLimit *= 60 * ticksPerSecond; } void IWorldLoaded.WorldLoaded(World w, OpenRA.Graphics.WorldRenderer wr) { if (string.IsNullOrWhiteSpace(info.CountdownLabel) || string.IsNullOrWhiteSpace(info.CountdownText)) return; countdownLabel = Ui.Root.GetOrNull(info.CountdownLabel); if (countdownLabel != null) { countdown = new CachedTransform(t => info.CountdownText.F(WidgetUtils.FormatTime(t, w.Timestep))); countdownLabel.GetText = () => TimeLimit > 0 ? countdown.Update(ticksRemaining) : ""; } } void ITick.Tick(Actor self) { if (TimeLimit <= 0) return; ticksRemaining = TimeLimit - self.World.WorldTick; if (ticksRemaining == 0) { foreach (var ntl in self.TraitsImplementing()) ntl.NotifyTimerExpired(self); foreach (var p in self.World.Players) foreach (var ntl in p.PlayerActor.TraitsImplementing()) ntl.NotifyTimerExpired(p.PlayerActor); return; } if (ticksRemaining < 0 || info.SkipTimeRemainingNotifications) return; foreach (var m in info.TimeLimitWarnings.Keys) { if (ticksRemaining == m * 60 * ticksPerSecond) { TextNotificationsManager.AddSystemLine(Notification.F(m, m > 1 ? "s" : null)); var faction = self.World.LocalPlayer?.Faction.InternalName; Game.Sound.PlayNotification(self.World.Map.Rules, self.World.LocalPlayer, "Speech", info.TimeLimitWarnings[m], faction); } } } void INotifyTimeLimit.NotifyTimerExpired(Actor self) { if (countdownLabel != null) countdownLabel.GetText = () => null; if (!info.SkipTimerExpiredNotification) TextNotificationsManager.AddSystemLine(TranslationProvider.GetString(TimeLimitExpired)); } } }