Merge pull request #249 from manups4e/experimental

ScaleformUI - Update 3: Make FiveM Great Again - Part 1

Completely rewrote the main Scaleform movie.
Fixed Glare position across resolutions (16:10 is completely bad on fivem for certain ui elements)
Code Breaking:
Removed fading time parameter in Lua/C# UIMenu constructors
Removed TextColor and HighlightedTextColor parameters in Items (unused and legacy)
Disabled all animations in menu.
Rewrote menu building system.
Rewrote menu and components updating process.
Modularized Scaleform movie to give the R* feeling we didn't know we were missing and didn't know we needed.
Fixed menu switching inheritance, it's now almost instant.
Performances increased up to by 40% across ScRTs.
All the exposed API has not been edited to maintain compatibility with the new update, marking as obsolete all the removed features.
UIMenuItem is now dynamic.
UIMenuListItem supports now virtually infinite list elements
I'm sure i forgot something.. 😛
All UIMenus are now updated.
Next update will bring a totally renewed and rewrote PauseMenu.

Author: manups4e

MenuExample/MenuExample.cs

@@ -29,18 +29,17 @@ public class MenuExample : BaseScript
     #region UIMenu
     public async void ExampleMenu()
     {
-        long _titledui = API.CreateDui("https://i.imgur.com/3yrFYbF.gif", 288, 130);
+        long _titledui = API.CreateDui("https://media.tenor.com/-sL5lSwzQSkAAAAi/rolling-cute.gif", 288, 130);
         API.CreateRuntimeTextureFromDuiHandle(txd, "bannerbackground", API.GetDuiHandle(_titledui));
 
         long _kitten = API.CreateDui("https://i.giphy.com/media/v1.Y2lkPTc5MGI3NjExczA0dXhscDRqbHBmb3I2bmk4dDVzd25uNmhhbHNmMnE5N3hkYTM0MiZlcD12MV9pbnRlcm5hbF9naWZfYnlfaWQmY3Q9Zw/tY27Dk0H8IisGidQv6/giphy.gif", 480, 480);
         API.CreateRuntimeTextureFromDuiHandle(txd, "kitty", API.GetDuiHandle(_kitten));
 
         // first true means add menu Glare scaleform to the menu
         // last true means it's using the alternative title style
-        UIMenu exampleMenu = new UIMenu("ScaleformUI", "ScaleformUI ~o~SHOWCASE", new PointF(0, 0), "commonmenu", "interaction_bgd", true, true, 0f, MenuAlignment.RIGHT);
+        UIMenu exampleMenu = new UIMenu("ScaleformUI", "ScaleformUI ~o~SHOWCASE", new PointF(376, 50), "commonmenu", "interaction_bgd", true, true, MenuAlignment.RIGHT);
         exampleMenu.MaxItemsOnScreen = 7; // To decide max items on screen at time, default 7
-        exampleMenu.SetAnimations(true, true, MenuAnimationType.LINEAR, MenuBuildingAnimation.LEFT_RIGHT);
-        exampleMenu.SetMouse(false, false, false, false, false);
+        exampleMenu.SetMouse(true, false, true, false, false);
 
         //exampleMenu.CounterColor = HudColor.HUD_COLOUR_PINK;
         // let's add the menu to the Pool
@@ -152,7 +151,7 @@ public async void ExampleMenu()
         UIMenuCheckboxItem ketchupItem = new UIMenuCheckboxItem("~g~Scrolling animation enabled? ~b~in a very long label to ~o~test the text scrolling feature!", UIMenuCheckboxStyle.Tick, enabled, "Do you wish to enable the scrolling animation?");
         long _paneldui = API.CreateDui("https://i.imgur.com/mH0Y65C.gif", 288, 160);
         API.CreateRuntimeTextureFromDuiHandle(txd, "panelbackground", API.GetDuiHandle(_paneldui));
-        UIMissionDetailsPanel sidePanel = new UIMissionDetailsPanel(PanelSide.Right, "Side Panel", true, "scaleformui", "panelbackground");
+        UIMissionDetailsPanel sidePanel = new UIMissionDetailsPanel(PanelSide.Right, "Side Panel", true, "scaleformui", "bannerbackground");
         UIFreemodeDetailsItem detailItem1 = new UIFreemodeDetailsItem("Left Label", "RIGHT LABEL", ScaleformFonts.SIGNPAINTER_HOUSESCRIPT, ScaleformFonts.GTAV_TAXI_DIGITAL, BadgeIcon.BRIEFCASE, SColor.FromRandomValues());
         UIFreemodeDetailsItem detailItem2 = new UIFreemodeDetailsItem("Left Label", "RIGHT LABEL", ScaleformFonts.SIGNPAINTER_HOUSESCRIPT, ScaleformFonts.GTAV_TAXI_DIGITAL, BadgeIcon.MISSION_STAR, SColor.FromRandomValues());
         UIFreemodeDetailsItem detailItem3 = new UIFreemodeDetailsItem("Left Label", "RIGHT LABEL", ScaleformFonts.SIGNPAINTER_HOUSESCRIPT, ScaleformFonts.GTAV_TAXI_DIGITAL, BadgeIcon.ARMOR, SColor.FromRandomValues());
@@ -230,10 +229,6 @@ public async void ExampleMenu()
         exampleMenu.AddItem(BlankItem);
         exampleMenu.AddItem(BlankItem_2);
 
-        UIMenuListItem colorListItem = new UIMenuListItem("Choose the scrolling animation", foodsList, (int)exampleMenu.AnimationType, "~BLIP_BARBER~ ~BLIP_INFO_ICON~ ~BLIP_TANK~ ~BLIP_OFFICE~ ~BLIP_CRIM_DRUGS~ ~BLIP_WAYPOINT~ ~INPUTGROUP_MOVE~~n~You can use Blips and Inputs in description as you prefer!~n~⚠ 🐌 ❤️ 🥺 💪🏻 You can use Emojis too!", SColor.HUD_Freemode_dark, SColor.HUD_Freemode);
-        colorListItem.BlinkDescription = true;
-        exampleMenu.AddItem(colorListItem);
-
         UIMenuSliderItem slider = new UIMenuSliderItem("Slider Item", "Cool!", true); // by default max is 100 and multipler 5 = 20 steps.
         exampleMenu.AddItem(slider);
         UIMenuProgressItem progress = new UIMenuProgressItem("Slider Progress Item", 10, 0);
@@ -275,6 +270,22 @@ public async void ExampleMenu()
         statistics.UpdateStatistic(0, 10f);
         statistics.UpdateStatistic(1, 50f);
         statistics.UpdateStatistic(2, 100f);
+        listPanelItem4.OnListChanged += (a, b) =>
+        {
+            switch (b)
+            {
+                case 0:
+                    statistics.UpdateStatistic(0, 10f);
+                    statistics.UpdateStatistic(1, 50f);
+                    statistics.UpdateStatistic(2, 100f);
+                    break;
+                case 1:
+                    statistics.UpdateStatistic(0, 100f);
+                    statistics.UpdateStatistic(1, 50f);
+                    statistics.UpdateStatistic(2, 10f);
+                    break;
+            }
+        };
         //and you can get / set their percentage
 
 
@@ -292,12 +303,13 @@ public async void ExampleMenu()
         windowSubmenu.AddWindow(statsWindow);
         List<dynamic> momfaces = new List<dynamic>() { "Hannah", "Audrey", "Jasmine", "Giselle", "Amelia", "Isabella", "Zoe", "Ava", "Camilla", "Violet", "Sophia", "Eveline", "Nicole", "Ashley", "Grace", "Brianna", "Natalie", "Olivia", "Elizabeth", "Charlotte", "Emma", "Misty" };
         List<dynamic> dadfaces = new List<dynamic>() { "Benjamin", "Daniel", "Joshua", "Noah", "Andrew", "Joan", "Alex", "Isaac", "Evan", "Ethan", "Vincent", "Angel", "Diego", "Adrian", "Gabriel", "Michael", "Santiago", "Kevin", "Louis", "Samuel", "Anthony", "Claude", "Niko", "John" };
-        UIMenuListItem mom = new UIMenuListItem("Mamma", momfaces, 0);
-        UIMenuListItem dad = new UIMenuListItem("Papà", dadfaces, 0);
+        UIMenuListItem mom = new UIMenuListItem("Mom", momfaces, 0);
+        UIMenuListItem dad = new UIMenuListItem("Dad", dadfaces, 0);
         UIMenuSliderItem newItem = new UIMenuSliderItem("Heritage Slider", "This is Useful on heritage", 100, 5, 50, true);
         windowSubmenu.AddItem(mom);
         windowSubmenu.AddItem(dad);
         windowSubmenu.AddItem(newItem);
+
         statsWindow.DetailMid = "Dad: " + newItem.Value + "%";
         statsWindow.DetailBottom = "Mom: " + (100 - newItem.Value) + "%";
         statsWindow.DetailStats = new List<UIDetailStat>()
@@ -419,6 +431,7 @@ public async void ExampleMenu()
         align.OnListChanged += (item, index) => 
         { 
             item.Parent.MenuAlignment = (MenuAlignment)index; 
+            exampleMenu.MenuAlignment = (MenuAlignment)index;
         };
 
         UIMenuDynamicListItem offsetX = new UIMenuDynamicListItem("Offset X", "Change the X offset of the menu", exampleMenu.Offset.X.ToString("F3"), async (sender, direction) =>
@@ -995,8 +1008,8 @@ public async void ExampleMenu()
             if (item == ketchupItem)
             {
                 enabled = checked_;
-                sender.EnableAnimation = enabled;
-                colorListItem.Enabled = enabled;
+                scrollType.Enabled = checked_;
+                scrollType.SetLeftBadge(checked_ ? BadgeIcon.NONE : BadgeIcon.LOCK);
                 Notifications.ShowNotification("~r~Menu animation: ~b~" + (enabled ? "Enabled" : "Disabled"));
             }
         };
@@ -1016,12 +1029,6 @@ public async void ExampleMenu()
             //cookItem.SetLeftBadge(BadgeIcon.NONE);
         };
 
-        exampleMenu.OnListChange += (sender, item, index) =>
-        {
-            if (item == colorListItem)
-                sender.AnimationType = (MenuAnimationType)index;
-        };
-
         exampleMenu.OnMenuOpen += (menu, data) =>
         {
             Screen.ShowSubtitle($"{menu.Title} just opened!", 3000);

ScaleformUI_Csharp/Elements/ScreenTools.cs

@@ -76,7 +76,7 @@ public static Vector2 ConvertScaleformCoordsToScreenCoords(float scaleformX, flo
             // Normalize coordinates to 0.0 - 1.0 range
             int w = 0, h = 0;
             GetActiveScreenResolution(ref w, ref h);
-            return new Vector2((scaleformX / w) * 2f - 1f, (scaleformY / h) * 2f - 1f);
+            return new Vector2(scaleformX / w, scaleformY / h);
         }
 
         public static Vector2 ConvertResolutionCoordsToScreenCoords(float x, float y)
@@ -87,6 +87,21 @@ public static Vector2 ConvertResolutionCoordsToScreenCoords(float x, float y)
             return new Vector2(normalizedX, normalizedY);
         }
 
+
+        /// <summary>
+        /// Converts scaleform size(1280 x 720) into screen size(0.0 - 1.0)
+        /// </summary>
+        /// <param name="scaleformWidth"></param>
+        /// <param name="scaleformHeight"></param>
+        /// <returns></returns>
+        public static SizeF ConvertScaleformSizeToScreenSize(float scaleformWidth, float scaleformHeight)
+        {
+            //Normalize size to 0.0 - 1.0 range
+            int w = 0, h = 0;
+            GetActiveScreenResolution(ref w, ref h);
+            return new SizeF(scaleformWidth / w, scaleformHeight / h);
+        }
+
         public static void AdjustNormalized16_9ValuesForCurrentAspectRatio(int widescreen, ref Vector2 pos, ref SizeF size)
         {
             if (widescreen == 0)

ScaleformUI_Csharp/Menus/MenuBase.cs

@@ -16,7 +16,7 @@ public virtual bool Visible
             }
         }
         public List<InstructionalButton> InstructionalButtons { get; set; }
-        internal virtual void ProcessControl(Keys key = Keys.None)
+        internal virtual void ProcessControl()
         {
 
         }

ScaleformUI_Csharp/Menus/MenuHandler.cs

@@ -64,7 +64,6 @@ public static async Task SwitchTo(this MenuBase currentMenu, MenuBase newMenu, i
 
             if (currentMenu is UIMenu old)
             {
-                await old.FadeOutMenu();
                 currentMenu.Visible = false;
                 if (newMenu is UIMenu newer)
                 {
@@ -79,9 +78,7 @@ public static async Task SwitchTo(this MenuBase currentMenu, MenuBase newMenu, i
                         newer.MaxItemsOnScreen = old.MaxItemsOnScreen;
                         newer.ScrollingType = old.ScrollingType;
                         newer.Glare = old.Glare;
-                        newer.fadingTime = old.fadingTime;
                         newer.SetMouse(old.MouseControlsEnabled, old.MouseEdgeEnabled, old.MouseWheelControlEnabled, old.ResetCursorOnOpen, old.leftClickEnabled);
-                        newer.SetAnimations(old.EnableAnimation, old.Enabled3DAnimations, old.AnimationType, old.BuildingAnimation);
                         newer.SubtitleColor = old.SubtitleColor;
                     }
                     newer.CurrentSelection = newMenuCurrentSelection != 0 ? newMenuCurrentSelection : 0;