Files
OpenRA/OpenRA.Mods.Common/Widgets/Logic/MainMenuLogic.cs
RoosterDragon bb17cfa179 Expose mod.yaml content to localisation.
Mod metadata, load screens and mod content is all now sourced from ftl files, allowing these items to be translated.

Translations are now initialized as part of ModData creation, as currently they are made available too late for the usage we need here.

The "modcontent" mod learns a new parameter for "Content.TranslationFile" - this allows a mod to provide the path of a translation file to the mod which it can load. This allows mods such as ra, cnc, d2k, ts to own the translations for their ModContent, yet still make them accessible to the modcontent mod.

CheckFluentReference learns to validate all these new fields to ensure translations have been set.
2024-10-07 12:38:40 +03:00

592 lines
17 KiB
C#

#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;
using System.Collections.Generic;
using System.Globalization;
using System.IO;
using System.Linq;
using System.Threading.Tasks;
using OpenRA.Network;
using OpenRA.Support;
using OpenRA.Widgets;
namespace OpenRA.Mods.Common.Widgets.Logic
{
public class MainMenuLogic : ChromeLogic
{
[FluentReference]
const string LoadingNews = "label-loading-news";
[FluentReference("message")]
const string NewsRetrivalFailed = "label-news-retrieval-failed";
[FluentReference("message")]
const string NewsParsingFailed = "label-news-parsing-failed";
[FluentReference("author", "datetime")]
const string AuthorDateTime = "label-author-datetime";
protected enum MenuType { Main, Singleplayer, Extras, MapEditor, StartupPrompts, None }
protected enum MenuPanel { None, Missions, Skirmish, Multiplayer, MapEditor, Replays, GameSaves }
protected MenuType menuType = MenuType.Main;
readonly Widget rootMenu;
readonly ScrollPanelWidget newsPanel;
readonly Widget newsTemplate;
readonly LabelWidget newsStatus;
readonly ModData modData;
// Update news once per game launch
static bool fetchedNews;
protected static MenuPanel lastGameState = MenuPanel.None;
bool newsOpen;
void SwitchMenu(MenuType type)
{
menuType = type;
DiscordService.UpdateStatus(DiscordState.InMenu);
// Update button mouseover
Game.RunAfterTick(Ui.ResetTooltips);
}
[ObjectCreator.UseCtor]
public MainMenuLogic(Widget widget, World world, ModData modData)
{
this.modData = modData;
rootMenu = widget;
// Menu buttons
var mainMenu = widget.Get("MAIN_MENU");
mainMenu.IsVisible = () => menuType == MenuType.Main;
mainMenu.Get<ButtonWidget>("SINGLEPLAYER_BUTTON").OnClick = () => SwitchMenu(MenuType.Singleplayer);
mainMenu.Get<ButtonWidget>("MULTIPLAYER_BUTTON").OnClick = OpenMultiplayerPanel;
var contentButton = mainMenu.GetOrNull<ButtonWidget>("CONTENT_BUTTON");
if (contentButton != null)
{
var hasContent = modData.Manifest.Contains<ModContent>();
contentButton.Disabled = !hasContent;
contentButton.OnClick = () =>
{
// Switching mods changes the world state (by disposing it),
// so we can't do this inside the input handler.
Game.RunAfterTick(() =>
{
if (!hasContent)
return;
var content = modData.Manifest.Get<ModContent>();
string translationPath;
using (var fs = (FileStream)modData.DefaultFileSystem.Open(content.Translation))
translationPath = fs.Name;
Game.InitializeMod(
content.ContentInstallerMod,
new Arguments(new[] { "Content.Mod=" + modData.Manifest.Id, "Content.TranslationFile=" + translationPath }));
});
};
}
mainMenu.Get<ButtonWidget>("SETTINGS_BUTTON").OnClick = () =>
{
SwitchMenu(MenuType.None);
Game.OpenWindow("SETTINGS_PANEL", new WidgetArgs
{
{ "onExit", () => SwitchMenu(MenuType.Main) }
});
};
mainMenu.Get<ButtonWidget>("EXTRAS_BUTTON").OnClick = () => SwitchMenu(MenuType.Extras);
mainMenu.Get<ButtonWidget>("QUIT_BUTTON").OnClick = Game.Exit;
// Singleplayer menu
var singleplayerMenu = widget.Get("SINGLEPLAYER_MENU");
singleplayerMenu.IsVisible = () => menuType == MenuType.Singleplayer;
var missionsButton = singleplayerMenu.Get<ButtonWidget>("MISSIONS_BUTTON");
missionsButton.OnClick = () => OpenMissionBrowserPanel(modData.MapCache.PickLastModifiedMap(MapVisibility.MissionSelector));
var hasCampaign = modData.Manifest.Missions.Length > 0;
var hasMissions = modData.MapCache
.Any(p => p.Status == MapStatus.Available && p.Visibility.HasFlag(MapVisibility.MissionSelector));
missionsButton.Disabled = !hasCampaign && !hasMissions;
var hasMaps = modData.MapCache.Any(p => p.Visibility.HasFlag(MapVisibility.Lobby));
var skirmishButton = singleplayerMenu.Get<ButtonWidget>("SKIRMISH_BUTTON");
skirmishButton.OnClick = StartSkirmishGame;
skirmishButton.Disabled = !hasMaps;
var loadButton = singleplayerMenu.Get<ButtonWidget>("LOAD_BUTTON");
loadButton.IsDisabled = () => !GameSaveBrowserLogic.IsLoadPanelEnabled(modData.Manifest);
loadButton.OnClick = OpenGameSaveBrowserPanel;
var encyclopediaButton = singleplayerMenu.GetOrNull<ButtonWidget>("ENCYCLOPEDIA_BUTTON");
if (encyclopediaButton != null)
encyclopediaButton.OnClick = OpenEncyclopediaPanel;
singleplayerMenu.Get<ButtonWidget>("BACK_BUTTON").OnClick = () => SwitchMenu(MenuType.Main);
// Extras menu
var extrasMenu = widget.Get("EXTRAS_MENU");
extrasMenu.IsVisible = () => menuType == MenuType.Extras;
extrasMenu.Get<ButtonWidget>("REPLAYS_BUTTON").OnClick = OpenReplayBrowserPanel;
extrasMenu.Get<ButtonWidget>("MUSIC_BUTTON").OnClick = () =>
{
SwitchMenu(MenuType.None);
Ui.OpenWindow("MUSIC_PANEL", new WidgetArgs
{
{ "onExit", () => SwitchMenu(MenuType.Extras) },
{ "world", world }
});
};
extrasMenu.Get<ButtonWidget>("MAP_EDITOR_BUTTON").OnClick = () => SwitchMenu(MenuType.MapEditor);
var assetBrowserButton = extrasMenu.GetOrNull<ButtonWidget>("ASSETBROWSER_BUTTON");
if (assetBrowserButton != null)
assetBrowserButton.OnClick = () =>
{
SwitchMenu(MenuType.None);
Game.OpenWindow("ASSETBROWSER_PANEL", new WidgetArgs
{
{ "onExit", () => SwitchMenu(MenuType.Extras) },
});
};
extrasMenu.Get<ButtonWidget>("CREDITS_BUTTON").OnClick = () =>
{
SwitchMenu(MenuType.None);
Ui.OpenWindow("CREDITS_PANEL", new WidgetArgs
{
{ "onExit", () => SwitchMenu(MenuType.Extras) },
});
};
extrasMenu.Get<ButtonWidget>("BACK_BUTTON").OnClick = () => SwitchMenu(MenuType.Main);
// Map editor menu
var mapEditorMenu = widget.Get("MAP_EDITOR_MENU");
mapEditorMenu.IsVisible = () => menuType == MenuType.MapEditor;
// Loading into the map editor
Game.BeforeGameStart += RemoveShellmapUI;
var onSelect = new Action<string>(uid =>
{
if (modData.MapCache[uid].Status != MapStatus.Available)
SwitchMenu(MenuType.Extras);
else
LoadMapIntoEditor(modData.MapCache[uid].Uid);
});
var newMapButton = widget.Get<ButtonWidget>("NEW_MAP_BUTTON");
newMapButton.OnClick = () =>
{
SwitchMenu(MenuType.None);
Game.OpenWindow("NEW_MAP_BG", new WidgetArgs()
{
{ "onSelect", onSelect },
{ "onExit", () => SwitchMenu(MenuType.MapEditor) }
});
};
var loadMapButton = widget.Get<ButtonWidget>("LOAD_MAP_BUTTON");
loadMapButton.OnClick = () =>
{
SwitchMenu(MenuType.None);
Game.OpenWindow("MAPCHOOSER_PANEL", new WidgetArgs()
{
{ "initialMap", null },
{ "remoteMapPool", null },
{ "initialTab", MapClassification.User },
{ "onExit", () => SwitchMenu(MenuType.MapEditor) },
{ "onSelect", onSelect },
{ "filter", MapVisibility.Lobby | MapVisibility.Shellmap | MapVisibility.MissionSelector },
});
};
loadMapButton.Disabled = !hasMaps;
mapEditorMenu.Get<ButtonWidget>("BACK_BUTTON").OnClick = () => SwitchMenu(MenuType.Extras);
var newsBG = widget.GetOrNull("NEWS_BG");
if (newsBG != null)
{
newsBG.IsVisible = () => Game.Settings.Game.FetchNews && menuType != MenuType.None && menuType != MenuType.StartupPrompts;
newsPanel = Ui.LoadWidget<ScrollPanelWidget>("NEWS_PANEL", null, new WidgetArgs());
newsTemplate = newsPanel.Get("NEWS_ITEM_TEMPLATE");
newsPanel.RemoveChild(newsTemplate);
newsStatus = newsPanel.Get<LabelWidget>("NEWS_STATUS");
SetNewsStatus(FluentProvider.GetString(LoadingNews));
}
Game.OnRemoteDirectConnect += OnRemoteDirectConnect;
// Check for updates in the background
var webServices = modData.Manifest.Get<WebServices>();
if (Game.Settings.Debug.CheckVersion)
webServices.CheckModVersion();
var updateLabel = rootMenu.GetOrNull("UPDATE_NOTICE");
if (updateLabel != null)
updateLabel.IsVisible = () => !newsOpen && menuType != MenuType.None &&
menuType != MenuType.StartupPrompts &&
webServices.ModVersionStatus == ModVersionStatus.Outdated;
var playerProfile = widget.GetOrNull("PLAYER_PROFILE_CONTAINER");
if (playerProfile != null)
{
Func<bool> minimalProfile = () => Ui.CurrentWindow() != null;
Game.LoadWidget(world, "LOCAL_PROFILE_PANEL", playerProfile, new WidgetArgs()
{
{ "minimalProfile", minimalProfile }
});
}
menuType = MenuType.StartupPrompts;
void OnIntroductionComplete()
{
void OnSysInfoComplete()
{
LoadAndDisplayNews(webServices, newsBG);
SwitchMenu(MenuType.Main);
}
if (SystemInfoPromptLogic.ShouldShowPrompt())
{
Ui.OpenWindow("MAINMENU_SYSTEM_INFO_PROMPT", new WidgetArgs
{
{ "onComplete", OnSysInfoComplete }
});
}
else
OnSysInfoComplete();
}
if (IntroductionPromptLogic.ShouldShowPrompt())
{
Game.OpenWindow("MAINMENU_INTRODUCTION_PROMPT", new WidgetArgs
{
{ "onComplete", OnIntroductionComplete }
});
}
else
OnIntroductionComplete();
Game.OnShellmapLoaded += OpenMenuBasedOnLastGame;
DiscordService.UpdateStatus(DiscordState.InMenu);
}
void LoadAndDisplayNews(WebServices webServices, Widget newsBG)
{
if (newsBG != null && Game.Settings.Game.FetchNews)
{
var cacheFile = Path.Combine(Platform.SupportDir, webServices.GameNewsFileName);
var currentNews = ParseNews(cacheFile);
if (currentNews != null)
DisplayNews(currentNews);
var newsButton = newsBG.GetOrNull<DropDownButtonWidget>("NEWS_BUTTON");
if (newsButton != null)
{
if (!fetchedNews)
{
Task.Run(async () =>
{
try
{
var client = HttpClientFactory.Create();
// Send the mod and engine version to support version-filtered news (update prompts)
var url = new HttpQueryBuilder(webServices.GameNews)
{
{ "version", Game.EngineVersion },
{ "mod", modData.Manifest.Id },
{ "modversion", modData.Manifest.Metadata.Version }
}.ToString();
// Parameter string is blank if the player has opted out
url += SystemInfoPromptLogic.CreateParameterString();
var response = await client.GetStringAsync(url);
await File.WriteAllTextAsync(cacheFile, response);
Game.RunAfterTick(() => // run on the main thread
{
fetchedNews = true;
var newNews = ParseNews(cacheFile);
if (newNews == null)
return;
DisplayNews(newNews);
if (currentNews == null || newNews.Any(n => !currentNews.Select(c => c.DateTime).Contains(n.DateTime)))
OpenNewsPanel(newsButton);
});
}
catch (Exception e)
{
Game.RunAfterTick(() => // run on the main thread
SetNewsStatus(FluentProvider.GetString(NewsRetrivalFailed, "message", e.Message)));
}
});
}
newsButton.OnClick = () => OpenNewsPanel(newsButton);
}
}
}
void OpenNewsPanel(DropDownButtonWidget button)
{
newsOpen = true;
button.AttachPanel(newsPanel, () => newsOpen = false);
}
void OnRemoteDirectConnect(ConnectionTarget endpoint)
{
SwitchMenu(MenuType.None);
Ui.OpenWindow("MULTIPLAYER_PANEL", new WidgetArgs
{
{ "onStart", RemoveShellmapUI },
{ "onExit", () => SwitchMenu(MenuType.Main) },
{ "directConnectEndPoint", endpoint },
});
}
static void LoadMapIntoEditor(string uid)
{
Game.LoadEditor(uid);
DiscordService.UpdateStatus(DiscordState.InMapEditor);
lastGameState = MenuPanel.MapEditor;
}
void SetNewsStatus(string message)
{
message = WidgetUtils.WrapText(message, newsStatus.Bounds.Width, Game.Renderer.Fonts[newsStatus.Font]);
newsStatus.GetText = () => message;
}
sealed class NewsItem
{
public string Title;
public string Author;
public DateTime DateTime;
public string Content;
}
NewsItem[] ParseNews(string path)
{
if (!File.Exists(path))
return null;
try
{
return MiniYaml.FromFile(path).Select(node =>
{
var nodesDict = node.Value.ToDictionary();
return new NewsItem
{
Title = nodesDict["Title"].Value,
Author = nodesDict["Author"].Value,
DateTime = FieldLoader.GetValue<DateTime>("DateTime", node.Key),
Content = nodesDict["Content"].Value
};
}).ToArray();
}
catch (Exception ex)
{
SetNewsStatus(FluentProvider.GetString(NewsParsingFailed, "message", ex.Message));
}
return null;
}
void DisplayNews(IEnumerable<NewsItem> newsItems)
{
newsPanel.RemoveChildren();
SetNewsStatus("");
foreach (var i in newsItems)
{
var item = i;
var newsItem = newsTemplate.Clone();
var titleLabel = newsItem.Get<LabelWidget>("TITLE");
titleLabel.GetText = () => item.Title;
var authorDateTimeLabel = newsItem.Get<LabelWidget>("AUTHOR_DATETIME");
var authorDateTime = FluentProvider.GetString(AuthorDateTime,
"author", item.Author,
"datetime", item.DateTime.ToLocalTime().ToString(CultureInfo.CurrentCulture));
authorDateTimeLabel.GetText = () => authorDateTime;
var contentLabel = newsItem.Get<LabelWidget>("CONTENT");
var content = item.Content.Replace("\\n", "\n");
content = WidgetUtils.WrapText(content, contentLabel.Bounds.Width, Game.Renderer.Fonts[contentLabel.Font]);
contentLabel.GetText = () => content;
contentLabel.Bounds.Height = Game.Renderer.Fonts[contentLabel.Font].Measure(content).Y;
newsItem.Bounds.Height += contentLabel.Bounds.Height;
newsPanel.AddChild(newsItem);
newsPanel.Layout.AdjustChildren();
}
}
void RemoveShellmapUI()
{
rootMenu.Parent.RemoveChild(rootMenu);
}
void StartSkirmishGame()
{
SwitchMenu(MenuType.None);
var map = modData.MapCache.ChooseInitialMap(modData.MapCache.PickLastModifiedMap(MapVisibility.Lobby) ?? Game.Settings.Server.Map, Game.CosmeticRandom);
Game.Settings.Server.Map = map;
Game.Settings.Save();
ConnectionLogic.Connect(Game.CreateLocalServer(map, isSkirmish: true),
"",
OpenSkirmishLobbyPanel,
() => { Game.CloseServer(); SwitchMenu(MenuType.Main); });
}
void OpenMissionBrowserPanel(string map)
{
SwitchMenu(MenuType.None);
Game.OpenWindow("MISSIONBROWSER_PANEL", new WidgetArgs
{
{ "onExit", () => { Game.Disconnect(); SwitchMenu(MenuType.Singleplayer); } },
{ "onStart", () => { RemoveShellmapUI(); lastGameState = MenuPanel.Missions; } },
{ "initialMap", map }
});
}
void OpenEncyclopediaPanel()
{
SwitchMenu(MenuType.None);
Game.OpenWindow("ENCYCLOPEDIA_PANEL", new WidgetArgs
{
{ "onExit", () => SwitchMenu(MenuType.Singleplayer) }
});
}
void OpenSkirmishLobbyPanel()
{
SwitchMenu(MenuType.None);
Game.OpenWindow("SERVER_LOBBY", new WidgetArgs
{
{ "onExit", () => { Game.Disconnect(); SwitchMenu(MenuType.Singleplayer); } },
{ "onStart", () => { RemoveShellmapUI(); lastGameState = MenuPanel.Skirmish; } },
{ "skirmishMode", true }
});
}
void OpenMultiplayerPanel()
{
SwitchMenu(MenuType.None);
Ui.OpenWindow("MULTIPLAYER_PANEL", new WidgetArgs
{
{ "onStart", () => { RemoveShellmapUI(); lastGameState = MenuPanel.Multiplayer; } },
{ "onExit", () => SwitchMenu(MenuType.Main) },
{ "directConnectEndPoint", null },
});
}
void OpenReplayBrowserPanel()
{
SwitchMenu(MenuType.None);
Ui.OpenWindow("REPLAYBROWSER_PANEL", new WidgetArgs
{
{ "onExit", () => SwitchMenu(MenuType.Extras) },
{ "onStart", () => { RemoveShellmapUI(); lastGameState = MenuPanel.Replays; } }
});
}
void OpenGameSaveBrowserPanel()
{
SwitchMenu(MenuType.None);
Ui.OpenWindow("GAMESAVE_BROWSER_PANEL", new WidgetArgs
{
{ "onExit", () => SwitchMenu(MenuType.Singleplayer) },
{ "onStart", () => { RemoveShellmapUI(); lastGameState = MenuPanel.GameSaves; } },
{ "isSavePanel", false },
{ "world", null }
});
}
protected override void Dispose(bool disposing)
{
if (disposing)
{
Game.OnRemoteDirectConnect -= OnRemoteDirectConnect;
Game.BeforeGameStart -= RemoveShellmapUI;
}
Game.OnShellmapLoaded -= OpenMenuBasedOnLastGame;
base.Dispose(disposing);
}
void OpenMenuBasedOnLastGame()
{
switch (lastGameState)
{
case MenuPanel.Missions:
OpenMissionBrowserPanel(null);
break;
case MenuPanel.Replays:
OpenReplayBrowserPanel();
break;
case MenuPanel.Skirmish:
StartSkirmishGame();
break;
case MenuPanel.Multiplayer:
OpenMultiplayerPanel();
break;
case MenuPanel.MapEditor:
SwitchMenu(MenuType.MapEditor);
break;
case MenuPanel.GameSaves:
SwitchMenu(MenuType.Singleplayer);
break;
}
lastGameState = MenuPanel.None;
}
}
}