Add save/load browser and buttons to the UI.
This commit is contained in:
Paul Chote
360
OpenRA.Mods.Common/Widgets/Logic/GameSaveBrowserLogic.cs
Normal file
360
OpenRA.Mods.Common/Widgets/Logic/GameSaveBrowserLogic.cs
Normal file
@@ -0,0 +1,360 @@
|
||||
#region Copyright & License Information
|
||||
/*
|
||||
* Copyright 2007-2019 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;
|
||||
using System.Collections.Generic;
|
||||
using System.IO;
|
||||
using System.Linq;
|
||||
using OpenRA.Network;
|
||||
using OpenRA.Widgets;
|
||||
|
||||
namespace OpenRA.Mods.Common.Widgets.Logic
|
||||
{
|
||||
public class GameSaveBrowserLogic : ChromeLogic
|
||||
{
|
||||
readonly Widget panel;
|
||||
readonly ScrollPanelWidget gameList;
|
||||
readonly TextFieldWidget saveTextField;
|
||||
readonly List<string> games = new List<string>();
|
||||
readonly Action onStart;
|
||||
readonly Action onExit;
|
||||
readonly ModData modData;
|
||||
readonly bool isSavePanel;
|
||||
readonly string baseSavePath;
|
||||
|
||||
readonly string defaultSaveFilename;
|
||||
string selectedSave;
|
||||
|
||||
[ObjectCreator.UseCtor]
|
||||
public GameSaveBrowserLogic(Widget widget, ModData modData, Action onExit, Action onStart, bool isSavePanel, World world)
|
||||
{
|
||||
panel = widget;
|
||||
|
||||
this.modData = modData;
|
||||
this.onStart = onStart;
|
||||
this.onExit = onExit;
|
||||
this.isSavePanel = isSavePanel;
|
||||
Game.BeforeGameStart += OnGameStart;
|
||||
|
||||
panel.Get<ButtonWidget>("CANCEL_BUTTON").OnClick = () =>
|
||||
{
|
||||
Ui.CloseWindow();
|
||||
onExit();
|
||||
};
|
||||
|
||||
gameList = panel.Get<ScrollPanelWidget>("GAME_LIST");
|
||||
var gameTemplate = panel.Get<ScrollItemWidget>("GAME_TEMPLATE");
|
||||
var newTemplate = panel.Get<ScrollItemWidget>("NEW_TEMPLATE");
|
||||
|
||||
var mod = modData.Manifest;
|
||||
baseSavePath = Platform.ResolvePath(Platform.SupportDirPrefix, "Saves", mod.Id, mod.Metadata.Version);
|
||||
|
||||
// Avoid filename conflicts when creating new saves
|
||||
if (isSavePanel)
|
||||
{
|
||||
panel.Get("SAVE_TITLE").IsVisible = () => true;
|
||||
|
||||
defaultSaveFilename = world.Map.Title;
|
||||
var filenameAttempt = 0;
|
||||
while (true)
|
||||
{
|
||||
if (!File.Exists(Path.Combine(baseSavePath, defaultSaveFilename + ".orasav")))
|
||||
break;
|
||||
|
||||
defaultSaveFilename = world.Map.Title + " ({0})".F(++filenameAttempt);
|
||||
}
|
||||
|
||||
var saveButton = panel.Get<ButtonWidget>("SAVE_BUTTON");
|
||||
saveButton.OnClick = () => { Save(world); };
|
||||
saveButton.IsVisible = () => true;
|
||||
|
||||
var saveWidgets = panel.Get("SAVE_WIDGETS");
|
||||
saveTextField = saveWidgets.Get<TextFieldWidget>("SAVE_TEXTFIELD");
|
||||
gameList.Bounds.Height -= saveWidgets.Bounds.Height;
|
||||
saveWidgets.IsVisible = () => true;
|
||||
}
|
||||
else
|
||||
{
|
||||
panel.Get("LOAD_TITLE").IsVisible = () => true;
|
||||
var loadButton = panel.Get<ButtonWidget>("LOAD_BUTTON");
|
||||
loadButton.IsVisible = () => true;
|
||||
loadButton.IsDisabled = () => selectedSave == null;
|
||||
loadButton.OnClick = () => { Load(); };
|
||||
}
|
||||
|
||||
if (Directory.Exists(baseSavePath))
|
||||
LoadGames(gameTemplate, newTemplate);
|
||||
|
||||
var renameButton = panel.Get<ButtonWidget>("RENAME_BUTTON");
|
||||
renameButton.IsDisabled = () => selectedSave == null;
|
||||
renameButton.OnClick = () =>
|
||||
{
|
||||
var initialName = Path.GetFileNameWithoutExtension(selectedSave);
|
||||
var invalidChars = Path.GetInvalidFileNameChars();
|
||||
|
||||
ConfirmationDialogs.TextInputPrompt(
|
||||
"Rename Save",
|
||||
"Enter a new file name:",
|
||||
initialName,
|
||||
onAccept: newName => Rename(initialName, newName),
|
||||
onCancel: null,
|
||||
acceptText: "Rename",
|
||||
cancelText: null,
|
||||
inputValidator: newName =>
|
||||
{
|
||||
if (newName == initialName)
|
||||
return false;
|
||||
|
||||
if (string.IsNullOrWhiteSpace(newName))
|
||||
return false;
|
||||
|
||||
if (newName.IndexOfAny(invalidChars) >= 0)
|
||||
return false;
|
||||
|
||||
if (File.Exists(Path.Combine(baseSavePath, newName)))
|
||||
return false;
|
||||
|
||||
return true;
|
||||
});
|
||||
};
|
||||
|
||||
var deleteButton = panel.Get<ButtonWidget>("DELETE_BUTTON");
|
||||
deleteButton.IsDisabled = () => selectedSave == null;
|
||||
deleteButton.OnClick = () =>
|
||||
{
|
||||
ConfirmationDialogs.ButtonPrompt(
|
||||
title: "Delete selected game save?",
|
||||
text: "Delete '{0}'?".F(Path.GetFileNameWithoutExtension(selectedSave)),
|
||||
onConfirm: () =>
|
||||
{
|
||||
Delete(selectedSave);
|
||||
|
||||
if (!games.Any() && !isSavePanel)
|
||||
{
|
||||
Ui.CloseWindow();
|
||||
onExit();
|
||||
}
|
||||
else
|
||||
SelectFirstVisible();
|
||||
},
|
||||
confirmText: "Delete",
|
||||
onCancel: () => { });
|
||||
};
|
||||
|
||||
var deleteAllButton = panel.Get<ButtonWidget>("DELETE_ALL_BUTTON");
|
||||
deleteAllButton.IsDisabled = () => !games.Any();
|
||||
deleteAllButton.OnClick = () =>
|
||||
{
|
||||
ConfirmationDialogs.ButtonPrompt(
|
||||
title: "Delete all game saves?",
|
||||
text: "Delete {0} game saves?".F(games.Count),
|
||||
onConfirm: () =>
|
||||
{
|
||||
foreach (var s in games.ToList())
|
||||
Delete(s);
|
||||
|
||||
Ui.CloseWindow();
|
||||
onExit();
|
||||
},
|
||||
confirmText: "Delete All",
|
||||
onCancel: () => { });
|
||||
};
|
||||
|
||||
SelectFirstVisible();
|
||||
}
|
||||
|
||||
void LoadGames(ScrollItemWidget gameTemplate, ScrollItemWidget newTemplate)
|
||||
{
|
||||
gameList.RemoveChildren();
|
||||
if (isSavePanel)
|
||||
{
|
||||
var item = ScrollItemWidget.Setup(newTemplate,
|
||||
() => selectedSave == null,
|
||||
() => Select(null),
|
||||
() => { });
|
||||
gameList.AddChild(item);
|
||||
}
|
||||
|
||||
var savePaths = Directory.GetFiles(baseSavePath, "*.orasav", SearchOption.AllDirectories)
|
||||
.OrderByDescending(p => File.GetLastWriteTime(p))
|
||||
.ToList();
|
||||
|
||||
foreach (var savePath in savePaths)
|
||||
{
|
||||
games.Add(savePath);
|
||||
|
||||
// Create the item manually so the click handlers can refer to itself
|
||||
// This simplifies the rename handling (only needs to update ItemKey)
|
||||
var item = gameTemplate.Clone() as ScrollItemWidget;
|
||||
item.ItemKey = savePath;
|
||||
item.IsVisible = () => true;
|
||||
item.IsSelected = () => selectedSave == item.ItemKey;
|
||||
item.OnClick = () => Select(item.ItemKey);
|
||||
item.OnDoubleClick = Load;
|
||||
|
||||
var title = Path.GetFileNameWithoutExtension(savePath);
|
||||
item.Get<LabelWidget>("TITLE").GetText = () => title;
|
||||
|
||||
var date = File.GetLastWriteTime(savePath).ToString("yyyy-MM-dd HH:mm:ss");
|
||||
item.Get<LabelWidget>("DATE").GetText = () => date;
|
||||
|
||||
gameList.AddChild(item);
|
||||
}
|
||||
}
|
||||
|
||||
void Rename(string oldName, string newName)
|
||||
{
|
||||
try
|
||||
{
|
||||
var oldPath = Path.Combine(baseSavePath, oldName + ".orasav");
|
||||
var newPath = Path.Combine(baseSavePath, newName + ".orasav");
|
||||
File.Move(oldPath, newPath);
|
||||
|
||||
games[games.IndexOf(oldPath)] = newPath;
|
||||
foreach (var c in gameList.Children)
|
||||
{
|
||||
var item = c as ScrollItemWidget;
|
||||
if (item == null || item.ItemKey != oldPath)
|
||||
continue;
|
||||
|
||||
item.ItemKey = newPath;
|
||||
item.Get<LabelWidget>("TITLE").GetText = () => newName;
|
||||
}
|
||||
|
||||
if (selectedSave == oldPath)
|
||||
selectedSave = newPath;
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
Console.WriteLine(ex);
|
||||
Log.Write("debug", ex.ToString());
|
||||
}
|
||||
}
|
||||
|
||||
void Delete(string savePath)
|
||||
{
|
||||
try
|
||||
{
|
||||
File.Delete(savePath);
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
Game.Debug("Failed to delete save file '{0}'. See the logs for details.", savePath);
|
||||
Log.Write("debug", ex.ToString());
|
||||
return;
|
||||
}
|
||||
|
||||
if (savePath == selectedSave)
|
||||
Select(null);
|
||||
|
||||
var item = gameList.Children
|
||||
.Select(c => c as ScrollItemWidget)
|
||||
.FirstOrDefault(c => c.ItemKey == savePath);
|
||||
|
||||
gameList.RemoveChild(item);
|
||||
games.Remove(savePath);
|
||||
}
|
||||
|
||||
void SelectFirstVisible()
|
||||
{
|
||||
Select(isSavePanel ? null : games.FirstOrDefault());
|
||||
}
|
||||
|
||||
void Select(string savePath)
|
||||
{
|
||||
selectedSave = savePath;
|
||||
if (isSavePanel)
|
||||
saveTextField.Text = savePath == null ? defaultSaveFilename :
|
||||
Path.GetFileNameWithoutExtension(savePath);
|
||||
}
|
||||
|
||||
void Load()
|
||||
{
|
||||
if (selectedSave == null)
|
||||
return;
|
||||
|
||||
// Parse the save to find the map UID
|
||||
var save = new GameSave(selectedSave);
|
||||
var map = modData.MapCache[save.GlobalSettings.Map];
|
||||
if (map.Status != MapStatus.Available)
|
||||
return;
|
||||
|
||||
var orders = new List<Order>()
|
||||
{
|
||||
new Order("LoadGameSave", null, false)
|
||||
{
|
||||
IsImmediate = true,
|
||||
TargetString = Path.GetFileName(selectedSave)
|
||||
},
|
||||
Order.Command("state {0}".F(Session.ClientState.Ready))
|
||||
};
|
||||
|
||||
Game.CreateAndStartLocalServer(map.Uid, orders);
|
||||
}
|
||||
|
||||
void Save(World world)
|
||||
{
|
||||
var filename = saveTextField.Text + ".orasav";
|
||||
var testPath = Platform.ResolvePath(
|
||||
Platform.SupportDirPrefix,
|
||||
"Saves",
|
||||
modData.Manifest.Id,
|
||||
modData.Manifest.Metadata.Version,
|
||||
filename);
|
||||
|
||||
Action inner = () =>
|
||||
{
|
||||
world.RequestGameSave(filename);
|
||||
Ui.CloseWindow();
|
||||
onExit();
|
||||
};
|
||||
|
||||
if (selectedSave != null || File.Exists(testPath))
|
||||
{
|
||||
ConfirmationDialogs.ButtonPrompt(
|
||||
title: "Overwrite save game?",
|
||||
text: "Overwrite {0}?".F(saveTextField.Text),
|
||||
onConfirm: inner,
|
||||
confirmText: "Overwrite",
|
||||
onCancel: () => { });
|
||||
}
|
||||
else
|
||||
inner();
|
||||
}
|
||||
|
||||
void OnGameStart()
|
||||
{
|
||||
Ui.CloseWindow();
|
||||
onStart();
|
||||
}
|
||||
|
||||
bool disposed;
|
||||
protected override void Dispose(bool disposing)
|
||||
{
|
||||
if (disposing && !disposed)
|
||||
{
|
||||
disposed = true;
|
||||
Game.BeforeGameStart -= OnGameStart;
|
||||
}
|
||||
|
||||
base.Dispose(disposing);
|
||||
}
|
||||
|
||||
public static bool IsLoadPanelEnabled(Manifest mod)
|
||||
{
|
||||
var baseSavePath = Platform.ResolvePath(Platform.SupportDirPrefix, "Saves", mod.Id, mod.Metadata.Version);
|
||||
if (!Directory.Exists(baseSavePath))
|
||||
return false;
|
||||
|
||||
return Directory.GetFiles(baseSavePath, "*.orasav", SearchOption.AllDirectories).Any();
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user