Menu
vorp menu is a library that allows you to create menus in game with a rdr2 style.
GetMenuData
GetMenuData
GetMenuData
CloseAll
CloseAll
CloseAll
Close all menus
Menu Elements
Menu elements are the elements that will be displayed in the menu
Menu Elements
Menu Elements
Menu Elements
Menu Elements
Slider Number
Slider Number
allows to use a slider type of element to select a number , can be floats or integers this is defined by the hop value
The value of the tab element
The label of the tab element
The description of the tab element
The type of the tab element must be slider
The minimum value , if not defined will default to 0
The maximum value , if not defined will default to 100
The hop value , can hop by 1 2 etc, to use floats set the hop to 0.1 etc.
Slider Text
Slider Text
allows to use a slider type of element to select a string , from a list of strings
The value of the tab element
The label of the tab element
The description of the tab element
The type of the tab element must be text-slider
The list of strings to select from
data.current.textIndex
will return the index of the selected string
Linear Label Slider
Linear Label Slider
allows to use a slider type in the label of the element to select a number , can be floats or integers this is defined by the hop value
works with press key or drag when cursorEnabled
is true
The value
The label
The description
The type must be label-slider
The minimum value , if not defined will default to 0
The maximum value , if not defined will default to 100
The hop value , can hop by 1 2 etc, to use floats set the hop to 0.1 etc.
The attributes of the slider , can be used to style the slider
trackColor
is the color of the track accepts names or hex codes rgba
fillColor
is the color of the fill, only accepts linear-gradient you can choose one color or multiple colors and the direction
thumbColor
is the color of the thumb accepts names or hex codes rgba
Linear Desc Slider
Linear Desc Slider
allows to create multiple sliders in the description of the element, can use integers or floats
The value of the tab element
The label of the tab element
The description of the tab element
The type of the tab element must be desc-slider
The minimum value , if not defined will default to 0
The maximum value , if not defined will default to 100
The hop value , can hop by 1 2 etc, to use floats set the hop to 0.1 etc.
The list of sliders
data.current.sliderIndex
will return the index of the selected slider
Label Tick Box
Label Tick Box
Desc Tick Box
Desc Tick Box
allows to create multiple tick boxes in the description of the element
The value of the tab element
The label of the tab element
The description of the tab element
The type of the element must be tick-box
The list of tick boxes
data.current.tickboxIndex
will return the index of the tick box we ticked or unticked
Desc Price
Desc Price
allows to create a price in the description of the element like RDO
The value of the tab element
The label of the tab element
The description of the tab element
The price of the tab element
amount
is the amount of the priceicon
isgold
ormoney
onlytext
the label
Menu Params
Menu Params
Functions
update elements ,add ,remove ,get elements runtime
getElementBy[Value/Index]
getElementBy[Value/Index]
find an element by value or index
data.current.value
is available to use in the menu elementsdata.current.index
is available to use in the menu elements
setElement
setElement
this function will update a specific element variable
The index of the menu element to update
data.current.index
is available to use in the menu elements
The variable of the menu element to update , label,value,desc, any
The new value of the menu element to update
refresh menu to show changes
removeElementBy[Value/Index]
removeElementBy[Value/Index]
this function will remove a specific element by value or index
The value of the element to remove
data.current.value
is available to use in the menu elements
The index of the element to update
data.current.index
is available to use in the menu elements
stop looking at the first element found can be used when you loop through several elements and remove all indexes
refresh menu to show changes
CloseMenu
CloseMenu
setTitle
setTitle
this function will set the title of the current menu
The title of the menu
refresh menu to show changes
Inputs
Inputs
creates an input box to collect text or numbers etc.
The type of input, text
, number
, password
, date
yesno
is a special type of input that will just create a yes or no button, no input needed
The header of the input
The placeholder of the input
The buttons of the input
The max length of the input
The pattern of the input
letters
all Unicode letters and spacesnumbers
numbers onlyalphanumeric
all Unicode letters and numbersno-symbols
letters, numbers, spaces (all languages)username
username with international lettersphone
phone numbers with + for country codesemail
email with international lettersmoney
money format (supports both . and , decimals)no-special
no special symbols but allow apostrophes and hyphens
Menu Example
Menu Example
Menu Example