Skip to main content

BinderGroupProvider

Provides a basis for binderGroups that can be retrieved anywhere

Functions​

new​

</>
BinderGroupProvider.new(initMethod: (BinderGroupProvider) → ()) → BinderGroupProvider

Constructs a new BinderGroupProvider

PromiseGroupsAdded​

</>
BinderGroupProvider:PromiseGroupsAdded() → Promise

Returns a promise that will resolve once groups are added.

Init​

</>
BinderGroupProvider:Init(...: ServiceBag | any) → ()

Starts the binder provider. Should be called via ServiceBag.

Start​

</>
BinderGroupProvider:Start() → ()

Starts the binder provider. Should be called via ServiceBag.

Get​

</>
BinderGroupProvider:Get(groupName: string) → BinderGroup?

Returns a binder group given the binderName

Add​

</>
BinderGroupProvider:Add(
groupName: string,
binderGroup: BinderGroup
) → ()

Adds a new group at the given name

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new BinderGroupProvider",
            "params": [
                {
                    "name": "initMethod",
                    "desc": "",
                    "lua_type": "(BinderGroupProvider) -> ()"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "BinderGroupProvider"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 20,
                "path": "src/binder/src/Shared/BinderGroupProvider.lua"
            }
        },
        {
            "name": "PromiseGroupsAdded",
            "desc": "Returns a promise that will resolve once groups are added.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 36,
                "path": "src/binder/src/Shared/BinderGroupProvider.lua"
            }
        },
        {
            "name": "Init",
            "desc": "Starts the binder provider. Should be called via ServiceBag.",
            "params": [
                {
                    "name": "...",
                    "desc": "",
                    "lua_type": "ServiceBag | any"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 44,
                "path": "src/binder/src/Shared/BinderGroupProvider.lua"
            }
        },
        {
            "name": "Start",
            "desc": "Starts the binder provider. Should be called via ServiceBag.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 56,
                "path": "src/binder/src/Shared/BinderGroupProvider.lua"
            }
        },
        {
            "name": "Get",
            "desc": "Returns a binder group given the binderName",
            "params": [
                {
                    "name": "groupName",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "BinderGroup?"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 74,
                "path": "src/binder/src/Shared/BinderGroupProvider.lua"
            }
        },
        {
            "name": "Add",
            "desc": "Adds a new group at the given name",
            "params": [
                {
                    "name": "groupName",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "binderGroup",
                    "desc": "",
                    "lua_type": "BinderGroup"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 85,
                "path": "src/binder/src/Shared/BinderGroupProvider.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "BinderGroupProvider",
    "desc": "Provides a basis for binderGroups that can be retrieved anywhere",
    "source": {
        "line": 5,
        "path": "src/binder/src/Shared/BinderGroupProvider.lua"
    }
}