OptionalonThe function callback invoked when the radio button value is changed.
How this element should position itself.
-- Create a window that has automatic position mode, this is default
local window1 = osrs.Ui.window({title = "Automatic Position Mode"})
-- Create a window that has manual position mode
local window2 = osrs.Ui.window(
{
title = "Manual Position Mode",
positionMode = osrs.Ui.LayoutMode.MANUAL
}
)
-- Add the windows to the canvas
osrs.Ui.canvas:addChild(window1)
osrs.Ui.canvas:addChild(window2)
Flag to control whether this element should be placed on the same line as the previous element.
-- Create a container
local window = osrs.Ui.window({title = "Example Window"})
-- Create three buttons, with two of them on the same line
local button1 = osrs.Ui.textButton({text = "Button 1"})
local button2 = osrs.Ui.textButton({text = "Button 2"})
local button3 = osrs.Ui.textButton({text = "Button 3", sameLine = true})
-- Add buttons to the container
window:addChild(button1)
window:addChild(button2)
window:addChild(button3)
-- Add container to the canvas
osrs.Ui.canvas:addChild(window)
The style, if any, that should be applied to this element.
String to display to the user when hovered over the element.
-- Create new container
local newWindow = osrs.Ui.window({title = "Example Window"})
-- Create a button with a tooltip
local button = osrs.Ui.textButton({text = "Test", tooltip = "This is a Tooltip!"})
-- Add slider to the container
newWindow:addChild(button)
-- Add container to the canvas
osrs.Ui.canvas:addChild(newWindow)
Boolean indicating whether this UI element should draw itself.
-- Create new container
local newWindow = osrs.Ui.window({title = "Example Window"})
-- Create a button that is renderable, and one that is not
local button1 = osrs.Ui.textButton(
{
text = "Peek-a-Boo",
visible = false,
onClick = function()
osrs.print("BOO!")
end
}
)
local button2 = osrs.Ui.textButton(
{
text = "Render",
onClick = function()
button1.visible = not button1.visible
end
}
)
-- Add buttons to the container
newWindow:addChild(button1)
newWindow:addChild(button2)
-- Add container to the canvas
osrs.Ui.canvas:addChild(newWindow)
The horizontal component of this element's position, in UI coordinate space.
The percentage distance from the left side of the screen that this element's top-left corner should be placed at when positionMode is set to LayoutMode.PROPORTIONAL. The number needs to be a decimal.
The vertical component of this element's position, in UI coordinate space.
The percentage distance from the top side of the screen that this element's top-left corner should be placed at when positionMode is set to LayoutMode.PROPORTIONAL. The number needs to be a decimal.
Adds a button to the group. Optionally, include the text to display next to the button.
The string to display for the newly created button.
-- Create a container
local window = osrs.Ui.window({title = "Example Window"})
-- Create new radio button group
local radioButtons = osrs.Ui.radioButtonGroup()
-- Add a button to the radio group
radioButtons:addButton("Button 1")
-- Add the radio button to the container
window:addChild(radioButtons)
-- Add the container to the canvas
osrs.Ui.canvas:addChild(window)
Adds a UI element to the pop up container.
Imgui element to add to the pop up menu
local button = osrs.Ui.textButton( { text="Clear", tooltip="Test" })
local selectable = osrs.Ui.selectable({text = "Example", onClick = function() osrs.print("Example Print") end}) clear:addPopUpElement(test) osrs.Ui.leftPanel:addChild(button)
Returns the number of buttons stored in this group.
The number of buttons in the radio button group.
Renames the button identified by the provided index. Logs an error if the indexed button does not exist.
The index of the button to label.
The string to label the specified button with.
-- Create a container
local window = osrs.Ui.window({title = "Example Window"})
-- Create new radio button group
local radioButtons = osrs.Ui.radioButtonGroup()
-- Add a button to the radio group
radioButtons:addButton()
-- Names the button in the radio group.
radioButtons:nameButton(1, "Button 1");
-- Add the radio button to the container
window:addChild(radioButtons)
-- Add the container to the canvas
osrs.Ui.canvas:addChild(window)
Removes the button at the provided index from the group. Logs an error if the indexed button does not exist. Moves all buttons down by one.
The index of the button to remove from the radio button group.
-- Create a container
local window = osrs.Ui.window({title = "Example Window"})
-- Create new radio button group
local radioButtons = osrs.Ui.radioButtonGroup()
-- Add buttons to the radio group
radioButtons:addButton("Button 1")
radioButtons:addButton("Button 2")
-- Removes the first button from the radio group.
radioButtons:removeButton(1)
-- Add the radio button to the container
window:addChild(radioButtons)
-- Add the container to the canvas
osrs.Ui.canvas:addChild(window)
Removes a UI element from the pop up container.
Imgui element to remove from the pop up menu.
local button = osrs.Ui.textButton( { text="Clear", tooltip="Test" })
local selectable = osrs.Ui.selectable({text = "Example", onClick = function() osrs.print("Example Print") end}) clear:addPopUpElement(test) clear:removePopUpElement(test) osrs.Ui.leftPanel:addChild(button)
A one-hot group of UI inputs that allow for user-selection from many options.