diff --git a/MiraAPI/Hud/MiraHudHelper.cs b/MiraAPI/Hud/MiraHudHelper.cs
index f6ead88..f2d1d4b 100644
--- a/MiraAPI/Hud/MiraHudHelper.cs
+++ b/MiraAPI/Hud/MiraHudHelper.cs
@@ -9,27 +9,82 @@ using UnityEngine;
namespace MiraAPI.Hud;
+///
+/// A mono script to handle hud behaviour.
+///
+/// The Il2Cpp pointer to the script's object.
[RegisterInIl2Cpp]
[SuppressMessage("Style", "IDE0051:Remove unused private members", Justification = "Unity Convention.")]
[SuppressMessage("Critical Code Smell", "S2223:Non-constant static fields should not be visible", Justification = "Is internal code. Property-level protections are not required.")]
[SuppressMessage("StyleCop.CSharp.MaintainabilityRules", "SA1401:Fields should be private", Justification = "Read above.")]
public sealed class MiraHudHelper(nint cppPtr) : MonoBehaviour(cppPtr)
{
+ ///
+ /// Gets the static instance of .
+ ///
public static MiraHudHelper Instance { get; private set; }
- public static GameObject ModifierDisplayObject;
- public static GameObject VanillaMatchInfoButton;
- public static bool ModifierDisplayOnRight;
- public static GameObject ClonedChatButton;
- public static GameObject ExtraUiTopRight;
- public static GridArrange ExtraUiGrid;
- public static AspectPosition ExtraUiAspectPos;
- public static GameObject UiTopRight;
- public static GridArrange UiGrid;
- public static AspectPosition UiAspectPos;
- public static GameObject SubmergedFloorButton;
- public static SpriteRenderer SubmergedFloorButtonRenderer;
- public static SpriteRenderer SubmergedFloorButtonRendererHover;
+ ///
+ /// Gets or sets the vanilla match info button.
+ ///
+ public static GameObject VanillaMatchInfoButton { get; set; }
+
+ ///
+ /// Gets or sets the modifier display menu.
+ ///
+ public static GameObject ModifierDisplayObject { get; set; }
+
+ ///
+ /// Gets the cloned chat button.
+ ///
+ public static GameObject ClonedChatButton { get; private set; }
+
+ ///
+ /// Gets the object for extra top right buttons.
+ ///
+ public static GameObject ExtraUiTopRight { get; private set; }
+
+ ///
+ /// Gets the arranger object for the extra ui grid.
+ ///
+ public static GridArrange ExtraUiGrid { get; private set; }
+
+ ///
+ /// Gets the aspect position for the extra ui grid.
+ ///
+ public static AspectPosition ExtraUiAspectPos { get; private set; }
+
+ ///
+ /// Gets the top right ui object.
+ ///
+ public static GameObject UiTopRight { get; private set; }
+
+ ///
+ /// Gets the arranger object for the ui grid.
+ ///
+ public static GridArrange UiGrid { get; private set; }
+
+ ///
+ /// Gets the aspect position for the ui grid.
+ ///
+ public static AspectPosition UiAspectPos { get; private set; }
+
+ ///
+ /// Gets the game object of the Submerged map floor change button.
+ ///
+ public static GameObject SubmergedFloorButton { get; private set; }
+
+ ///
+ /// Gets the normal sprite renderer of the Submerged floor change button.
+ ///
+ public static SpriteRenderer SubmergedFloorButtonRenderer { get; private set; }
+
+ ///
+ /// Gets the hover sprite renderer of the Submerged floor change button.
+ ///
+ public static SpriteRenderer SubmergedFloorButtonRendererHover { get; private set; }
+
+ internal static bool ModifierDisplayOnRight;
private static readonly Vector3 BelowOptionPos = new(0.435f, 1.25f, 0f);
private static readonly Vector3 FullTopPos = new(0.435f, 0.475f, 0f);