#region Copyright & License Information /* * Copyright 2007-2017 The OpenRA Developers (see AUTHORS) * 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.Traits; namespace OpenRA.Mods.Common.Traits { [Desc("Controls the game speed, tech level, and short game lobby options.")] public class MapOptionsInfo : ITraitInfo, ILobbyOptions, IRulesetLoaded { [Translate] [Desc("Descriptive label for the short game checkbox in the lobby.")] public readonly string ShortGameCheckboxLabel = "Short Game"; [Translate] [Desc("Tooltip description for the short game checkbox in the lobby.")] public readonly string ShortGameCheckboxDescription = "Players are defeated when their bases are destroyed"; [Desc("Default value of the short game checkbox in the lobby.")] public readonly bool ShortGameCheckboxEnabled = true; [Desc("Prevent the short game enabled state from being changed in the lobby.")] public readonly bool ShortGameCheckboxLocked = false; [Desc("Whether to display the short game checkbox in the lobby.")] public readonly bool ShortGameCheckboxVisible = true; [Desc("Display order for the short game checkbox in the lobby.")] public readonly int ShortGameCheckboxDisplayOrder = 0; [Translate] [Desc("Descriptive label for the tech level option in the lobby.")] public readonly string TechLevelDropdownLabel = "Tech Level"; [Translate] [Desc("Tooltip description for the tech level option in the lobby.")] public readonly string TechLevelDropdownDescription = "Change the units and abilities at your disposal"; [Desc("Default tech level.")] public readonly string TechLevel = "unrestricted"; [Desc("Prevent the tech level from being changed in the lobby.")] public readonly bool TechLevelDropdownLocked = false; [Desc("Display the tech level option in the lobby.")] public readonly bool TechLevelDropdownVisible = true; [Desc("Display order for the tech level option in the lobby.")] public readonly int TechLevelDropdownDisplayOrder = 0; [Translate] [Desc("Tooltip description for the game speed option in the lobby.")] public readonly string GameSpeedDropdownLabel = "Game Speed"; [Translate] [Desc("Description of the game speed option in the lobby.")] public readonly string GameSpeedDropdownDescription = "Change the rate at which time passes"; [Desc("Default game speed.")] public readonly string GameSpeed = "default"; [Desc("Prevent the game speed from being changed in the lobby.")] public readonly bool GameSpeedDropdownLocked = false; [Desc("Display the game speed option in the lobby.")] public readonly bool GameSpeedDropdownVisible = true; [Desc("Display order for the game speed option in the lobby.")] public readonly int GameSpeedDropdownDisplayOrder = 0; IEnumerable ILobbyOptions.LobbyOptions(Ruleset rules) { yield return new LobbyBooleanOption("shortgame", ShortGameCheckboxLabel, ShortGameCheckboxDescription, ShortGameCheckboxVisible, ShortGameCheckboxDisplayOrder, ShortGameCheckboxEnabled, ShortGameCheckboxLocked); var techLevels = rules.Actors["player"].TraitInfos() .ToDictionary(t => t.Id, t => t.Name); if (techLevels.Any()) yield return new LobbyOption("techlevel", TechLevelDropdownLabel, TechLevelDropdownDescription, TechLevelDropdownVisible, TechLevelDropdownDisplayOrder, new ReadOnlyDictionary(techLevels), TechLevel, TechLevelDropdownLocked); var gameSpeeds = Game.ModData.Manifest.Get().Speeds .ToDictionary(s => s.Key, s => s.Value.Name); // NOTE: The server hardcodes special-case logic for this option id yield return new LobbyOption("gamespeed", GameSpeedDropdownLabel, GameSpeedDropdownDescription, GameSpeedDropdownVisible, GameSpeedDropdownDisplayOrder, new ReadOnlyDictionary(gameSpeeds), GameSpeed, GameSpeedDropdownLocked); } void IRulesetLoaded.RulesetLoaded(Ruleset rules, ActorInfo info) { var gameSpeeds = Game.ModData.Manifest.Get().Speeds; if (!gameSpeeds.ContainsKey(GameSpeed)) throw new YamlException("Invalid default game speed '{0}'.".F(GameSpeed)); } public object Create(ActorInitializer init) { return new MapOptions(this); } } public class MapOptions : INotifyCreated { readonly MapOptionsInfo info; public bool ShortGame { get; private set; } public string TechLevel { get; private set; } public GameSpeed GameSpeed { get; private set; } public MapOptions(MapOptionsInfo info) { this.info = info; } void INotifyCreated.Created(Actor self) { ShortGame = self.World.LobbyInfo.GlobalSettings .OptionOrDefault("shortgame", info.ShortGameCheckboxEnabled); TechLevel = self.World.LobbyInfo.GlobalSettings .OptionOrDefault("techlevel", info.TechLevel); var speed = self.World.LobbyInfo.GlobalSettings .OptionOrDefault("gamespeed", info.GameSpeed); GameSpeed = Game.ModData.Manifest.Get().Speeds[speed]; } } }