Files
OpenRA/OpenRA.Mods.Common/Traits/World/ScriptLobbyDropdown.cs

76 lines
2.2 KiB
C#

#region Copyright & License Information
/*
* Copyright 2007-2020 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 OpenRA.Traits;
namespace OpenRA.Mods.Common.Traits
{
[Desc("Controls the map difficulty, tech level, and short game lobby options.")]
public class ScriptLobbyDropdownInfo : ITraitInfo, ILobbyOptions
{
[FieldLoader.Require]
[Desc("Internal id for this option.")]
public readonly string ID = null;
[Translate]
[FieldLoader.Require]
[Desc("Descriptive label for this option.")]
public readonly string Label = null;
[Translate]
[Desc("Tooltip description for this option.")]
public readonly string Description = null;
[FieldLoader.Require]
[Desc("Default option key in the `Values` list.")]
public readonly string Default = null;
[FieldLoader.Require]
[Desc("Difficulty levels supported by the map.")]
public readonly Dictionary<string, string> Values = null;
[Desc("Prevent the option from being changed from its default value.")]
public readonly bool Locked = false;
[Desc("Whether to display the option in the lobby.")]
public readonly bool Visible = true;
[Desc("Display order for the option in the lobby.")]
public readonly int DisplayOrder = 0;
IEnumerable<LobbyOption> ILobbyOptions.LobbyOptions(Ruleset rules)
{
yield return new LobbyOption(ID, Label, Description, Visible, DisplayOrder,
new ReadOnlyDictionary<string, string>(Values), Default, Locked);
}
public object Create(ActorInitializer init) { return new ScriptLobbyDropdown(this); }
}
public class ScriptLobbyDropdown : INotifyCreated
{
public readonly ScriptLobbyDropdownInfo Info;
public string Value { get; private set; }
public ScriptLobbyDropdown(ScriptLobbyDropdownInfo info)
{
Info = info;
}
void INotifyCreated.Created(Actor self)
{
Value = self.World.LobbyInfo.GlobalSettings.OptionOrDefault(Info.ID, Info.Default);
}
}
}