OSRS Plugin API
    Preparing search index...

    Class InputText

    A UI element with a user-enterable text field. Sizing is only enabled when multiline mode is turned on.

    Implements

    Index

    Constructors

    constructor

    Properties

    height heightRatio label? maxSize multiline onEnter onValueChange? positionMode sameLine sizeMode style tooltip value visible width widthRatio x xRatio y yRatio

    Methods

    addChild addPopUpElement child childCount insertChild removeChild removeChildAt removePopUpElement

    Constructors

    Properties

    height: number

    The height of this element, in UI coordinate space.

    -- Create a window that has a set height
    local window = osrs.Ui.window({title = "Example Window", sizeMode = 1, height = 200})

    -- Add window to the canvas 
    osrs.Ui.canvas:addChild(window)
    heightRatio: number

    The percentage height of the screen this element should take up when sizeMode is set to LayoutMode.PROPORTIONAL. The number needs to be a decimal.

    -- Create new container with a set widthRatio and heightRatio
    local newWindow = osrs.Ui.window({title = "Example Window", sizeMode = 2, widthRatio = 0.7, heightRatio = .2})

    -- Add container to the canvas 
    osrs.Ui.canvas:addChild(newWindow)
    label?: string

    The string label to display alongside the input textbox.

    -- Create new container
    local newWindow = osrs.Ui.window({title = "Example Window"})

    -- Create an Input Text UI element with the label "Test"
    local exampleInput = osrs.Ui.inputText({label = "Test"})

    -- Add a Input Text UI element to the container 
    newWindow:addChild(exampleInput)

    -- Add container to the canvas
    osrs.Ui.canvas:addChild(newWindow)
    maxSize: number

    The max size of the input to the textbox.

    80

    -- Create new container
    local newWindow = osrs.Ui.window({title = "Example Window"})

    -- Create an Input Text UI element with the max size of 2
    local exampleInput = osrs.Ui.inputText({maxSize = 2})

    -- Add a Input Text UI element to the container 
    newWindow:addChild(exampleInput)

    -- Add container to the canvas, see how the max size is now only 2
    osrs.Ui.canvas:addChild(newWindow)
    multiline: boolean

    Flag to indicate if the input text should support multiple lines and enables Sizing. To swap to a new line in the input text you need to hit Ctrl Enter

    -- Create new container
    local newWindow = osrs.Ui.window({title = "Example Window"})

    -- Create an Input Text UI element with multiline set to true
    local exampleInput = osrs.Ui.inputText({multiline = true})

    -- Add a Input Text UI element to the container 
    newWindow:addChild(exampleInput)

    -- Add container to the canvas
    osrs.Ui.canvas:addChild(newWindow)
    onEnter: InputTextCallback

    The callback that is called when the user presses the enter button in an input textbox.

    -- Create new container
    local newWindow = osrs.Ui.window({title = "Example Window"})

    -- Create an Input Text UI element with an onEnter function
    local exampleInput = osrs.Ui.inputText(
        {
            onEnter = function()
                osrs.print("Hit Enter!")
            end
        }
    )

    -- Add a Input Text UI element to the container 
    newWindow:addChild(exampleInput)

    -- Add container to the canvas
    osrs.Ui.canvas:addChild(newWindow)
    onValueChange?: any

    The function callback invoked when the element's value is changed.

    -- Create new container
    local newWindow = osrs.Ui.window({title = "Example Window"})

    -- Create a new dropdown menu with a change function
    local menu = osrs.Ui.dropdown(
        {
            label = "Test",
            values = {"Test1", "Test2", "Test3"},
            onValueChange = function()
                osrs.print("Change")
            end
        }
    )

    -- Add dropdown to the container
    newWindow:addChild(menu)

    -- Add container to the canvas 
    osrs.Ui.canvas:addChild(newWindow)
    positionMode: LayoutMode

    How this element should position itself.

    LayoutMode.AUTOMATIC

    -- 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)
    sameLine: boolean

    Flag to control whether this element should be placed on the same line as the previous element.

    false

    -- 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)
    sizeMode: LayoutMode

    How this element should size itself.

    LayoutMode::AUTOMATIC

    -- Create a window that has automatic size mode, this is default
    local window1 = osrs.Ui.window({title = "Automatic Size Mode"})

    -- Create a window that has manual size mode 
    local window2 = osrs.Ui.window(
        {
            title = "Manual Size Mode", 
            sizeMode = osrs.Ui.LayoutMode.MANUAL, 
            height = 200, 
            width = 200
        }
    )

    -- Add the windows to the canvas 
    osrs.Ui.canvas:addChild(window1)
    osrs.Ui.canvas:addChild(window2)
    style: StyleTable

    The style, if any, that should be applied to this element.

    tooltip: string

    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)
    value: string

    The current text entered into the input textbox. Is writable, and may be modified by script.

    -- Create new container
    local newWindow = osrs.Ui.window({title = "Example Window"})

    -- Create an Input Text UI element with a set value of "hello!"
    local exampleInput = osrs.Ui.inputText({value = "hello!"})

    -- Add a Input Text UI element to the container 
    newWindow:addChild(exampleInput)

    -- Add container to the canvas
    osrs.Ui.canvas:addChild(newWindow)
    visible: boolean

    Boolean indicating whether this UI element should draw itself.

    true

    -- 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)
    width: number

    The width of this element, in UI coordinate space.

    -- Create a window that has a set width
    local window = osrs.Ui.window({title = "Example Window", sizeMode = 1, width = 200})

    -- Add window to the canvas 
    osrs.Ui.canvas:addChild(window)
    widthRatio: number

    The percentage width of the screen this element should take up when sizeMode is set to LayoutMode.PROPORTIONAL. The number needs to be a decimal.

    -- Create new container with a set widthRatio and heightRatio
    local newWindow = osrs.Ui.window({title = "Example Window", sizeMode = 2, widthRatio = 0.7, heightRatio = .2})

    -- Add container to the canvas 
    osrs.Ui.canvas:addChild(newWindow)
    x: number

    The horizontal component of this element's position, in UI coordinate space.

    -- Create a window with a set x position
    local window = osrs.Ui.window({title = "Example Window", positionMode = 1, x = 100})

    -- Add window to the canvas
    osrs.Ui.canvas:addChild(window)
    xRatio: number

    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.

    -- Create new container with a set xRatio and yRatio
    local newWindow = osrs.Ui.window({title = "Example Window", positionMode = 2, xRatio = 0.7, yRatio = .2})

    -- Add container to the canvas 
    osrs.Ui.canvas:addChild(newWindow)
    y: number

    The vertical component of this element's position, in UI coordinate space.

    -- Create a window with a set y position
    local window = osrs.Ui.window({title = "Example Window", positionMode = 1, y = 100})

    -- Add window to the canvas
    osrs.Ui.canvas:addChild(window)
    yRatio: number

    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.

    -- Create new container with a set xRatio and yRatio
    local newWindow = osrs.Ui.window({title = "Example Window", positionMode = 2, xRatio = 0.7, yRatio = .2})

    -- Add container to the canvas 
    osrs.Ui.canvas:addChild(newWindow)

    Methods

    • Adds a UI element to the pop up container.

      Parameters

      • element: UiPrimitive

        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 any

    • Returns number

    • Parameters

      Returns void

    • Parameters

      Returns boolean

    • Parameters

      • index: number

      Returns boolean

    • Removes a UI element from the pop up container.

      Parameters

      • element: UiPrimitive

        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)

      Returns any

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods