Merge pull request #12 from Immersive-Plugins-Team/gui

Added RawUI

Author: opus49

CHANGELOG.md

@@ -1,6 +1,13 @@
 # Changelog
 _The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/)._
 
+## [1.4] - 2023-04-17
+
+### Added
+- GUI classes (BaseFrame, Cursor, TextureFrame, TextureSprite)
+- New functions in Math class to handle some trig
+- New static Player class to interact with aforementioned functions
+
 ## [1.3] - 2022-01-31
 
 ### Added
@@ -13,7 +20,6 @@ _The format is based on [Keep a Changelog](http://keepachangelog.com/) and this
 ### Fixed
 - GetCalloutFromHandler is now safer
 
-
 ## [1.2] - 2022-01-17
 
 ### Added

IPT.Common/API/Enums.cs

@@ -0,0 +1,35 @@
+namespace IPT.Common.API
+{
+    #pragma warning disable 1591, SA1602
+
+    /// <summary>
+    /// The cursor type.
+    /// </summary>
+    public enum CursorType
+    {
+        Default,
+        Pointing,
+        Resizing,
+    }
+
+    /// <summary>
+    /// The mouse status.
+    /// </summary>
+    public enum MouseStatus
+    {
+        Up,
+        Down,
+    }
+
+    /// <summary>
+    /// A scroll or mouse wheel status.
+    /// </summary>
+    public enum ScrollWheelStatus
+    {
+        Up,
+        Down,
+        None,
+    }
+
+    #pragma warning restore 1591, SA1602
+}

IPT.Common/API/Events.cs

@@ -1,4 +1,5 @@
-using IPT.Common.User.Inputs;
+using System;
+using IPT.Common.User.Inputs;
 
 namespace IPT.Common.API
 {

IPT.Common/API/Functions.cs

@@ -1,4 +1,7 @@
-namespace IPT.Common.API
+using System;
+using Rage;
+
+namespace IPT.Common.API
 {
     /// <summary>
     /// Common helper functions.
@@ -13,5 +16,24 @@ public static bool IsGamePaused()
         {
             return Rage.Game.IsPaused || Rage.Native.NativeFunction.Natives.IS_PAUSE_MENU_ACTIVE<bool>();
         }
+
+        /// <summary>
+        /// Loads a texture from disk.
+        /// </summary>
+        /// <param name="filename">The filename of the texture.</param>
+        /// <returns>A Rage texture object.</returns>
+        public static Texture LoadTexture(string filename)
+        {
+            try
+            {
+                return Game.CreateTextureFromFile(filename);
+            }
+            catch (Exception ex)
+            {
+                API.Logging.Error("could not load texture", ex);
+            }
+
+            return null;
+        }
     }
 }

IPT.Common/API/Math.cs

@@ -1,10 +1,22 @@
-namespace IPT.Common.API
+using Rage;
+
+namespace IPT.Common.API
 {
     /// <summary>
     /// Additional math-related functions.
     /// </summary>
     public static class Math
     {
+        /// <summary>
+        /// A value used for converting radians to degrees.
+        /// </summary>
+        public static readonly double Rad2Deg = 180.0 / System.Math.PI;
+
+        /// <summary>
+        /// A value used for converting degrees to radians.
+        /// </summary>
+        public static readonly double Deg2Rad = System.Math.PI / 180.0;
+
         /// <summary>
         /// Clamps a float between two (inclusive) values.
         /// </summary>
@@ -81,5 +93,38 @@ public static int Snap(int value, int min, int max, int increment)
 
             return cValue;
         }
+
+        /// <summary>
+        /// Gets the angle (0-180 degrees) between the source and target entities.
+        /// </summary>
+        /// <param name="source">The source entity.</param>
+        /// <param name="target">The target entity.</param>
+        /// <returns>A double indicating the angle in degrees.</returns>
+        public static double GetVectorAngle(Entity source, Entity target)
+        {
+            var targetVector = target.Position - source.Position;
+            var dotProduct = Vector3.Dot(source.ForwardVector.ToNormalized(), targetVector.ToNormalized());
+            return ConvertRadiansToDegrees(System.Math.Acos(dotProduct));
+        }
+
+        /// <summary>
+        /// Converts radians into degrees.
+        /// </summary>
+        /// <param name="radians">The initial value in radians.</param>
+        /// <returns>A double value representing the radians in degrees.</returns>
+        public static double ConvertRadiansToDegrees(double radians)
+        {
+            return radians * Rad2Deg;
+        }
+
+        /// <summary>
+        /// Converts degrees into radians.
+        /// </summary>
+        /// <param name="degrees">The initial value in degrees.</param>
+        /// <returns>A double value representing the degrees in radians.</returns>
+        public static double ConvertDegreesToRadians(double degrees)
+        {
+            return degrees * Deg2Rad;
+        }
     }
 }

IPT.Common/API/Player.cs

@@ -0,0 +1,20 @@
+using Rage;
+
+namespace IPT.Common.API
+{
+    /// <summary>
+    /// Helpful player functions.
+    /// </summary>
+    public static class Player
+    {
+        /// <summary>
+        /// Gets the angle between the player and the entity.
+        /// </summary>
+        /// <param name="entity">The target entity.</param>
+        /// <returns>The angle in degrees.</returns>
+        public static double GetVectorAngleTo(Entity entity)
+        {
+            return Math.GetVectorAngle(Game.LocalPlayer.Character, entity);
+        }
+    }
+}

IPT.Common/Callouts.cs

@@ -1,6 +1,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Reflection;
+using IPT.Common.API;
 
 namespace IPT.Common
 {
@@ -51,18 +52,29 @@ public static Dictionary<string, List<string>> GetCallouts()
             foreach (var plugin in LSPD_First_Response.Mod.API.Functions.GetAllUserPlugins())
             {
                 var names = new List<string>();
-                foreach (var callout in plugin.GetTypes().Where(x => typeof(LSPD_First_Response.Mod.Callouts.Callout).IsAssignableFrom(x)))
+                try
                 {
-                    var attribute = callout.GetCustomAttributes(typeof(LSPD_First_Response.Mod.Callouts.CalloutInfoAttribute), true).FirstOrDefault();
-                    if (attribute is LSPD_First_Response.Mod.Callouts.CalloutInfoAttribute calloutInfo)
+                    foreach (var callout in plugin.GetTypes().Where(x => typeof(LSPD_First_Response.Mod.Callouts.Callout).IsAssignableFrom(x)))
                     {
-                        names.Add(calloutInfo.Name);
+                        var attribute = callout.GetCustomAttributes(typeof(LSPD_First_Response.Mod.Callouts.CalloutInfoAttribute), true).FirstOrDefault();
+                        if (attribute is LSPD_First_Response.Mod.Callouts.CalloutInfoAttribute calloutInfo)
+                        {
+                            names.Add(calloutInfo.Name);
+                        }
                     }
-                }
 
-                if (names.Any())
+                    if (names.Any())
+                    {
+                        callouts[plugin.GetName().Name] = names;
+                    }
+                }
+                catch (System.Reflection.ReflectionTypeLoadException ex)
                 {
-                    callouts[plugin.GetName().Name] = names;
+                    Logging.Warning($"there was an error while trying to access plugin: {plugin.FullName}");
+                    foreach (var entry in ex.LoaderExceptions)
+                    {
+                        Logging.Error($"{plugin.FullName}: ", entry);
+                    }
                 }
             }