Parameters

This section will show you UIMenu public parameters and the use you can do with them. Examples are shown in C# and in Lua.

Title

The title of the menu is shown onto the banner texture. You can set it in constructor and get/set it using:

string Title {get;set;}
menu.Title

---Getter / Setter for the menu title.
---@param title string
---@return string | nil
menu:Title(title) -- if empty it returns the current title.

Subtitle

The Subtitle is shown right after the banner and is always sided by the item count. You can set it in constructor and get/set it using:

string Subtitle {get;set;} 
menu.Subtitle

---Getter / Setter for the subtitle.
---@param sub string
---@return string | nil
menu:Subtitle(subtitle)

Description Font

Getter / Setter for the description font.

ItemFont DescriptionFont { get; set; } 
menu.DescriptionFont

---Getter / Setter for the description font.
---@param fontTable ItemFont
---@return ItemFont
menu:DescriptionFont(fontTable)

Counter Color

Getter / Setter for the counter color.

SColor CounterColor { get; set; } 
menu.CounterColor

---Getter / Setter for the counter color.
---@param color SColor
---@return any
menu:CounterColor(color)

Subtitle Color

Getter / Setter for the subtitle color.

HudColour SubtitleColor { get; set; } 
menu.SubtitleColor

---Getter / Setter for the subtitle color.
---@param color HudColours
---@return any
menu:SubtitleColor(color)

Menu Alignment

Getter / Setter for the menu alignment.

MenuAlignment MenuAlignment { get; set; } 
menu.MenuAlignment

---Getter / Setter for the Menu Alignment.
---@param align MenuAlignment
---@return MenuAlignment | nil
menu:MenuAlignment(align)

Disable Game Controls

Enable/disable non-menu game controls.

bool DisableGameControls { get; set; } 
menu.DisableGameControls

---Enable/disable non-menu game controls.
---@param bool? boolean
---@return boolean | nil
menu:DisableGameControls(bool)

Instructional Buttons

Enable/disable instructional buttons.

bool HasInstructionalButtons { get; set; } 
menu.HasInstructionalButtons

---Enable/disable instructional buttons.
---@param enabled boolean|nil
---@return boolean
menu:HasInstructionalButtons(enabled)

Can Player Close Menu

Sets if the menu can be closed by the player.

bool CanPlayerCloseMenu { get; set; } 
menu.CanPlayerCloseMenu

---Sets if the menu can be closed by the player.
---@param playerCanCloseMenu boolean|nil
---@return boolean
menu:CanPlayerCloseMenu(playerCanCloseMenu)

Mouse Edge Enabled

Sets if the camera can be rotated when the mouse cursor is near the edges of the screen.

bool MouseEdgeEnabled { get; set; } 
menu.MouseEdgeEnabled

---Sets if the camera can be rotated when the mouse cursor is near the edges of the screen.
---@param enabled boolean|nil
---@return boolean
menu:MouseEdgeEnabled(enabled)

Mouse Controls Enabled

Enables or disables mouse controls for the menu.

bool MouseControlsEnabled { get; set; } 
menu.MouseControlsEnabled

---Enables or disables mouse controls for the menu.
---@param enabled boolean|nil
---@return boolean
menu:MouseControlsEnabled(enabled)

Animation Enabled

Enable or disable scrolling animation.

bool AnimationEnabled { get; set; } 
menu.AnimationEnabled

---Enable or disable scrolling animation.
---@param enable boolean|nil
---@return boolean
menu:AnimationEnabled(enable)

3D Animations Enabled

Enable or disable 3D animations.

bool Enabled3DAnimations { get; set; } 
menu.Enabled3DAnimations

---Enable or disable 3D animations.
---@param enable boolean|nil
---@return boolean
menu:Enabled3DAnimations(enable)

Animation Type

Sets the menu’s scrolling animation type while the menu is visible.

MenuAnimationType AnimationType { get; set; } 
menu.AnimationType

---Sets the menu's scrolling animation type while the menu is visible.
---@param menuAnimationType MenuAnimationType|nil
---@return number MenuAnimationType
---@see MenuAnimationType
menu:AnimationType(menuAnimationType)

Building Animation

Enables or disables the menu’s building animation type.

MenuBuildingAnimation BuildingAnimation { get; set; } 
menu.BuildingAnimation

---Enables or disables the menu's building animation type.
---@param buildingAnimationType MenuBuildingAnimation|nil
---@return MenuBuildingAnimation
---@see MenuBuildingAnimation
menu:BuildingAnimation(buildingAnimationType)

Scrolling Type

Decides how the menu behaves on scrolling and overflowing.

MenuScrollingType ScrollingType { get; set; } 
menu.ScrollingType

---Decides how the menu behaves on scrolling and overflowing.
---@param scrollType MenuScrollingType|nil
---@return MenuScrollingType
---@see MenuScrollingType
menu:ScrollingType(scrollType)

Current Selection

Gets or sets the currently selected item index in the menu.

int CurrentSelection { get; set; } 
menu.CurrentSelection

---Gets or sets the currently selected item index in the menu.
---@param value number|nil
---@return number
menu:CurrentSelection(value)

Max Items On Screen

Gets or sets the maximum number of items visible on the screen.

int MaxItemsOnScreen { get; set; } 
menu.MaxItemsOnScreen

---Gets or sets the maximum number of items visible on the screen.
---@param max number|nil
---@return number
menu:MaxItemsOnScreen(max)

Visible

This is maybe the most important parameter of the menu. Gets or sets the visibility state of the menu drawing it or stopping the draw.

bool Visible { get; set; } 
menu.Visible

---Gets or sets the visibility state of the menu.
---@param bool boolean|nil
---@return boolean
menu:Visible(bool)

Is Mouse Over The Menu

Checks if the mouse is currently over the menu.

bool IsMouseOverTheMenu() 
menu.IsMouseOverTheMenu()

---Checks if the mouse is currently over the menu.
---@return boolean
menu:IsMouseOverTheMenu()