Skip to main content

FoR_Classes

A table of all 'instance' classes in FusionOnRails. Such as Windows, Sliders, etc.

Properties​

GenericTextButton​

</>
FoR_Classes.GenericTextButton: table

GenericPadding​

</>
FoR_Classes.GenericPadding: function

GenericTextLabel​

</>
FoR_Classes.GenericTextLabel: function

RadialBar​

</>
FoR_Classes.RadialBar: function

A reusable radial bar component.

RadialBar

ConfirmationPrompt​

</>
FoR_Classes.ConfirmationPrompt: function

ConfirmationPrompt

GenericImageButton​

</>
FoR_Classes.GenericImageButton: table

ToggleButton​

</>
FoR_Classes.ToggleButton: function

ToggleButton

Checkbox​

</>
FoR_Classes.Checkbox: function

ExitButton​

</>
FoR_Classes.ExitButton: function

CharPreviewFrame​

</>
FoR_Classes.CharPreviewFrame: function

Creates a display viewport for a character model. Allows for previewing items on the character, playing emotes, and rotating the character.

*Known Bug: Character sometimes clips slightly into the ground

TextInputBox​

</>
FoR_Classes.TextInputBox: table

TextInputBox

YYSplitFrame​

</>
FoR_Classes.YYSplitFrame: function

SplitFrame2​

</>
FoR_Classes.SplitFrame2: function

Handles splitting a frame into sections based on a set of split points. The split points are defined as a set of UDim values that represent the rough lines upon which sections are split. If padding is applied it will shift the split points slightly in order to properly apply padding between sections.

SplitPoint Order

The order in which split points are defined currently does not influence the order of the sections. As they are sorted by their resulting Scales. This can result in odd behavior if you mix Offsets and Scales in your SplitPoints. This behavior may change in the future.

Out of bounds SplitPoints

Currently, splitpoints that result in a scale beyond bounds of the SplitFrame results in undefined behavior and should not be relied upon. You can help control this behavior by setting the BoundsMin and BoundsMax props.

SplitFrame1​

</>
FoR_Classes.SplitFrame1: function

Slider​

</>
FoR_Classes.Slider: table

Slider

Show raw api
{
    "functions": [],
    "properties": [
        {
            "name": "GenericTextButton",
            "desc": "",
            "lua_type": "table",
            "source": {
                "line": 8,
                "path": "src/fusiononrails/src/FusionOnRails/Classes/GenericUIComponents/GenericTextButton.lua"
            }
        },
        {
            "name": "GenericPadding",
            "desc": "",
            "lua_type": "function",
            "source": {
                "line": 7,
                "path": "src/fusiononrails/src/FusionOnRails/Classes/GenericUIComponents/GenericPadding.lua"
            }
        },
        {
            "name": "GenericTextLabel",
            "desc": "",
            "lua_type": "function",
            "source": {
                "line": 7,
                "path": "src/fusiononrails/src/FusionOnRails/Classes/GenericUIComponents/GenericTextLabel.lua"
            }
        },
        {
            "name": "RadialBar",
            "desc": "A reusable radial bar component.\n\n![RadialBar](https://gyazo.com/e010011d750466a8846671a23ae3554b.gif)",
            "lua_type": "function",
            "source": {
                "line": 11,
                "path": "src/fusiononrails/src/FusionOnRails/Classes/GenericUIComponents/RadialBar.lua"
            }
        },
        {
            "name": "ConfirmationPrompt",
            "desc": "![ConfirmationPrompt](https://gyazo.com/83ae159a00de02b4ed1361cb3bbc43c4.gif)",
            "lua_type": "function",
            "source": {
                "line": 9,
                "path": "src/fusiononrails/src/FusionOnRails/Classes/GenericUIComponents/ConfirmationPrompt.lua"
            }
        },
        {
            "name": "GenericImageButton",
            "desc": "",
            "lua_type": "table",
            "source": {
                "line": 8,
                "path": "src/fusiononrails/src/FusionOnRails/Classes/GenericUIComponents/GenericImageButton.lua"
            }
        },
        {
            "name": "ToggleButton",
            "desc": "![ToggleButton](https://gyazo.com/172d32fe82f7741be2dcae50e06d5331.gif)",
            "lua_type": "function",
            "source": {
                "line": 9,
                "path": "src/fusiononrails/src/FusionOnRails/Classes/GenericUIComponents/ToggleButton.lua"
            }
        },
        {
            "name": "Checkbox",
            "desc": "",
            "lua_type": "function",
            "source": {
                "line": 7,
                "path": "src/fusiononrails/src/FusionOnRails/Classes/GenericUIComponents/Checkbox.lua"
            }
        },
        {
            "name": "ExitButton",
            "desc": "",
            "lua_type": "function",
            "source": {
                "line": 8,
                "path": "src/fusiononrails/src/FusionOnRails/Classes/GenericUIComponents/Window/ExitButton.lua"
            }
        },
        {
            "name": "CharPreviewFrame",
            "desc": "Creates a display viewport for a character model.\nAllows for previewing items on the character, playing emotes, and rotating the character.\n\n*Known Bug: Character sometimes clips slightly into the ground",
            "lua_type": "function",
            "source": {
                "line": 13,
                "path": "src/fusiononrails/src/FusionOnRails/Classes/GenericUIComponents/CharPreviewFrame.lua"
            }
        },
        {
            "name": "TextInputBox",
            "desc": "![TextInputBox](https://gyazo.com/7919963400b5d056b66362da10abe549.gif)",
            "lua_type": "table",
            "source": {
                "line": 9,
                "path": "src/fusiononrails/src/FusionOnRails/Classes/GenericUIComponents/TextInputBox.lua"
            }
        },
        {
            "name": "YYSplitFrame",
            "desc": "",
            "lua_type": "function",
            "source": {
                "line": 7,
                "path": "src/fusiononrails/src/FusionOnRails/Classes/GenericUIComponents/SplitFrames/YYSplitFrame.lua"
            }
        },
        {
            "name": "SplitFrame2",
            "desc": "Handles splitting a frame into sections based on a set of split points.\nThe split points are defined as a set of UDim values that represent the rough lines upon which sections are split.\nIf padding is applied it will shift the split points slightly in order to properly apply padding between sections.\n\n:::caution SplitPoint Order\nThe order in which split points are defined currently does not\ninfluence the order of the sections. As they are sorted by their resulting Scales.\nThis can result in odd behavior if you mix Offsets and Scales in your SplitPoints.\nThis behavior may change in the future.\n:::\n\n:::caution Out of bounds SplitPoints\nCurrently, splitpoints that result in a scale beyond bounds of the SplitFrame\nresults in undefined behavior and should not be relied upon. You can help control this\nbehavior by setting the BoundsMin and BoundsMax props.\n:::",
            "lua_type": "function",
            "source": {
                "line": 24,
                "path": "src/fusiononrails/src/FusionOnRails/Classes/GenericUIComponents/SplitFrames/SplitFrame2.lua"
            }
        },
        {
            "name": "SplitFrame1",
            "desc": "",
            "lua_type": "function",
            "source": {
                "line": 7,
                "path": "src/fusiononrails/src/FusionOnRails/Classes/GenericUIComponents/SplitFrames/SplitFrame1.lua"
            }
        },
        {
            "name": "SplitFrame",
            "desc": "A container file that redirects to the proper splitframe file based on the given props.",
            "lua_type": "function",
            "ignore": true,
            "source": {
                "line": 10,
                "path": "src/fusiononrails/src/FusionOnRails/Classes/GenericUIComponents/SplitFrames/SplitFrame.lua"
            }
        },
        {
            "name": "Slider",
            "desc": "![Slider](https://gyazo.com/931d8af584e290a5001c1871ccb2f1cd.gif)",
            "lua_type": "table",
            "source": {
                "line": 9,
                "path": "src/fusiononrails/src/FusionOnRails/Classes/GenericUIComponents/Slider.lua"
            }
        }
    ],
    "types": [],
    "name": "FoR_Classes",
    "desc": "A table of all 'instance' classes in FusionOnRails. Such as Windows, Sliders, etc.",
    "source": {
        "line": 78,
        "path": "src/fusiononrails/src/FusionOnRails/init.lua"
    }
}