From b7e36fb2e64f2bd7498f6f6e35a0dfc2f2d7bab5 Mon Sep 17 00:00:00 2001 From: goat <16760685+goaaats@users.noreply.github.com> Date: Fri, 14 Aug 2020 02:34:03 +0200 Subject: [PATCH] refactor: clean up some warnings --- Dalamud/DalamudStartInfo.cs | 5 +- Dalamud/Game/Chat/SeIconChar.cs | 1 + Dalamud/Game/Chat/XivChatType.cs | 1 + .../Game/ClientState/Actors/CustomizeIndex.cs | 103 ++++++++++++++++++ Dalamud/Game/ClientState/Structs/Actor.cs | 1 + Dalamud/Interface/FontAwesomeIcon.cs | 1 + Dalamud/Plugin/PluginDefinition.cs | 35 ++++++ Dalamud/Plugin/PluginManager.cs | 2 +- 8 files changed, 147 insertions(+), 2 deletions(-) diff --git a/Dalamud/DalamudStartInfo.cs b/Dalamud/DalamudStartInfo.cs index 8cd60d92f..bb5ffe83d 100644 --- a/Dalamud/DalamudStartInfo.cs +++ b/Dalamud/DalamudStartInfo.cs @@ -1,5 +1,5 @@ using System; -using Dalamud.DiscordBot; +#pragma warning disable 1591 namespace Dalamud { [Serializable] @@ -15,6 +15,9 @@ namespace Dalamud { public string GameVersion; } + /// + /// Enum describing the language the game loads in. + /// public enum ClientLanguage { Japanese, diff --git a/Dalamud/Game/Chat/SeIconChar.cs b/Dalamud/Game/Chat/SeIconChar.cs index 401238689..077dd7674 100644 --- a/Dalamud/Game/Chat/SeIconChar.cs +++ b/Dalamud/Game/Chat/SeIconChar.cs @@ -3,6 +3,7 @@ using System.Collections.Generic; using System.Linq; using System.Text; using System.Threading.Tasks; +#pragma warning disable 1591 namespace Dalamud.Game.Chat { diff --git a/Dalamud/Game/Chat/XivChatType.cs b/Dalamud/Game/Chat/XivChatType.cs index b0f04a93b..ab3469420 100644 --- a/Dalamud/Game/Chat/XivChatType.cs +++ b/Dalamud/Game/Chat/XivChatType.cs @@ -1,5 +1,6 @@ using System; using System.Linq; +#pragma warning disable 1591 namespace Dalamud.Game.Chat { diff --git a/Dalamud/Game/ClientState/Actors/CustomizeIndex.cs b/Dalamud/Game/ClientState/Actors/CustomizeIndex.cs index 93553f0b7..d29c2f2ec 100644 --- a/Dalamud/Game/ClientState/Actors/CustomizeIndex.cs +++ b/Dalamud/Game/ClientState/Actors/CustomizeIndex.cs @@ -11,31 +11,134 @@ namespace Dalamud.Game.ClientState.Actors /// // TODO: This may need some rework since it may not be entirely accurate (stolen from Sapphire) public enum CustomizeIndex { + /// + /// The race of the character. + /// Race = 0x00, + + /// + /// The gender of the character. + /// Gender = 0x01, + + /// + /// The tribe of the character. + /// Tribe = 0x04, + + /// + /// The height of the character. + /// Height = 0x03, + + /// + /// The model type of the character. + /// ModelType = 0x02, // Au Ra: changes horns/tails, everything else: seems to drastically change appearance (flip between two sets, odd/even numbers). sometimes retains hairstyle and other features + + /// + /// The face type of the character. + /// FaceType = 0x05, + + /// + /// The hair of the character. + /// HairStyle = 0x06, + + /// + /// Whether or not the character has hair highlights. + /// HasHighlights = 0x07, // negative to enable, positive to disable + + /// + /// The skin color of the character. + /// SkinColor = 0x08, + + /// + /// The eye color of the character. + /// EyeColor = 0x09, // color of character's right eye + + /// + /// The hair color of the character. + /// HairColor = 0x0A, // main color + + /// + /// The highlights hair color of the character. + /// HairColor2 = 0x0B, // highlights color + + /// + /// The face features of the character. + /// FaceFeatures = 0x0C, // seems to be a toggle, (-odd and +even for large face covering), opposite for small + + /// + /// The color of the face features of the character. + /// FaceFeaturesColor = 0x0D, + + /// + /// The eyebrows of the character. + /// Eyebrows = 0x0E, + + /// + /// The 2nd eye color of the character. + /// EyeColor2 = 0x0F, // color of character's left eye + + /// + /// The eye shape of the character. + /// EyeShape = 0x10, + + /// + /// The nose shape of the character. + /// NoseShape = 0x11, + + /// + /// The jaw shape of the character. + /// JawShape = 0x12, + + /// + /// The lip style of the character. + /// LipStyle = 0x13, // lip colour depth and shape (negative values around -120 darker/more noticeable, positive no colour) + + /// + /// The lip color of the character. + /// LipColor = 0x14, + + /// + /// The race feature size of the character. + /// RaceFeatureSize = 0x15, + + /// + /// The race feature type of the character. + /// RaceFeatureType = 0x16, // negative or out of range tail shapes for race result in no tail (e.g. Au Ra has max of 4 tail shapes), incorrect value can crash client + + /// + /// The bust size of the character. + /// BustSize = 0x17, // char creator allows up to max of 100, i set to 127 cause who wouldnt but no visible difference + + /// + /// The face paint of the character. + /// Facepaint = 0x18, + + /// + /// The face paint color of the character. + /// FacepaintColor = 0x19, } } diff --git a/Dalamud/Game/ClientState/Structs/Actor.cs b/Dalamud/Game/ClientState/Structs/Actor.cs index 2675fa5c3..fa70e130d 100644 --- a/Dalamud/Game/ClientState/Structs/Actor.cs +++ b/Dalamud/Game/ClientState/Structs/Actor.cs @@ -5,6 +5,7 @@ using System.Runtime.InteropServices; using System.Text; using System.Threading.Tasks; using Dalamud.Game.ClientState.Actors; +#pragma warning disable 1591 namespace Dalamud.Game.ClientState.Structs { diff --git a/Dalamud/Interface/FontAwesomeIcon.cs b/Dalamud/Interface/FontAwesomeIcon.cs index 104a931f6..c433715b3 100644 --- a/Dalamud/Interface/FontAwesomeIcon.cs +++ b/Dalamud/Interface/FontAwesomeIcon.cs @@ -1,5 +1,6 @@ //Font-Awesome - Version 5.0.9 using System.Collections.Generic; +#pragma warning disable 1591 namespace Dalamud.Interface { diff --git a/Dalamud/Plugin/PluginDefinition.cs b/Dalamud/Plugin/PluginDefinition.cs index b0a371fb1..be3ccd2fe 100644 --- a/Dalamud/Plugin/PluginDefinition.cs +++ b/Dalamud/Plugin/PluginDefinition.cs @@ -8,14 +8,49 @@ namespace Dalamud.Plugin { public class PluginDefinition { + /// + /// The author/s of the plugin. + /// public string Author { get; set; } + + /// + /// The public name of the plugin. + /// public string Name { get; set; } + + /// + /// The internal name of the plugin, which should match the assembly name of the plugin. + /// public string InternalName { get; set; } + + /// + /// The current assembly version of the plugin. + /// public string AssemblyVersion { get; set; } + + /// + /// A description of the plugins functions. + /// public string Description { get; set; } + + /// + /// The version of the game this plugin works with. + /// public string ApplicableVersion { get; set; } + + /// + /// An URL to the website or source code of the plugin. + /// public string RepoUrl { get; set; } + + /// + /// Whether or not the plugin is hidden in the plugin installer. + /// public bool IsHide { get; set; } + + /// + /// The API level of this plugin. For the current API level, please see for the currently used API level. + /// public int DalamudApiLevel { get; set; } } } diff --git a/Dalamud/Plugin/PluginManager.cs b/Dalamud/Plugin/PluginManager.cs index 402ea79dd..9c0998be2 100644 --- a/Dalamud/Plugin/PluginManager.cs +++ b/Dalamud/Plugin/PluginManager.cs @@ -12,7 +12,7 @@ using Serilog; namespace Dalamud.Plugin { internal class PluginManager { - public const int DALAMUD_API_LEVEL = 1; + public static int DALAMUD_API_LEVEL = 1; private readonly Dalamud dalamud; private readonly string pluginDirectory;