ToxicMushroom/Dalamud
1
0
Fork 0
mirror of https://github.com/goatcorp/Dalamud.git synced 2025-12-31 21:03:43 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Add json attributes to Payload/SeString types to allow for serialization/deserialization

Browse source
This commit is contained in:
ms2mml 2020-09-07 01:25:51 -07:00
parent bf8d966513
commit 3d02e2438b
10 changed files with 46 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

4
Dalamud/Game/Chat/SeStringHandling/Payloads/AutoTranslatePayload.cs
View file

@ -6,6 +6,7 @@ using System.IO;
using System.Linq; using System.Linq;
using Dalamud.Data; using Dalamud.Data;
using Dalamud.Data.TransientSheet; using Dalamud.Data.TransientSheet;
using Newtonsoft.Json;
namespace Dalamud.Game.Chat.SeStringHandling.Payloads namespace Dalamud.Game.Chat.SeStringHandling.Payloads
{ {
@ -34,7 +35,10 @@ namespace Dalamud.Game.Chat.SeStringHandling.Payloads
} }
} }
[JsonProperty]
private uint group; private uint group;
[JsonProperty]
private uint key; private uint key;
internal AutoTranslatePayload() { } internal AutoTranslatePayload() { }

3
Dalamud/Game/Chat/SeStringHandling/Payloads/ItemPayload.cs
View file

@ -5,6 +5,7 @@ using System.Linq;
using System.Text; using System.Text;
using Dalamud.Data; using Dalamud.Data;
using Lumina.Excel.GeneratedSheets; using Lumina.Excel.GeneratedSheets;
using Newtonsoft.Json;
namespace Dalamud.Game.Chat.SeStringHandling.Payloads namespace Dalamud.Game.Chat.SeStringHandling.Payloads
{ {
@ -22,6 +23,7 @@ namespace Dalamud.Game.Chat.SeStringHandling.Payloads
/// <remarks> /// <remarks>
/// Value is evaluated lazily and cached. /// Value is evaluated lazily and cached.
/// </remarks> /// </remarks>
[JsonIgnore]
public Item Item public Item Item
{ {
get get
@ -59,6 +61,7 @@ namespace Dalamud.Game.Chat.SeStringHandling.Payloads
/// </summary> /// </summary>
public bool IsHQ { get; private set; } = false; public bool IsHQ { get; private set; } = false;
[JsonProperty]
private uint itemId; private uint itemId;
internal ItemPayload() { } internal ItemPayload() { }

10
Dalamud/Game/Chat/SeStringHandling/Payloads/MapLinkPayload.cs
View file

@ -3,6 +3,7 @@ using System;
using System.Collections.Generic; using System.Collections.Generic;
using System.IO; using System.IO;
using Dalamud.Data; using Dalamud.Data;
using Newtonsoft.Json;
namespace Dalamud.Game.Chat.SeStringHandling.Payloads namespace Dalamud.Game.Chat.SeStringHandling.Payloads
{ {
@ -20,6 +21,7 @@ namespace Dalamud.Game.Chat.SeStringHandling.Payloads
/// <remarks> /// <remarks>
/// Value is evaluated lazily and cached. /// Value is evaluated lazily and cached.
/// </remarks> /// </remarks>
[JsonIgnore]
public Map Map public Map Map
{ {
get get
@ -36,6 +38,7 @@ namespace Dalamud.Game.Chat.SeStringHandling.Payloads
/// <remarks> /// <remarks>
/// Value is evaluated lazily and cached. /// Value is evaluated lazily and cached.
/// </remarks> /// </remarks>
[JsonIgnore]
public TerritoryType TerritoryType public TerritoryType TerritoryType
{ {
get get
@ -70,6 +73,7 @@ namespace Dalamud.Game.Chat.SeStringHandling.Payloads
/// <summary> /// <summary>
/// The readable y-coordinate position for this map link. This value is approximate and unrounded. /// The readable y-coordinate position for this map link. This value is approximate and unrounded.
/// </summary> /// </summary>
[JsonIgnore]
public float YCoord public float YCoord
{ {
get get
@ -82,6 +86,7 @@ namespace Dalamud.Game.Chat.SeStringHandling.Payloads
/// The printable map coordinates for this link. This value tries to match the in-game printable text as closely as possible /// The printable map coordinates for this link. This value tries to match the in-game printable text as closely as possible
/// but is an approximation and may be slightly off for some positions. /// but is an approximation and may be slightly off for some positions.
/// </summary> /// </summary>
[JsonIgnore]
public string CoordinateString public string CoordinateString
{ {
get get
@ -102,6 +107,7 @@ namespace Dalamud.Game.Chat.SeStringHandling.Payloads
/// <summary> /// <summary>
/// The region name for this map link. This corresponds to the upper zone name found in the actual in-game map UI. eg, "La Noscea" /// The region name for this map link. This corresponds to the upper zone name found in the actual in-game map UI. eg, "La Noscea"
/// </summary> /// </summary>
[JsonIgnore]
public string PlaceNameRegion public string PlaceNameRegion
{ {
get get
@ -115,6 +121,7 @@ namespace Dalamud.Game.Chat.SeStringHandling.Payloads
/// <summary> /// <summary>
/// The place name for this map link. This corresponds to the lower zone name found in the actual in-game map UI. eg, "Limsa Lominsa Upper Decks" /// The place name for this map link. This corresponds to the lower zone name found in the actual in-game map UI. eg, "Limsa Lominsa Upper Decks"
/// </summary> /// </summary>
[JsonIgnore]
public string PlaceName public string PlaceName
{ {
get get
@ -129,7 +136,10 @@ namespace Dalamud.Game.Chat.SeStringHandling.Payloads
/// </summary> /// </summary>
public string DataString => $"m:{TerritoryType.RowId},{Map.RowId},{RawX},{RawY}"; public string DataString => $"m:{TerritoryType.RowId},{Map.RowId},{RawX},{RawY}";
[JsonProperty]
private uint territoryTypeId; private uint territoryTypeId;
[JsonProperty]
private uint mapId; private uint mapId;
// there is no Z; it's purely in the text payload where applicable // there is no Z; it's purely in the text payload where applicable

6
Dalamud/Game/Chat/SeStringHandling/Payloads/PlayerPayload.cs
View file

@ -4,6 +4,7 @@ using System.Collections.Generic;
using System.IO; using System.IO;
using System.Text; using System.Text;
using Dalamud.Data; using Dalamud.Data;
using Newtonsoft.Json;
namespace Dalamud.Game.Chat.SeStringHandling.Payloads namespace Dalamud.Game.Chat.SeStringHandling.Payloads
{ {
@ -14,10 +15,12 @@ namespace Dalamud.Game.Chat.SeStringHandling.Payloads
{ {
public override PayloadType Type => PayloadType.Player; public override PayloadType Type => PayloadType.Player;
[JsonProperty]
private string playerName; private string playerName;
/// <summary> /// <summary>
/// The player's displayed name. This does not contain the server name. /// The player's displayed name. This does not contain the server name.
/// </summary> /// </summary>
[JsonIgnore]
public string PlayerName public string PlayerName
{ {
get { return this.playerName; } get { return this.playerName; }
@ -35,6 +38,7 @@ namespace Dalamud.Game.Chat.SeStringHandling.Payloads
/// <remarks> /// <remarks>
/// Value is evaluated lazily and cached. /// Value is evaluated lazily and cached.
/// </remarks> /// </remarks>
[JsonIgnore]
public World World public World World
{ {
get get
@ -48,8 +52,10 @@ namespace Dalamud.Game.Chat.SeStringHandling.Payloads
/// A text representation of this player link matching how it might appear in-game. /// A text representation of this player link matching how it might appear in-game.
/// The world name will always be present. /// The world name will always be present.
/// </summary> /// </summary>
[JsonIgnore]
public string DisplayedName => $"{PlayerName}{(char)SeIconChar.CrossWorld}{World.Name}"; public string DisplayedName => $"{PlayerName}{(char)SeIconChar.CrossWorld}{World.Name}";
[JsonProperty]
private uint serverId; private uint serverId;
internal PlayerPayload() { } internal PlayerPayload() { }

5
Dalamud/Game/Chat/SeStringHandling/Payloads/RawPayload.cs
View file

@ -1,3 +1,4 @@
using Newtonsoft.Json;
using System; using System;
using System.Collections.Generic; using System.Collections.Generic;
using System.IO; using System.IO;
@ -20,6 +21,7 @@ namespace Dalamud.Game.Chat.SeStringHandling.Payloads
public override PayloadType Type => PayloadType.Unknown; public override PayloadType Type => PayloadType.Unknown;
[JsonProperty]
private byte[] data; private byte[] data;
// this is a bit different from the underlying data // this is a bit different from the underlying data
// We need to store just the chunk data for decode to behave nicely, but when reading data out // We need to store just the chunk data for decode to behave nicely, but when reading data out
@ -28,6 +30,7 @@ namespace Dalamud.Game.Chat.SeStringHandling.Payloads
/// The entire payload byte sequence for this payload. /// The entire payload byte sequence for this payload.
/// The returned data is a clone and modifications will not be persisted. /// The returned data is a clone and modifications will not be persisted.
/// </summary> /// </summary>
[JsonIgnore]
public byte[] Data public byte[] Data
{ {
get get
@ -38,8 +41,10 @@ namespace Dalamud.Game.Chat.SeStringHandling.Payloads
} }
} }
[JsonProperty]
private byte chunkType; private byte chunkType;
[JsonConstructor]
internal RawPayload(byte chunkType) internal RawPayload(byte chunkType)
{ {
this.chunkType = chunkType; this.chunkType = chunkType;

3
Dalamud/Game/Chat/SeStringHandling/Payloads/StatusPayload.cs
View file

@ -3,6 +3,7 @@ using System;
using System.Collections.Generic; using System.Collections.Generic;
using System.IO; using System.IO;
using Dalamud.Data; using Dalamud.Data;
using Newtonsoft.Json;
namespace Dalamud.Game.Chat.SeStringHandling.Payloads namespace Dalamud.Game.Chat.SeStringHandling.Payloads
{ {
@ -20,6 +21,7 @@ namespace Dalamud.Game.Chat.SeStringHandling.Payloads
/// <remarks> /// <remarks>
/// Value is evaluated lazily and cached. /// Value is evaluated lazily and cached.
/// </remarks> /// </remarks>
[JsonIgnore]
public Status Status public Status Status
{ {
get get
@ -29,6 +31,7 @@ namespace Dalamud.Game.Chat.SeStringHandling.Payloads
} }
} }
[JsonProperty]
private uint statusId; private uint statusId;
internal StatusPayload() { } internal StatusPayload() { }

3
Dalamud/Game/Chat/SeStringHandling/Payloads/TextPayload.cs
View file

@ -1,3 +1,4 @@
using Newtonsoft.Json;
using System; using System;
using System.Collections.Generic; using System.Collections.Generic;
using System.IO; using System.IO;
@ -13,11 +14,13 @@ namespace Dalamud.Game.Chat.SeStringHandling.Payloads
public override PayloadType Type => PayloadType.RawText; public override PayloadType Type => PayloadType.RawText;
// allow modifying the text of existing payloads on the fly // allow modifying the text of existing payloads on the fly
[JsonProperty]
private string text; private string text;
/// <summary> /// <summary>
/// The text contained in this payload. /// The text contained in this payload.
/// This may contain SE's special unicode characters. /// This may contain SE's special unicode characters.
/// </summary> /// </summary>
[JsonIgnore]
public string Text public string Text
{ {
get { return this.text; } get { return this.text; }

5
Dalamud/Game/Chat/SeStringHandling/Payloads/UIForegroundPayload.cs
View file

@ -3,6 +3,7 @@ using System;
using System.Collections.Generic; using System.Collections.Generic;
using System.IO; using System.IO;
using Dalamud.Data; using Dalamud.Data;
using Newtonsoft.Json;
namespace Dalamud.Game.Chat.SeStringHandling.Payloads namespace Dalamud.Game.Chat.SeStringHandling.Payloads
{ {
@ -31,6 +32,7 @@ namespace Dalamud.Game.Chat.SeStringHandling.Payloads
/// <remarks> /// <remarks>
/// Value is evaluated lazily and cached. /// Value is evaluated lazily and cached.
/// </remarks> /// </remarks>
[JsonIgnore]
public UIColor UIColor public UIColor UIColor
{ {
get get
@ -43,6 +45,7 @@ namespace Dalamud.Game.Chat.SeStringHandling.Payloads
/// <summary> /// <summary>
/// The color key used as a lookup in the UIColor table for this foreground color. /// The color key used as a lookup in the UIColor table for this foreground color.
/// </summary> /// </summary>
[JsonIgnore]
public ushort ColorKey public ushort ColorKey
{ {
get { return this.colorKey; } get { return this.colorKey; }
@ -57,6 +60,7 @@ namespace Dalamud.Game.Chat.SeStringHandling.Payloads
/// <summary> /// <summary>
/// The Red/Green/Blue values for this foreground color, encoded as a typical hex color. /// The Red/Green/Blue values for this foreground color, encoded as a typical hex color.
/// </summary> /// </summary>
[JsonIgnore]
public uint RGB public uint RGB
{ {
get get
@ -65,6 +69,7 @@ namespace Dalamud.Game.Chat.SeStringHandling.Payloads
} }
} }
[JsonProperty]
private ushort colorKey; private ushort colorKey;
internal UIForegroundPayload() { } internal UIForegroundPayload() { }

5
Dalamud/Game/Chat/SeStringHandling/Payloads/UIGlowPayload.cs
View file

@ -3,6 +3,7 @@ using System;
using System.Collections.Generic; using System.Collections.Generic;
using System.IO; using System.IO;
using Dalamud.Data; using Dalamud.Data;
using Newtonsoft.Json;
namespace Dalamud.Game.Chat.SeStringHandling.Payloads namespace Dalamud.Game.Chat.SeStringHandling.Payloads
{ {
@ -31,6 +32,7 @@ namespace Dalamud.Game.Chat.SeStringHandling.Payloads
/// <remarks> /// <remarks>
/// Value is evaluated lazily and cached. /// Value is evaluated lazily and cached.
/// </remarks> /// </remarks>
[JsonIgnore]
public UIColor UIColor public UIColor UIColor
{ {
get get
@ -43,6 +45,7 @@ namespace Dalamud.Game.Chat.SeStringHandling.Payloads
/// <summary> /// <summary>
/// The color key used as a lookup in the UIColor table for this glow color. /// The color key used as a lookup in the UIColor table for this glow color.
/// </summary> /// </summary>
[JsonIgnore]
public ushort ColorKey public ushort ColorKey
{ {
get { return this.colorKey; } get { return this.colorKey; }
@ -57,6 +60,7 @@ namespace Dalamud.Game.Chat.SeStringHandling.Payloads
/// <summary> /// <summary>
/// The Red/Green/Blue values for this glow color, encoded as a typical hex color. /// The Red/Green/Blue values for this glow color, encoded as a typical hex color.
/// </summary> /// </summary>
[JsonIgnore]
public uint RGB public uint RGB
{ {
get get
@ -65,6 +69,7 @@ namespace Dalamud.Game.Chat.SeStringHandling.Payloads
} }
} }
[JsonProperty]
private ushort colorKey; private ushort colorKey;
internal UIGlowPayload() { } internal UIGlowPayload() { }

2
Dalamud/Game/Chat/SeStringHandling/SeString.cs
View file

@ -4,6 +4,7 @@ using System.IO;
using System.Linq; using System.Linq;
using System.Text; using System.Text;
using Dalamud.Game.Chat.SeStringHandling.Payloads; using Dalamud.Game.Chat.SeStringHandling.Payloads;
using Newtonsoft.Json;
namespace Dalamud.Game.Chat.SeStringHandling namespace Dalamud.Game.Chat.SeStringHandling
{ {
@ -38,6 +39,7 @@ namespace Dalamud.Game.Chat.SeStringHandling
/// Creates a new SeString from an ordered list of payloads. /// Creates a new SeString from an ordered list of payloads.
/// </summary> /// </summary>
/// <param name="payloads">The Payload objects to make up this string.</param> /// <param name="payloads">The Payload objects to make up this string.</param>
[JsonConstructor]
public SeString(List<Payload> payloads) public SeString(List<Payload> payloads)
{ {
Payloads = payloads; Payloads = payloads;