diff --git a/.editorconfig b/.editorconfig index 1561783..e091cf9 100644 --- a/.editorconfig +++ b/.editorconfig @@ -1,6 +1 @@ -[*.{cs,vb}] -dotnet_diagnostic.CA1707.severity = none -dotnet_diagnostic.CS1591.severity = none -dotnet_diagnostic.S125.severity = none -dotnet_diagnostic.SA1615.severity = none -dotnet_diagnostic.SA1611.severity = none \ No newline at end of file +[*.{cs,vb}] \ No newline at end of file diff --git a/MiraAPI/Utilities/Assets/MiraAssets.cs b/MiraAPI/Utilities/Assets/MiraAssets.cs index 283d57c..74fed0d 100644 --- a/MiraAPI/Utilities/Assets/MiraAssets.cs +++ b/MiraAPI/Utilities/Assets/MiraAssets.cs @@ -3,18 +3,58 @@ using UnityEngine; namespace MiraAPI.Utilities.Assets; +/// +/// A static class that contains various assets used in the Mira API. +/// public static class MiraAssets { - public static readonly AssetBundle MiraAssetBundle = AssetBundleManager.Load("mirabundle"); - public static readonly LoadableAsset ModifierDisplay = new LoadableBundleAsset("Modifiers", MiraAssetBundle); + /// + /// Gets the color used for teal highlighting in UI. + /// + public static Color32 AcceptedTeal { get; } = new(43, 233, 198, 255); - public static readonly LoadableResourceAsset Empty = new("MiraAPI.Resources.Empty.png"); + /// + /// Gets the Mira API asset bundle. + /// + public static AssetBundle MiraAssetBundle { get; } = AssetBundleManager.Load("mirabundle"); - public static readonly LoadableResourceAsset NextButton = new("MiraAPI.Resources.NextButton.png"); - public static readonly LoadableResourceAsset NextButtonActive = new("MiraAPI.Resources.NextButtonActive.png"); - public static readonly LoadableResourceAsset Cog = new("MiraAPI.Resources.Cog.png"); - public static readonly LoadableResourceAsset Checkmark = new("MiraAPI.Resources.Checkmark.png"); - public static readonly LoadableResourceAsset CategoryHeader = new("MiraAPI.Resources.CategoryHeader.png"); - public static readonly LoadableResourceAsset CheckmarkBox = new("MiraAPI.Resources.CheckMarkBox.png"); - public static readonly Color32 AcceptedTeal = new(43, 233, 198, 255); + /// + /// Gets the ModifierDisplay prefab. + /// + public static LoadableAsset ModifierDisplay { get; } = new LoadableBundleAsset("Modifiers", MiraAssetBundle); + + /// + /// Gets the empty sprite asset. + /// + public static LoadableResourceAsset Empty { get; } = new("MiraAPI.Resources.Empty.png"); + + /// + /// Gets the Next Button sprite. + /// + public static LoadableResourceAsset NextButton { get; } = new("MiraAPI.Resources.NextButton.png"); + + /// + /// Gets the highlighted Next Button sprite. + /// + public static LoadableResourceAsset NextButtonActive { get; } = new("MiraAPI.Resources.NextButtonActive.png"); + + /// + /// Gets the Cog icon used in Role Settings Menu. + /// + public static LoadableResourceAsset Cog { get; } = new("MiraAPI.Resources.Cog.png"); + + /// + /// Gets the Checkmark Box used in the Settings Menu. + /// + public static LoadableResourceAsset CheckmarkBox { get; } = new("MiraAPI.Resources.CheckMarkBox.png"); + + /// + /// Gets the Checkmark used in the Settings Menu. + /// + public static LoadableResourceAsset Checkmark { get; } = new("MiraAPI.Resources.Checkmark.png"); + + /// + /// Gets the white CategoryHeader used in the Settings Menu. + /// + public static LoadableResourceAsset CategoryHeader { get; } = new("MiraAPI.Resources.CategoryHeader.png"); }