Skip to main content

Window

This Component is a generic window that can be used for any purpose.

Set the Content prop to the content you want to display in the window.

Window Example Image

Functions​

PressExit​

</>
Window:PressExit() → Promise

Simulates a click on the Exit Button which causes the window to close. Different from close as if a function is set to ExitPressed and the function returns true then it will prevent the closing. Rejects the promise if the window is not closed.

Close​

</>
Window:Close() → Promise

Closes the window and destroys it.

Show raw api
{
    "functions": [
        {
            "name": "PressExit",
            "desc": "Simulates a click on the Exit Button which causes the window to close.\nDifferent from close as if a function is set to `ExitPressed` and the function\nreturns true then it will prevent the closing. Rejects the promise if the window\nis not closed.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise\n"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 444,
                "path": "src/fusiononrails/src/FusionOnRails/Classes/GenericUIComponents/Window/init.lua"
            }
        },
        {
            "name": "Close",
            "desc": "Closes the window and destroys it.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise\n"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 456,
                "path": "src/fusiononrails/src/FusionOnRails/Classes/GenericUIComponents/Window/init.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "Window",
    "desc": "This Component is a generic window that can be used for any purpose.\n\nSet the `Content` prop to the content you want to display in the window.\n\n![Window Example Image](../fusiononrails/WindowExampleImage.png)",
    "source": {
        "line": 13,
        "path": "src/fusiononrails/src/FusionOnRails/Classes/GenericUIComponents/Window/init.lua"
    }
}