lemonuibylemon / lemonui

LemonUI for .NET (FiveM, RageMP, RagePluginHook and ScriptHookVDotNet 3)

LemonUI

LemonUI is a framework for creating UI systems in Grand Theft Auto V that is compatible with FiveM, RageMP, RagePluginHook ScriptHookVDotNet 2, and ScriptHookVDotNet 3. It allows you to create UI Elements with a NativeUI-like style, or you can also create your UI System from scratch via the resolution-independent classes for Text, Rectangles, and Textures.

It was created as a replacement for NativeUI due to being too convoluted to develop and maintain. LemonUI retains most (if not all) of the UI Elements available in NativeUI.

Special thanks to:

• Guad for the original work in NativeUI
• alloc8or for the help with the GTA Online Loading Screen Scaleform
• ikt for helping me to use SET_SCRIPT_GFX_ALIGN and SET_SCRIPT_GFX_ALIGN_PARAMS
• Dot. for the snippet of code used for the item scrolling
• deterministic_bubble for answering some questions about some missing C# classes in FiveM
• PNWParksFan for helping me with some RPH questions when I was doing the port

Download

• 5mods
• GitHub Releases
• GitHub Actions (experimental versions)

Installation

Warning: You don't need to install all of the files. You only need to install the ones for the framework you plan to use. For example, if you want to install SHVDN mods, you don't need to install the RPH version.

FiveM

You don't need to install any files when using FiveM. When you connect to a server, the resources that need it will automatically provide a copy of LemonUI.

RageMP

You don't need to install any files when using RageMP. When you connect to a server, the resources that need it will automatically provide a copy of LemonUI when compiling the code.

RagePluginHook

Copy all of the files from the RPH folder inside of the compressed file to the root of your GTA V installation directory.

ScriptHookVDotNet 2 and ScriptHookVDotNet 3

PLEASE NOTE THAT THE LAST VERSION THAT SUPPORTED SHVDN2 WAS 1.5.2. You can download it here.

Copy all of the files from the SHVDN2 and/or SHVDN3 folder(s) inside of the compressed file to your scripts directory.

Usage

Once installed, the mods that require LemonUI will start working.

Developers

Check the Quick Start guide to learn how to use LemonUI in your project.

If you would like to make changes to the code, clone the repo, restore the packages, and open the solution in your favorite IDE.

lemonui's Issues

NativeListItem ArgumentOutOfRangeException

Exception being throw when scrolling through list item. Does not occur when I comment out ammoType.SelectedItem, where ammoType is a NativeListItem object.

RagePluginHook Port

https://www.nuget.org/packages/RagePluginHook/

Drop Support for ScriptHookVDotNet2

As SHVDN2 is no longer updated and has been superseded by SHVDN3, Ill be dropping support for it in the new version.

Add the Grid Panel

I don't know what else to call it.

Is the Panel used in GTA Online to set some facial features. I guess that it returns an X and Y value that can be fetched.

Add option to change colors of foreground bars for NativeStatsInfo

I'll suggest adding options to make struct with set colors that represent sp characters, like
Michael has #65B4D4
Franklin has #ABEDAB
Trevor has #FFA357
Gta online character i think has darker blue #2D6EB9 or white.
But still give option to set from RGB.

Added missing stuff from UIMenuColoredItem

As far as I know, the UIMenuColoredItem class in NativeUI was used to change the color of the item text depending if it was hovered or not. This would probably be a good feature to implement in LemonUI.

This is probably required before we implement #17.

Alert (POPUP_WARNING) screen?

Method definitions: POPUP_WARNING
Scaleform GFX file: update.rpf/x64/data/cdimages/scaleform_frontend.rpf/popup_warning
Native counterpart: SET_WARNING_MESSAGE and related/similar natives (which requires GXT entires)

Decompiling found:

• Default title is a localized text, in English it will be Alert

Statement:

function SHOW_POPUP_WARNING(msecs, titleMsg, warningMsg, promptMsg, showBg, alertType, errorMsg)

Parameter notes:

• msecs: not found use
• errorMsg: string, optional
• promptMsg: string, optional
• alertType: seems like int (compares to loc7 which is 1, and never changed); if 1 creates a new buttonclip

glitch with franklin

so i downloaded LemonUI and when i launched the game franklin would be invisible for me and it would switch to micheal sooooo yea anyone who can help me i would appreciate that

Option to prevent the Slider arrows from being hidden

A feature for all of the items that inherit from NativeSlidableItem: a property to always show the arrows.

LemonUI Does not work with SHVDN3

I Have Tried Putting it in scripts, referencing the dll, but SHVDN3 still wont recognize LemonUI when running GTA. Can Someone Help Me?

Merge the cs files into one for RageMP

So it can be used as expected in RageMP

Add Dynamic List Item

It was part of NativeUI, but it was not implemented on the first release of LemonUI.

Is a standard list item, but the items are changed via events during runtime instead of a list.

Add missing documentation to the wiki

So far, I know that the following is missing in the documentation:

• Instructional Buttons and the different formats
• Implementation of IProcessable
• Scaleforms (all of them)

Just a TimerBar.

There is no way of just using a TimerBar without menu. Or I am doing something wrong.. I have tried several diffrent approaches before opening the issue. I can use it if I use a collection with inside only the TimerBarProgress, but Visible bool is actually acting weird.

   class Bar : Script
    {
        private static float NewProgress = 0f;
        private static readonly ObjectPool pool = new ObjectPool();
        private static readonly TimerBar bar = new TimerBarProgress("Progress") { Progress = NewProgress };

        public Bar()
        {
            pool.Add(bar);
            
            Tick += Bar_Tick;
        }

        private async System.Threading.Tasks.Task Bar_Tick()
        {
            pool.Process();
            if (API.IsPlayerFreeAiming(Game.Player.Character.Handle) == true)
            { NewProgress += 1;  }

        }
    }

Use SelectedItem as sender parameter for OnActivated?

Would using the SelectedItem as the sender parameter for the Activated event make sense?

Here and here.

If SelectedItem is used for the sender parameter, then you could do something like this in the Activated event:

private void OnActivated(object sender, EventArgs e)
{
    if (sender == firstItem)
    {
        //do something
    }
    else if (sender == secondItem)
    {
        //do something else
    }
}

With the way it currently works (using the NativeMenu as the sender parameter) you are required to use an event for each individual item.

Event for Menu Items Added/Removed

An event for detecting when a menu item is added or removed would probably be a good idea.

RageMP Support

Should be fairly simple to implement; Would fork and implement it myself if I had the time... Mainly recommending this due to RageMP's poor extendibility in the NativeUI Department (Think it actually uses the NativeUI implementation to begin with).

RAGE.Game.Invoker.Invoke( Hash , params[] );
RAGE.Game.Invoker.GetReturn()

RAGE.Game.Alignment

  public enum Alignment
  {
    Center,
    Left,
    Right,
  }

RAGE.Game.Font

  public enum Font
  {
    ChaletLondon = 0,
    HouseScript = 1,
    Monospace = 2,
    ChaletComprimeCologne = 4,
    Pricedown = 7,
  }

Event for checking Items before they are added to NativeMenu's

Or making Add(NativeItem) overridable.

Menu Flickering

Menu flickers when script tick interval is changed from default value.

Property to change the color of the Slider in the NativeSliderItem

Menu items should have different look when being hovered

Sorry if title is incorrect.

But anyway, here is the comparison:

Add mp_menu_glare

Add menu glare like in CitizenFX port of NativeUI.

Right Badge position not updating

When opening a menu with RightBadge, the position is not updated.

Temporarily fix is using Recalculate() after recreating the menu

Record_2021_04_25_16_54_01_321.mp4

Submenu description

I can't change submenus description. It works for items but submenus just keep the same description assigned in the constructor

Allow turning off the disabling of controls

NativeUI had the ControlDisablingEnabled property, which allowed you to turn off the control disabling entirely so you can handle it yourself. This would be very useful for me in LemonUI.

For example I use this feature from NativeUI in my RopeCreator mod so the Rockstar Editor isn't cancelled when opening the menu. https://gitlab.com/Jitnaught/ropecreator-gta5/-/blob/master/RopeCreator/Menu.cs#L603

Add Scaleform Support for the Rank Up Bar

Originally requested by @qiangqiang101 in Guad/NativeUI#28.

I guess that is better late than never.

"InvalidOperationException: Collection was modified" when executing ObjectPool.Remove

So I'm trying to remove a list of submenus to replace them with new ones and I'm getting this error. Sometimes also happens after adding submenus.

I can't access justalemon.ml

The site seems to be down.

LemonUI Menu isn't updating real-time when conditions are met.

NativeItem.Enabled has an issue where if bool checks are executed, the menu isn't updating real-time in-game.

(e.g.) if (RandomNumber == 1) { GiveSpeedToPed.Enabled = true; } else if (RandomNumber == 0) { GiveSpeedToPed.Enabled = false; }

Remove examples

I don't feel that the examples serve a purpose due to being too convoluted to understand for compatibility reasons (aka trying to make it compile with multiple frameworks at the same time).

Big Message weapon purchased crash

I get this error when trying to use the Big Message scaleform:

System.ArgumentException: Unexpected argument type UInt32.
Parameter name: parameters
at LemonUI.Scaleform.BaseScaleform.CallFunctionBase(String function, Object[] parameters)
at LemonUI.Scaleform.BaseScaleform.CallFunction(String function, Object[] parameters)
at LemonUI.Scaleform.BigMessage..ctor(String title, String weapon, WeaponHash hash)

It happens when this line gets executed:

There is no way to prevent the subtitle from being drawn

The subtitle background is always drawn, even when the text is empty. Current API does not provide a mechanism to hide it completely.

Big message don't have an animation when visible

Discord : DJ-LEXX#6948 [say]
I haven't tried making BigMessages using LemonUI yet but I've looked into the code and haven't found this function:

Function.Call(Hash.BEGIN_SCALEFORM_MOVIE_METHOD, new InputArgument[]
   {
      scaleform,
      "SHARD_ANIM_OUT"
   });

Add Phone contacts with LemonUI?

Phone contacts...
https://github.com/Bob74/iFruitAddon2

the above link was originated by camxxcore, updated by bob74 but it has issues and the author seems to be MIA, could you maybe fix it?

Add Item Tag

        /// <summary>
        /// Tag Property.
        /// </summary>
        public virtual object Tag { get; set; }

Pause Menu-like Interface

This is probably the continuation of Guad/NativeUI#44.

Implementation of a UI that kinda looks like the pause menu. I remember seeing it on an open source RagePluginHook mod but I don't remember which one it was.

https://vespura.com/fivem/scaleform/#PAUSE_MENU_BAR

Make Process and Recalculate overridable in NativeMenu

Add random

Not really an issue.

Would be nice if you could set the position of random items added. If you'd like to add items during runtime that is..

Items still show up as hovered when UseMouse is set to false

A weird one that I noticed when working with someone in a mod.

When you set UseMouse in a NativeMenu to false, the menu will still think that the cursor is visible and show hovered items,

Add Stats Panel

Originally requested by @qiangqiang101 in #5

It is currently implemented in INMNativeUI UIMenu.cs.

NativeItem Alternate Title

public static NativeItem weapon = new NativeItem("Weapon:");
. . .
string wHash = Function.Call<WeaponHash>(Hash.GET_SELECTED_PED_WEAPON, Game.Player.Character).ToString(); // Get current weapon
weapon.AltTitle = $"{SAM_WG.GetDisplayName(wHash)}"; // Update alt. title

Native calls missing on RagePluginHook

There are some functions that are missing the RagePluginHook calls, like:

• CallFunctionBase on BaseScaleform.cs
• Control property of the InstructionalButton struct in InstructionalButton.cs
• Process of TimerBarCollection in TimerBarCollection.cs
• Setting the cursor position in NativeMenu.cs

And others.

New scaleform - PAUSE MENU

A pause menu scaleform like on the image, as far as i remember but im not sure its created with some of these scaleforms:
Starting from https://vespura.com/fivem/scaleform/#PAUSE_MENU_BAR

But it might be for this instead, which will also be a nice to have in LemonUI

Change color of banner | rproblem

Hi, i tried to change the "Banner" of a NativeMenu with this : new_menu.Banner.Color = Color.FromArgb(255,0,0); but i get a Dark Red color instead of a Red so why ? Sadly there is no documentation about how to do it so is it a bug ?

Add the Slider panel

The Slider panel, if that is the correct way to call it, is the slider used to select some facial features in the GTA Online Character Creator.

LemonUI Not Recognized by SHVDN3 (Again)

So I It Still Occurs, I Do Have Log, But Only From The Console, Hope This Is Enough. and yes, i tried everything i could think of. Please Help Devs!

Don't process controls if the text input prompt is open

Funny enough, this was originally reported in Guad/NativeUI#119 and I forgot about it when I made LemonUI.

Right now, the menus will keep processing the controls when the text input prompt is open, meaning that this will mess with the navigation while the user enters text.

Add missing methods in NativeListItem<T>

I don't know why I had not noticed until now that all of the following methods are missing in the NativeListItem<T> class:

• Add(T)
• Add(int, T)
• Remove(T)
• RemoveAt(int)
• Remove(Func<bool, T>)
• Clear()

Setting Y value of Grid panel not working

In this line, should be GridStyle.Row instead of GridStyle.Full

https://github.com/justalemon/LemonUI/blob/master/LemonUI/Menus/NativeGridPanel.cs#L169

Allow custom colors for item backgrounds

Kinda like the "Save & Continue" item in the GTA Online Character Creator.