tommy/tbd-station-14
2
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Re-organize in-memory character profile storage.

Browse Source 
Now uses a dictionary of int -> profile instead of an array filled with nulls.
This commit is contained in:
Pieter-Jan Briers
2020-10-06 15:13:16 +02:00
parent 0b1fd94dc9
commit 390d064304
12 changed files with 228 additions and 204 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
Content.Client/ClientPreferencesManager.cs
View File

@@ -1,9 +1,12 @@
using System;
using System.Collections.Generic;
using System.Linq;
using Content.Client.Interfaces;
using Content.Shared.Network.NetMessages;
using Content.Shared.Preferences;
using Robust.Shared.Interfaces.Network;
using Robust.Shared.IoC;
using Robust.Shared.Utility;
namespace Content.Client
{
@@ -12,7 +15,7 @@ namespace Content.Client
/// connection.
/// Stores preferences on the server through <see cref="SelectCharacter" /> and <see cref="UpdateCharacter" />.
/// </summary>
public class ClientPreferencesManager : SharedPreferencesManager, IClientPreferencesManager
public class ClientPreferencesManager : IClientPreferencesManager
{
[Dependency] private readonly IClientNetManager _netManager = default!;
@@ -44,8 +47,7 @@ namespace Content.Client
public void UpdateCharacter(ICharacterProfile profile, int slot)
{
var characters = Preferences.Characters.ToArray();
characters[slot] = profile;
var characters = new Dictionary<int, ICharacterProfile>(Preferences.Characters) {[slot] = profile};
Preferences = new PlayerPreferences(characters, Preferences.SelectedCharacterIndex);
var msg = _netManager.CreateNetMessage<MsgUpdateCharacter>();
msg.Profile = profile;
@@ -55,12 +57,21 @@ namespace Content.Client
public void CreateCharacter(ICharacterProfile profile)
{
var characters = Preferences.Characters.ToList();
var characters = new Dictionary<int, ICharacterProfile>(Preferences.Characters);
var lowest = Enumerable.Range(0, Settings.MaxCharacterSlots)
.Except(characters.Keys)
.FirstOrNull();
characters.Add(profile);
if (lowest == null)
{
throw new InvalidOperationException("Out of character slots!");
}
var l = lowest.Value;
characters.Add(l, profile);
Preferences = new PlayerPreferences(characters, Preferences.SelectedCharacterIndex);
UpdateCharacter(profile, characters.Count - 1);
UpdateCharacter(profile, l);
}
public void DeleteCharacter(ICharacterProfile profile)
@@ -70,7 +81,7 @@ namespace Content.Client
public void DeleteCharacter(int slot)
{
var characters = Preferences.Characters.Where((profile, index) => index != slot).ToArray();
var characters = Preferences.Characters.Where(p => p.Key != slot);
Preferences = new PlayerPreferences(characters, Preferences.SelectedCharacterIndex);
var msg = _netManager.CreateNetMessage<MsgDeleteCharacter>();
msg.Slot = slot;

7
Content.Client/UserInterface/CharacterSetupGui.cs
View File

@@ -174,12 +174,10 @@ namespace Content.Client.UserInterface
_createNewCharacterButton.ToolTip =
$"A maximum of {_preferencesManager.Settings.MaxCharacterSlots} characters are allowed.";
var characterIndex = 0;
foreach (var character in _preferencesManager.Preferences.Characters)
foreach (var (slot, character) in _preferencesManager.Preferences.Characters)
{
if (character is null)
{
characterIndex++;
continue;
}
@@ -190,7 +188,7 @@ namespace Content.Client.UserInterface
character);
_charactersVBox.AddChild(characterPickerButton);
var characterIndexCopy = characterIndex;
var characterIndexCopy = slot;
characterPickerButton.OnPressed += args =>
{
_humanoidProfileEditor.Profile = (HumanoidCharacterProfile) character;
@@ -200,7 +198,6 @@ namespace Content.Client.UserInterface
UpdateUI();
args.Event.Handle();
};
characterIndex++;
}
_createNewCharacterButton.Disabled =

14
Content.Server/Database/ServerDbBase.cs
View File

@@ -1,5 +1,6 @@
#nullable enable
using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Threading.Tasks;
@@ -24,18 +25,14 @@ namespace Content.Server.Database
if (prefs is null) return null;
var maxSlot = prefs.Profiles.Max(p => p.Slot)+1;
var profiles = new ICharacterProfile[maxSlot];
var maxSlot = prefs.Profiles.Max(p => p.Slot) + 1;
var profiles = new Dictionary<int, ICharacterProfile>(maxSlot);
foreach (var profile in prefs.Profiles)
{
profiles[profile.Slot] = ConvertProfiles(profile);
}
return new PlayerPreferences
(
profiles,
prefs.SelectedCharacterSlot
);
return new PlayerPreferences(profiles, prefs.SelectedCharacterSlot);
}
public async Task SaveSelectedCharacterIndexAsync(NetUserId userId, int index)
@@ -113,7 +110,7 @@ namespace Content.Server.Database
await db.DbContext.SaveChangesAsync();
return new PlayerPreferences(new []{defaultProfile}, 0);
return new PlayerPreferences(new[] {new KeyValuePair<int, ICharacterProfile>(0, defaultProfile)}, 0);
}
private static HumanoidCharacterProfile ConvertProfiles(Profile profile)
@@ -216,6 +213,5 @@ namespace Content.Server.Database
public abstract ValueTask DisposeAsync();
}
}
}

23
Content.Server/Preferences/ServerPreferencesManager.cs
View File

@@ -5,6 +5,7 @@ using System.Threading.Tasks;
using Content.Server.Database;
using Content.Server.Interfaces;
using Content.Shared;
using Content.Shared.Network.NetMessages;
using Content.Shared.Preferences;
using Robust.Server.Interfaces.Player;
using Robust.Shared.Interfaces.Configuration;
@@ -19,10 +20,10 @@ using Robust.Shared.Prototypes;
namespace Content.Server.Preferences
{
/// <summary>
/// Sends <see cref="SharedPreferencesManager.MsgPreferencesAndSettings"/> before the client joins the lobby.
/// Receives <see cref="SharedPreferencesManager.MsgSelectCharacter"/> and <see cref="SharedPreferencesManager.MsgUpdateCharacter"/> at any time.
/// Sends <see cref="MsgPreferencesAndSettings"/> before the client joins the lobby.
/// Receives <see cref="MsgSelectCharacter"/> and <see cref="MsgUpdateCharacter"/> at any time.
/// </summary>
public class ServerPreferencesManager : SharedPreferencesManager, IServerPreferencesManager
public class ServerPreferencesManager : IServerPreferencesManager
{
[Dependency] private readonly IServerNetManager _netManager = default!;
[Dependency] private readonly IConfigurationManager _cfg = default!;
@@ -99,12 +100,12 @@ namespace Content.Server.Preferences
var curPrefs = prefsData.Prefs!;
var arr = new ICharacterProfile[MaxCharacterSlots];
curPrefs.Characters.ToList().CopyTo(arr, 0);
var profiles = new Dictionary<int, ICharacterProfile>(curPrefs.Characters)
{
[slot] = HumanoidCharacterProfile.EnsureValid((HumanoidCharacterProfile) profile, _protos)
};
arr[slot] = HumanoidCharacterProfile.EnsureValid((HumanoidCharacterProfile) profile, _protos);
prefsData.Prefs = new PlayerPreferences(arr, slot);
prefsData.Prefs = new PlayerPreferences(profiles, slot);
if (ShouldStorePrefs(message.MsgChannel.AuthType))
{
@@ -130,8 +131,8 @@ namespace Content.Server.Preferences
var curPrefs = prefsData.Prefs!;
var arr = new ICharacterProfile[MaxCharacterSlots];
curPrefs.Characters.Where((profile, index) => index != slot).ToArray().CopyTo(arr, 0);
var arr = new Dictionary<int, ICharacterProfile>(curPrefs.Characters);
arr.Remove(slot);
prefsData.Prefs = new PlayerPreferences(arr, slot);
@@ -150,7 +151,7 @@ namespace Content.Server.Preferences
{
PrefsLoaded = Task.CompletedTask,
Prefs = new PlayerPreferences(
new ICharacterProfile[] {HumanoidCharacterProfile.Default()},
new[] {new KeyValuePair<int, ICharacterProfile>(0, HumanoidCharacterProfile.Default())},
0)
};

33
Content.Shared/Network/NetMessages/MsgDeleteCharacter.cs Normal file
View File

@@ -0,0 +1,33 @@
using Lidgren.Network;
using Robust.Shared.Interfaces.Network;
using Robust.Shared.Network;
namespace Content.Shared.Network.NetMessages
{
/// <summary>
/// The client sends this to delete a character profile.
/// </summary>
public class MsgDeleteCharacter : NetMessage
{
#region REQUIRED
public const MsgGroups GROUP = MsgGroups.Command;
public const string NAME = nameof(MsgDeleteCharacter);
public MsgDeleteCharacter(INetChannel channel) : base(NAME, GROUP) { }
#endregion
public int Slot;
public override void ReadFromBuffer(NetIncomingMessage buffer)
{
Slot = buffer.ReadInt32();
}
public override void WriteToBuffer(NetOutgoingMessage buffer)
{
buffer.Write(Slot);
}
}
}

64
Content.Shared/Network/NetMessages/MsgPreferencesAndSettings.cs Normal file
View File

@@ -0,0 +1,64 @@
using System.IO;
using Content.Shared.Preferences;
using Lidgren.Network;
using Robust.Shared.Interfaces.Network;
using Robust.Shared.Interfaces.Serialization;
using Robust.Shared.IoC;
using Robust.Shared.Network;
namespace Content.Shared.Network.NetMessages
{
/// <summary>
/// The server sends this before the client joins the lobby.
/// </summary>
public class MsgPreferencesAndSettings : NetMessage
{
#region REQUIRED
public const MsgGroups GROUP = MsgGroups.Command;
public const string NAME = nameof(MsgPreferencesAndSettings);
public MsgPreferencesAndSettings(INetChannel channel) : base(NAME, GROUP) { }
#endregion
public PlayerPreferences Preferences;
public GameSettings Settings;
public override void ReadFromBuffer(NetIncomingMessage buffer)
{
var serializer = IoCManager.Resolve<IRobustSerializer>();
var length = buffer.ReadVariableInt32();
using (var stream = buffer.ReadAsStream(length))
{
serializer.DeserializeDirect(stream, out Preferences);
}
length = buffer.ReadVariableInt32();
using (var stream = buffer.ReadAsStream(length))
{
serializer.DeserializeDirect(stream, out Settings);
}
}
public override void WriteToBuffer(NetOutgoingMessage buffer)
{
var serializer = IoCManager.Resolve<IRobustSerializer>();
using (var stream = new MemoryStream())
{
serializer.SerializeDirect(stream, Preferences);
buffer.WriteVariableInt32((int) stream.Length);
stream.TryGetBuffer(out var segment);
buffer.Write(segment);
}
using (var stream = new MemoryStream())
{
serializer.SerializeDirect(stream, Settings);
buffer.WriteVariableInt32((int) stream.Length);
stream.TryGetBuffer(out var segment);
buffer.Write(segment);
}
}
}
}

33
Content.Shared/Network/NetMessages/MsgSelectCharacter.cs Normal file
View File

@@ -0,0 +1,33 @@
using Lidgren.Network;
using Robust.Shared.Interfaces.Network;
using Robust.Shared.Network;
namespace Content.Shared.Network.NetMessages
{
/// <summary>
/// The client sends this to select a character slot.
/// </summary>
public class MsgSelectCharacter : NetMessage
{
#region REQUIRED
public const MsgGroups GROUP = MsgGroups.Command;
public const string NAME = nameof(MsgSelectCharacter);
public MsgSelectCharacter(INetChannel channel) : base(NAME, GROUP) { }
#endregion
public int SelectedCharacterIndex;
public override void ReadFromBuffer(NetIncomingMessage buffer)
{
SelectedCharacterIndex = buffer.ReadVariableInt32();
}
public override void WriteToBuffer(NetOutgoingMessage buffer)
{
buffer.WriteVariableInt32(SelectedCharacterIndex);
}
}
}

50
Content.Shared/Network/NetMessages/MsgUpdateCharacter.cs Normal file
View File

@@ -0,0 +1,50 @@
using System.IO;
using Content.Shared.Preferences;
using Lidgren.Network;
using Robust.Shared.Interfaces.Network;
using Robust.Shared.Interfaces.Serialization;
using Robust.Shared.IoC;
using Robust.Shared.Network;
namespace Content.Shared.Network.NetMessages
{
/// <summary>
/// The client sends this to update a character profile.
/// </summary>
public class MsgUpdateCharacter : NetMessage
{
#region REQUIRED
public const MsgGroups GROUP = MsgGroups.Command;
public const string NAME = nameof(MsgUpdateCharacter);
public MsgUpdateCharacter(INetChannel channel) : base(NAME, GROUP) { }
#endregion
public int Slot;
public ICharacterProfile Profile;
public override void ReadFromBuffer(NetIncomingMessage buffer)
{
Slot = buffer.ReadInt32();
var serializer = IoCManager.Resolve<IRobustSerializer>();
var length = buffer.ReadVariableInt32();
using var stream = buffer.ReadAsStream(length);
Profile = serializer.Deserialize<ICharacterProfile>(stream);
}
public override void WriteToBuffer(NetOutgoingMessage buffer)
{
buffer.Write(Slot);
var serializer = IoCManager.Resolve<IRobustSerializer>();
using (var stream = new MemoryStream())
{
serializer.Serialize(stream, Profile);
buffer.WriteVariableInt32((int) stream.Length);
stream.TryGetBuffer(out var segment);
buffer.Write(segment);
}
}
}
}

6
Content.Shared/Preferences/HumanoidCharacterProfile.cs
View File

@@ -193,7 +193,7 @@ namespace Content.Shared.Preferences
_ => PreferenceUnavailableMode.StayInLobby // Invalid enum values.
};
var priorities = profile.JobPriorities
var priorities = new Dictionary<string, JobPriority>(profile.JobPriorities
.Where(p => prototypeManager.HasIndex<JobPrototype>(p.Key) && p.Value switch
{
JobPriority.Never => false, // Drop never since that's assumed default.
@@ -201,9 +201,7 @@ namespace Content.Shared.Preferences
JobPriority.Medium => true,
JobPriority.High => true,
_ => false
})
.ToDictionary(p => p.Key, p => p.Value);
}));
var antags = profile.AntagPreferences
.Where(prototypeManager.HasIndex<AntagPrototype>)

14
Content.Shared/Preferences/PlayerPreferences.cs
View File

@@ -1,7 +1,7 @@
using System;
using System.Collections.Generic;
using System.Linq;
using Robust.Shared.Serialization;
using Robust.Shared.Utility;
namespace Content.Shared.Preferences
{
@@ -13,18 +13,18 @@ namespace Content.Shared.Preferences
[NetSerializable]
public sealed class PlayerPreferences
{
private List<ICharacterProfile> _characters;
private Dictionary<int, ICharacterProfile> _characters;
public PlayerPreferences(IEnumerable<ICharacterProfile> characters, int selectedCharacterIndex)
public PlayerPreferences(IEnumerable<KeyValuePair<int, ICharacterProfile>> characters, int selectedCharacterIndex)
{
_characters = characters.ToList();
_characters = new Dictionary<int, ICharacterProfile>(characters);
SelectedCharacterIndex = selectedCharacterIndex;
}
/// <summary>
/// All player characters.
/// </summary>
public IEnumerable<ICharacterProfile> Characters => _characters.AsEnumerable();
public IReadOnlyDictionary<int, ICharacterProfile> Characters => _characters;
public ICharacterProfile GetProfile(int index)
{
@@ -39,7 +39,7 @@ namespace Content.Shared.Preferences
/// <summary>
/// The currently selected character.
/// </summary>
public ICharacterProfile SelectedCharacter => Characters.ElementAtOrDefault(SelectedCharacterIndex);
public ICharacterProfile SelectedCharacter => Characters[SelectedCharacterIndex];
public int FirstEmptySlot()
{
@@ -49,7 +49,7 @@ namespace Content.Shared.Preferences
public int IndexOfCharacter(ICharacterProfile profile)
{
return _characters.FindIndex(x => x == profile);
return _characters.FirstOrNull(p => p.Value == profile)?.Key ?? -1;
}
public bool TryIndexOfCharacter(ICharacterProfile profile, out int index)

159
Content.Shared/Preferences/SharedPreferencesManager.cs
View File

@@ -1,159 +0,0 @@
using System.IO;
using Lidgren.Network;
using Robust.Shared.Interfaces.Network;
using Robust.Shared.Interfaces.Serialization;
using Robust.Shared.IoC;
using Robust.Shared.Network;
namespace Content.Shared.Preferences
{
public abstract class SharedPreferencesManager
{
/// <summary>
/// The server sends this before the client joins the lobby.
/// </summary>
protected class MsgPreferencesAndSettings : NetMessage
{
#region REQUIRED
public const MsgGroups GROUP = MsgGroups.Command;
public const string NAME = nameof(MsgPreferencesAndSettings);
public MsgPreferencesAndSettings(INetChannel channel) : base(NAME, GROUP) { }
#endregion
public PlayerPreferences Preferences;
public GameSettings Settings;
public override void ReadFromBuffer(NetIncomingMessage buffer)
{
var serializer = IoCManager.Resolve<IRobustSerializer>();
var length = buffer.ReadVariableInt32();
using (var stream = buffer.ReadAsStream(length))
{
serializer.DeserializeDirect(stream, out Preferences);
}
length = buffer.ReadVariableInt32();
using (var stream = buffer.ReadAsStream(length))
{
serializer.DeserializeDirect(stream, out Settings);
}
}
public override void WriteToBuffer(NetOutgoingMessage buffer)
{
var serializer = IoCManager.Resolve<IRobustSerializer>();
using (var stream = new MemoryStream())
{
serializer.SerializeDirect(stream, Preferences);
buffer.WriteVariableInt32((int)stream.Length);
stream.TryGetBuffer(out var segment);
buffer.Write(segment);
}
using (var stream = new MemoryStream())
{
serializer.SerializeDirect(stream, Settings);
buffer.WriteVariableInt32((int)stream.Length);
stream.TryGetBuffer(out var segment);
buffer.Write(segment);
}
}
}
/// <summary>
/// The client sends this to select a character slot.
/// </summary>
protected class MsgSelectCharacter : NetMessage
{
#region REQUIRED
public const MsgGroups GROUP = MsgGroups.Command;
public const string NAME = nameof(MsgSelectCharacter);
public MsgSelectCharacter(INetChannel channel) : base(NAME, GROUP) { }
#endregion
public int SelectedCharacterIndex;
public override void ReadFromBuffer(NetIncomingMessage buffer)
{
SelectedCharacterIndex = buffer.ReadVariableInt32();
}
public override void WriteToBuffer(NetOutgoingMessage buffer)
{
buffer.WriteVariableInt32(SelectedCharacterIndex);
}
}
/// <summary>
/// The client sends this to update a character profile.
/// </summary>
protected class MsgUpdateCharacter : NetMessage
{
#region REQUIRED
public const MsgGroups GROUP = MsgGroups.Command;
public const string NAME = nameof(MsgUpdateCharacter);
public MsgUpdateCharacter(INetChannel channel) : base(NAME, GROUP) { }
#endregion
public int Slot;
public ICharacterProfile Profile;
public override void ReadFromBuffer(NetIncomingMessage buffer)
{
Slot = buffer.ReadInt32();
var serializer = IoCManager.Resolve<IRobustSerializer>();
var length = buffer.ReadVariableInt32();
using var stream = buffer.ReadAsStream(length);
Profile = serializer.Deserialize<ICharacterProfile>(stream);
}
public override void WriteToBuffer(NetOutgoingMessage buffer)
{
buffer.Write(Slot);
var serializer = IoCManager.Resolve<IRobustSerializer>();
using (var stream = new MemoryStream())
{
serializer.Serialize(stream, Profile);
buffer.WriteVariableInt32((int)stream.Length);
stream.TryGetBuffer(out var segment);
buffer.Write(segment);
}
}
}
/// <summary>
/// The client sends this to delete a character profile.
/// </summary>
protected class MsgDeleteCharacter : NetMessage
{
#region REQUIRED
public const MsgGroups GROUP = MsgGroups.Command;
public const string NAME = nameof(MsgDeleteCharacter);
public MsgDeleteCharacter(INetChannel channel) : base(NAME, GROUP) { }
#endregion
public int Slot;
public override void ReadFromBuffer(NetIncomingMessage buffer)
{
Slot = buffer.ReadInt32();
}
public override void WriteToBuffer(NetOutgoingMessage buffer)
{
buffer.Write(Slot);
}
}
}
}

4
Content.Tests/Server/Preferences/ServerDbSqliteTests.cs
View File

@@ -68,7 +68,7 @@ namespace Content.Tests.Server.Preferences
var originalProfile = CharlieCharlieson();
await db.InitPrefsAsync(username, originalProfile);
var prefs = await db.GetPlayerPreferencesAsync(username);
Assert.That(prefs.Characters.ElementAt(slot).MemberwiseEquals(originalProfile));
Assert.That(prefs.Characters.Single(p => p.Key == slot).Value.MemberwiseEquals(originalProfile));
}
[Test]
@@ -81,7 +81,7 @@ namespace Content.Tests.Server.Preferences
await db.SaveSelectedCharacterIndexAsync(username, 1);
await db.SaveCharacterSlotAsync(username, null, 1);
var prefs = await db.GetPlayerPreferencesAsync(username);
Assert.That(prefs.Characters.Skip(1).All(character => character is null));
Assert.That(!prefs.Characters.Any(p => p.Key != 0));
}
private static NetUserId NewUserId()