Skip to main content

Button

A Generic FBase Button class. Can be called as a function to create a new button. This class uses a custom method for detecting mouse hovering and clicking. As a result it will not work when the Gui is within a PluginGui. 

local Button = require(FusionOnRails.Classes.Buttons.Button)

local myButton = Button {
	ClassName = "TextButton",

	Properties = {
		BackgroundColor3 = Color3.fromRGB(255, 255, 255),
		Text = "Click Me!",
	},
}

Properties​

Activated​

</>
Button.Activated: Signal

Held​

</>
Button.Held: Value<boolean>

Hovering​

</>
Button.Hovering: Value<boolean>

Disabled​

</>
Button.Disabled: Value<boolean>

ClassName​

Static
</>
Button.ClassName: "Button"

The ClassName of the Button.

Functions​

new​

Static
</>
Button.new(props: {
ClassName: string?,
Held: Value<boolean>?,
Hovering: Value<boolean>?,
Disabled: CanBeState<boolean>?,
CornerRadius: CanBeState<UDim>?,
GamepadKeyCode: CanBeState<Enum.KeyCode>?,
ActivatedSoundId: CanBeState<string>?,
ActivatedSoundVolume: CanBeState<number>?,
Activated: CanBeState<Fn?>?,
Children: PubTypes.Children?,
--[Fusion.Children]: PubTypes.Children?,
--alsosupportsFusion.ChildrenProperties: {[any]: any}?,
[any]: any?,
}) → Button

Creates a new FBase Button.

Textbutton specific properties need to be set in a given Properties table.

Activate​

</>
Button:Activate(...: any) → ()

Simulates a MouseClick on the button

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Creates a new FBase Button.\n\nTextbutton specific properties need to be set in a given `Properties` table.",
            "params": [
                {
                    "name": "props",
                    "desc": "",
                    "lua_type": "{\n\tClassName: string?,\n\tHeld: Value<boolean>?,\n\tHovering: Value<boolean>?,\n\tDisabled: CanBeState<boolean>?,\n\tCornerRadius: CanBeState<UDim>?,\n\n\tGamepadKeyCode: CanBeState<Enum.KeyCode>?,\n\tActivatedSoundId: CanBeState<string>?,\n\tActivatedSoundVolume: CanBeState<number>?,\n\n\tActivated: CanBeState<Fn?>?,\n\n\tChildren: PubTypes.Children?,\n\t-- [Fusion.Children]: PubTypes.Children?, -- also supports Fusion.Children\n\n\tProperties: {[any]: any}?,\n\t[any]: any?,\n}"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Button\n"
                }
            ],
            "function_type": "static",
            "tags": [
                "Static"
            ],
            "source": {
                "line": 225,
                "path": "src/fusiononrails/src/FusionOnRails/Classes/Button.lua"
            }
        },
        {
            "name": "Activate",
            "desc": "Simulates a MouseClick on the button",
            "params": [
                {
                    "name": "...",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 371,
                "path": "src/fusiononrails/src/FusionOnRails/Classes/Button.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "Activated",
            "desc": "",
            "lua_type": "Signal",
            "source": {
                "line": 194,
                "path": "src/fusiononrails/src/FusionOnRails/Classes/Button.lua"
            }
        },
        {
            "name": "Held",
            "desc": "",
            "lua_type": "Value<boolean>",
            "source": {
                "line": 199,
                "path": "src/fusiononrails/src/FusionOnRails/Classes/Button.lua"
            }
        },
        {
            "name": "Hovering",
            "desc": "",
            "lua_type": "Value<boolean>",
            "source": {
                "line": 204,
                "path": "src/fusiononrails/src/FusionOnRails/Classes/Button.lua"
            }
        },
        {
            "name": "Disabled",
            "desc": "",
            "lua_type": "Value<boolean>",
            "source": {
                "line": 209,
                "path": "src/fusiononrails/src/FusionOnRails/Classes/Button.lua"
            }
        },
        {
            "name": "ClassName",
            "desc": "The ClassName of the Button.",
            "lua_type": "\"Button\"",
            "tags": [
                "Static"
            ],
            "source": {
                "line": 216,
                "path": "src/fusiononrails/src/FusionOnRails/Classes/Button.lua"
            }
        }
    ],
    "types": [],
    "name": "Button",
    "desc": "A Generic FBase Button class. Can be called as a function to create a new button.\nThis class uses a custom method for detecting mouse hovering and clicking. As a result\nit will *not* work when the Gui is within a PluginGui.\n\n```lua\nlocal Button = require(FusionOnRails.Classes.Buttons.Button)\n\nlocal myButton = Button {\n\tClassName = \"TextButton\",\n\n\tProperties = {\n\t\tBackgroundColor3 = Color3.fromRGB(255, 255, 255),\n\t\tText = \"Click Me!\",\n\t},\n}\n```",
    "source": {
        "line": 24,
        "path": "src/fusiononrails/src/FusionOnRails/Classes/Button.lua"
    }
}