Show raw api
{
"functions": [
{
"name": "new",
"desc": "Constructs a new BasicPane with the .Gui property set.",
"params": [
{
"name": "gui",
"desc": "Optional Gui object",
"lua_type": "GuiObject?"
}
],
"returns": [
{
"desc": "",
"lua_type": "BasicPane"
}
],
"function_type": "static",
"source": {
"line": 60,
"path": "src/basicpane/src/Shared/BasicPane.lua"
}
},
{
"name": "isBasicPane",
"desc": "Returns whether the value is a basic pane",
"params": [
{
"name": "value",
"desc": "",
"lua_type": "any"
}
],
"returns": [
{
"desc": "",
"lua_type": "boolean"
}
],
"function_type": "static",
"source": {
"line": 95,
"path": "src/basicpane/src/Shared/BasicPane.lua"
}
},
{
"name": "SetVisible",
"desc": "Sets the BasicPane to be visible",
"params": [
{
"name": "self",
"desc": "",
"lua_type": "BasicPane"
},
{
"name": "isVisible",
"desc": "Whether or not the pane should be visible",
"lua_type": "boolean"
},
{
"name": "doNotAnimate",
"desc": "True if this visiblity should not animate",
"lua_type": "boolean?"
}
],
"returns": [],
"function_type": "static",
"source": {
"line": 105,
"path": "src/basicpane/src/Shared/BasicPane.lua"
}
},
{
"name": "ObserveVisible",
"desc": "Returns an observable that observes visibility",
"params": [
{
"name": "self",
"desc": "",
"lua_type": "BasicPane"
}
],
"returns": [
{
"desc": "",
"lua_type": "Observable<boolean, boolean?>"
}
],
"function_type": "static",
"source": {
"line": 116,
"path": "src/basicpane/src/Shared/BasicPane.lua"
}
},
{
"name": "ObserveVisibleBrio",
"desc": "Returns an observable that observes visibility",
"params": [
{
"name": "self",
"desc": "",
"lua_type": "BasicPane"
},
{
"name": "predicate",
"desc": "Optional predicate. If not includeded returns the value.",
"lua_type": "function | nil"
}
],
"returns": [
{
"desc": "",
"lua_type": "Observable<Brio<boolean>>"
}
],
"function_type": "static",
"source": {
"line": 126,
"path": "src/basicpane/src/Shared/BasicPane.lua"
}
},
{
"name": "Show",
"desc": "Shows the pane",
"params": [
{
"name": "self",
"desc": "",
"lua_type": "BasicPane"
},
{
"name": "doNotAnimate",
"desc": "True if this visiblity should not animate",
"lua_type": "boolean?"
}
],
"returns": [],
"function_type": "static",
"source": {
"line": 139,
"path": "src/basicpane/src/Shared/BasicPane.lua"
}
},
{
"name": "Hide",
"desc": "Hides the pane",
"params": [
{
"name": "self",
"desc": "",
"lua_type": "BasicPane"
},
{
"name": "doNotAnimate",
"desc": "True if this visiblity should not animate",
"lua_type": "boolean?"
}
],
"returns": [],
"function_type": "static",
"source": {
"line": 147,
"path": "src/basicpane/src/Shared/BasicPane.lua"
}
},
{
"name": "Toggle",
"desc": "Toggles the pane",
"params": [
{
"name": "self",
"desc": "",
"lua_type": "BasicPane"
},
{
"name": "doNotAnimate",
"desc": "True if this visiblity should not animate",
"lua_type": "boolean?"
}
],
"returns": [],
"function_type": "static",
"source": {
"line": 155,
"path": "src/basicpane/src/Shared/BasicPane.lua"
}
},
{
"name": "IsVisible",
"desc": "Returns if the pane is visible",
"params": [
{
"name": "self",
"desc": "",
"lua_type": "BasicPane"
}
],
"returns": [
{
"desc": "",
"lua_type": "boolean"
}
],
"function_type": "static",
"source": {
"line": 163,
"path": "src/basicpane/src/Shared/BasicPane.lua"
}
},
{
"name": "Destroy",
"desc": "Cleans up the BasicPane, invoking Maid:DoCleaning() on the BasicPane and\nsetting the metatable to nil.",
"params": [
{
"name": "self",
"desc": "",
"lua_type": "BasicPane"
}
],
"returns": [],
"function_type": "static",
"source": {
"line": 171,
"path": "src/basicpane/src/Shared/BasicPane.lua"
}
}
],
"properties": [
{
"name": "VisibleChanged",
"desc": "Fires whenever visibility changes. FIres with isVisible, doNotAnimate, and a maid which\nhas the lifetime of the visibility.\n\n:::info\nDo not use the Maid if you want the code to work in Deferred signal mode.\n:::\n\n\t",
"lua_type": "Signal<boolean, boolean>",
"source": {
"line": 77,
"path": "src/basicpane/src/Shared/BasicPane.lua"
}
}
],
"types": [],
"name": "BasicPane",
"desc": "Base UI object with visibility and a maid. BasicPane provides three points of utility.\n\n1. BasicPane contain visibility API. It's very standard practice to use the VisibleChanged event and\npass visibility up or down the entire stack.\n\n```lua\n-- Standard visibility chaining\nself._maid:GiveTask(self.VisibleChanged:Connect(function(isVisible, doNotAnimate)\n\tself._otherComponent:SetVisible(isVisible, doNotAnimate)\nend))\n```\n\n2. BasicPane contains a maid which cleans up upon :Destroy(). This just saves some time typing.\n\n3. Finally, BasicPanes, by convention (although not requirement), contain a .Gui object which can generally\nbe safely reparented to another object.",
"source": {
"line": 22,
"path": "src/basicpane/src/Shared/BasicPane.lua"
}
}