UIMenuItem

UIMenuItem is the father of all other items, this means that every other menu-item has the same functions and features of this item except for some that are disabled for design reason.

Constructor

public UIMenuItem(string text);
public UIMenuItem(string text, string description);
public UIMenuItem(string text, uint descriptionHash);
public UIMenuItem(string text, string description, HudColor mainColor, HudColor highlightColor);
public UIMenuItem(string text, uint descriptionHash, HudColor mainColor, HudColor highlightColor);
public UIMenuItem(string text, string description, HudColor color, HudColor highlightColor, HudColor textColor, HudColor highlightedTextColor);
public UIMenuItem(string text, uint descriptionHash, HudColor color, HudColor highlightColor, HudColor textColor, HudColor highlightedTextColor);

UIMenuItem.New(text, description, color, highlightColor, textColor, highlightedTextColor)

Parameters

Selected

Sets or gets the selected state of the menu item, and updates the menu labels accordingly.

public bool Selected {get;set;}
item.Selected = true;

--- Sets or gets the selected state of the menu item, and updates the menu labels accordingly.
item:Selected(bool)

---

Hovered

Sets or gets the hovered state of the menu item.

public bool Hovered {get;set;}
item.Hovered = true;

--- Sets or gets the hovered state of the menu item.
item:Hovered(bool)

---

Enabled

Sets or gets the enabled state of the menu item, and updates the menu labels accordingly.

public bool Enabled {get;set;}
item.Enabled = true;

--- Sets or gets the enabled state of the menu item, and updates the menu labels accordingly.
item:Enabled(bool)

---

Description

Sets or gets the description for the menu item.

public string Description {get;set;}
item.Description = "This is a description";

--- Sets or gets the description for the menu item.
item:Description(str)

---

MainColor

Sets or gets the main color for the menu item.

public SColor MainColor {get;set;}
item.MainColor = SColor.FromArgb(255, 0, 0);

--- Sets or gets the main color for the menu item.
item:MainColor(color)

---

TextColor

Sets or gets the text color for the menu item.

public SColor TextColor {get;set;}
item.TextColor(SColor(0, 255, 0)); -- Green color

--- Sets or gets the text color for the menu item.
item:TextColor(color)

---

HighlightColor

Sets or gets the highlight color for the menu item.

public SColor HighlightColor {get;set;}
item.HighlightColor = SColor.FromArgb(0, 0, 255);

--- Sets or gets the highlight color for the menu item.
item:HighlightColor(color)

---

HighlightedTextColor

Sets or gets the text color when the item is highlighted.

public SColor HighlightedTextColor {get;set;}
item.HighlightedTextColor = SColor.FromArgb(255, 255, 0);

--- Sets or gets the text color when the item is highlighted.
item:HighlightedTextColor(color)

---

Label

Sets or gets the left label for the menu item.

public string Label {get;set;}
item.Label = "Left Label";

--- Sets or gets the left label for the menu item.
item:Label(Text)

---

RightLabel

Sets (Lua only) or gets the right label for the menu item.

public string RightLabel {get; private set;}
var rLabel = item.RightLabel;

--- Sets or gets the right label for the menu item.
item:RightLabel(Text)

---

RightBadge

Sets (Lua only) or gets the right badge for the menu item.

public BadgeIcon RightBadge {get;private set;}
var badge = item.RightBadge;

--- Sets or gets the right badge for the menu item.
item:RightBadge(Badge)

---

LeftBadge

Sets (Lua only) or gets the left badge for the menu item.

void LeftBadge {get;private set;}
var lBadge = item.LeftBadge;

--- Sets or gets the left badge for the menu item.
item:LeftBadge(Badge)

Functions

BlinkDescription

Sets or retrieves the blinking description for a menu item. If bool is provided, it sets the blinking status, otherwise, it returns the current blinking status.

public bool BlinkDescription {get;set;}
item.BlinkDescription = true;

--- Sets or retrieves the blinking description for a menu item.
function item:BlinkDescription(bool)

CustomRightBadge

Sets a custom right badge for a menu item, typically used for visual indicators such as icons.

public void SetCustomRightBadge(txd, txn)
item.SetCustomRightBadge("txd", "txn");

--- Sets a custom right badge for a menu item.
function item:CustomRightBadge(txd, txn)

CustomLeftBadge

Sets a custom left badge for a menu item, typically used for visual indicators such as icons.

public void SetCustomLeftBadge(txd, txn)
item.SetCustomLeftBadge("txd", "txn");

--- Sets a custom left badge for a menu item.
function item:CustomLeftBadge(txd, txn)

AddPanel

Adds a panel to a menu item.

public void AddPanel(UIMenuPanel panel)
item.AddPanel(panel)

--- Adds a panel to a menu item.
function item:AddPanel(Panel)

AddSidePanel

Adds a side panel to a menu item, used for additional details or options.

public void AddSidePanel(sidePanel)
item.AddSidePanel(sidePanel)

--- Adds a side panel to a menu item.
function item:AddSidePanel(sidePanel)

RemoveSidePanel

Removes the side panel from a menu item.

public void RemoveSidePanel()
item.RemoveSidePanel();

--- Removes the side panel from a menu item.
function item:RemoveSidePanel()

RemovePanelAt

Removes a panel from a menu item by index.

void RemovePanelAt(Index)
item.RemovePanelAt(index);

--- Removes a panel from a menu item by index.
function item:RemovePanelAt(Index)

Events

ItemActivatedEvent

Triggered everytime a player select the item after highlighting it

public event ItemActivatedEvent Activated

Activated = function(menu, item)
end

ItemHighlightedEvent

Triggered everytime a player highlightings an item

public event ItemHighlightedEvent Highlighted

Highlighted = function(menu, item)
end