C#开发的OpenRA的游戏主界面逻辑

C#开发的OpenRA的游戏主界面逻辑

前面介绍了主界面的布局，以及界面内容的显示，
但是刚刚有这些，还不足以完成一个界面的内容，
因为一个界面的作用还有另外一个交互，交互就需要有逻辑响应，
比如点击了按钮，就需要有正确的反应，比如显示另外一个菜单，或者显示一段文字。
通过前面的分析也知道，游戏主界面逻辑是定义在文件MainMenuLogic.cs里，
它实现了界面上文本的动态更新，比如更新游戏的版本号显示，就是采用下面的代码：
public MainMenuLogic(Widget widget, World world, ModData modData)
{
    rootMenu = widget;
    rootMenu.Get<LabelWidget>("VERSION_LABEL").Text = modData.Manifest.Metadata.Version;
在这里通过mainmenu.yaml定义的文本名称VERSION_LABEL来找到对应的标签控件，然后再设置文本显示。
其它的控件也是通过这样的方式来找到对应的控件，然后进行设置。
比如：var mainMenu = widget.Get("MAIN_MENU");
这行代码就是获取主菜单的容器。
mainMenu.IsVisible = () => menuType == MenuType.Main;
这行代码是用来设置主菜单是否显示出来，如果菜单显示的类型为MenuType.Main，就显示出来，其它类型不显示。
mainMenu.Get<ButtonWidget>("SINGLEPLAYER_BUTTON").OnClick = () => SwitchMenu(MenuType.Singleplayer);
这行代码设置单游戏玩家的点击事件响应，这里是切换到下一级菜单。

mainMenu.Get<ButtonWidget>("MULTIPLAYER_BUTTON").OnClick = OpenMultiplayerPanel;

mainMenu.Get<ButtonWidget>("CONTENT_BUTTON").OnClick = () =>
{
    // Switching mods changes the world state (by disposing it),
    // so we can't do this inside the input handler.
    Game.RunAfterTick(() =>
    {
        var content = modData.Manifest.Get<ModContent>();
        Game.InitializeMod(content.ContentInstallerMod, new Arguments(new[] { "Content.Mod=" + modData.Manifest.Id }));
    });
};

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;
后面这些也是设置按钮的事件响应。

可见游戏主界面，就是设置按钮显示，并设置按钮的响应的动作。

整个例子的代码如下：

#region Copyright & License Information
/** Copyright 2007-2021 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.*/
#endregionusing System;
using System.Collections.Generic;
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{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;// Update news once per game launchstatic bool fetchedNews;protected static MenuPanel lastGameState = MenuPanel.None;bool newsOpen;void SwitchMenu(MenuType type){menuType = type;DiscordService.UpdateStatus(DiscordState.InMenu);// Update button mouseoverGame.RunAfterTick(Ui.ResetTooltips);}[ObjectCreator.UseCtor]public MainMenuLogic(Widget widget, World world, ModData modData){rootMenu = widget;rootMenu.Get<LabelWidget>("VERSION_LABEL").Text = modData.Manifest.Metadata.Version;// Menu buttonsvar 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;mainMenu.Get<ButtonWidget>("CONTENT_BUTTON").OnClick = () =>{// Switching mods changes the world state (by disposing it),// so we can't do this inside the input handler.Game.RunAfterTick(() =>{var content = modData.Manifest.Get<ModContent>();Game.InitializeMod(content.ContentInstallerMod, new Arguments(new[] { "Content.Mod=" + modData.Manifest.Id }));});};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 menuvar singleplayerMenu = widget.Get("SINGLEPLAYER_MENU");singleplayerMenu.IsVisible = () => menuType == MenuType.Singleplayer;var missionsButton = singleplayerMenu.Get<ButtonWidget>("MISSIONS_BUTTON");missionsButton.OnClick = OpenMissionBrowserPanel;var hasCampaign = modData.Manifest.Missions.Any();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;singleplayerMenu.Get<ButtonWidget>("BACK_BUTTON").OnClick = () => SwitchMenu(MenuType.Main);// Extras menuvar 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 menuvar mapEditorMenu = widget.Get("MAP_EDITOR_MENU");mapEditorMenu.IsVisible = () => menuType == MenuType.MapEditor;// Loading into the map editorGame.BeforeGameStart += RemoveShellmapUI;var onSelect = new Action<string>(uid => 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 },{ "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("Loading news");}Game.OnRemoteDirectConnect += OnRemoteDirectConnect;// Check for updates in the backgroundvar 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;Action onIntroductionComplete = () =>{Action onSysInfoComplete = () =>{LoadAndDisplayNews(webServices, newsBG);SwitchMenu(MenuType.Main);};if (SystemInfoPromptLogic.ShouldShowPrompt()){Ui.OpenWindow("MAINMENU_SYSTEM_INFO_PROMPT", new WidgetArgs{{ "onComplete", onSysInfoComplete }});}elseonSysInfoComplete();};if (IntroductionPromptLogic.ShouldShowPrompt()){Game.OpenWindow("MAINMENU_INTRODUCTION_PROMPT", new WidgetArgs{{ "onComplete", onIntroductionComplete }});}elseonIntroductionComplete();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", Game.ModData.Manifest.Id },{ "modversion", Game.ModData.Manifest.Metadata.Version }}.ToString();// Parameter string is blank if the player has opted outurl += 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($"Failed to retrieve news: {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 },});}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;}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($"Failed to parse news: {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 = authorDateTimeLabel.Text.F(item.Author, item.DateTime.ToLocalTime());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(){var map = Game.ModData.MapCache.ChooseInitialMap(Game.Settings.Server.Map, Game.CosmeticRandom);Game.Settings.Server.Map = map;Game.Settings.Save();ConnectionLogic.Connect(Game.CreateLocalServer(map),"",OpenSkirmishLobbyPanel,() => { Game.CloseServer(); SwitchMenu(MenuType.Main); });}void OpenMissionBrowserPanel(){SwitchMenu(MenuType.None);Game.OpenWindow("MISSIONBROWSER_PANEL", new WidgetArgs{{ "onExit", () => SwitchMenu(MenuType.Singleplayer) },{ "onStart", () => { RemoveShellmapUI(); lastGameState = MenuPanel.Missions; } }});}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();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;}}
}

输出内容如下：