OSRS Plugin API
    Preparing search index...

    Namespace Ui

    This section is for UI, or User Interface, functions. These commands will let you create GUIs, or graphic user interfaces. In other words, with these functions you will be able to draw graphics, such as clickable buttons or text prompts, onto the Old School RuneScape client window.

    So let's go over how you can draw graphics onto the screen. To begin, let's imagine there is an invisible sheet of paper on top of your client that you are drawing on. This is your canvas. In order for anything you want to draw to show up you need to add it to the canvas.

    On your canvas you can create sections for your graphics, or drawings, to be inside of. You can imagine this as drawing a big square on your piece of paper where you want all of your other drawings to go into. These sections are called containers, with the most important one being a window, like a popup window.

    Inside your containers, you can put various elements like buttons you can click, boxs you can check, images from outside files you want to see, and lots of other options. Each of these elements have their own set of properties, such as width and height, that you can customize to make them completely unique and personalized.

    With UI functions you will be able to create visual representations of your plugin’s features and customize their design any way you want.

    Enumerations

    LayoutMode

    Classes

    Checkbox
    CollapsingHeader
    Colour
    ColourPicker
    Dummy
    Grid
    Image
    ImageButton
    InputText
    Pane
    RadioButtonGroup
    SliderInt
    TabBox
    TextBox
    TextButton
    VSliderInt
    Window

    Interfaces

    AutoPositioned
    AutoSized
    Button
    Container
    Interactable
    Positioned
    ProportionPositioned
    ProportionSized
    Rect
    Renderable
    Selectable
    Sized
    Styled
    Tooltip
    UiPrimitive
    ValueListener
    WindowHolder

    Type Aliases

    ButtonCallback
    CheckboxCallback
    checkboxConstructorTable
    collapsingHeaderConstructorTable
    colourPickerConstructorTable
    dummyConstructorTable
    gridConstructorTable
    imageButtonConstructorTable
    inputTextConstructorTable
    paneConstructorTable
    RadioButtonGroupCallback
    radioButtonGroupConstructorTable
    selectableConstructorTable
    sliderIntConstructorTable
    StyleTable
    tabBoxConstructorTable
    textBoxConstructorTable
    textButtonConstructorTable
    vSliderIntConstructorTable
    windowConstructorTable

    Variables

    canvas

    Functions

    checkbox
    collapsingHeader
    colourPicker
    dummy
    grid
    imageButton
    inputText
    pane
    radioButtonGroup
    selectable
    sliderInt
    tabBox
    textBox
    textButton
    toggleLeftPanel
    vSliderInt
    window