Skip to main content

PlayerCharacterBinder

Binder that will automatically bind to each player's character

Functions​

new​

</>
PlayerCharacterBinder.new(
tag: string,
...: any
) → PlayerCharacterBinder<T>

Returns a new PlayerCharacterBinder

Init​

</>
PlayerCharacterBinder:Init(...: any) → ()

Inits the binder. See Binder.Init. Should be done via a ServiceBag.

SetAutomaticTagging​

</>
PlayerCharacterBinder:SetAutomaticTagging(shouldTag: boolean) → ()

Sets whether tagging should be enabled

ObserveAutomaticTagging​

</>
PlayerCharacterBinder:ObserveAutomaticTagging() → Observable<boolean>

ObserveAutomaticTaggingBrio​

</>
PlayerCharacterBinder:ObserveAutomaticTaggingBrio(
predicate: function--

Optional predicate

) → Observable<Brio<boolean>>

Start​

</>
PlayerCharacterBinder:Start() → ()

Starts the binder. See Binder.Start. Should be done via a ServiceBag.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Returns a new PlayerCharacterBinder",
            "params": [
                {
                    "name": "tag",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "class",
                    "desc": "",
                    "lua_type": "BinderContructor"
                },
                {
                    "name": "...",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "PlayerCharacterBinder<T>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 25,
                "path": "src/playerhumanoidbinder/src/Server/PlayerCharacterBinder.lua"
            }
        },
        {
            "name": "Init",
            "desc": "Inits the binder. See [Binder.Init].\nShould be done via a [ServiceBag].",
            "params": [
                {
                    "name": "...",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 37,
                "path": "src/playerhumanoidbinder/src/Server/PlayerCharacterBinder.lua"
            }
        },
        {
            "name": "SetAutomaticTagging",
            "desc": "Sets whether tagging should be enabled",
            "params": [
                {
                    "name": "shouldTag",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 50,
                "path": "src/playerhumanoidbinder/src/Server/PlayerCharacterBinder.lua"
            }
        },
        {
            "name": "ObserveAutomaticTagging",
            "desc": "",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<boolean>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 60,
                "path": "src/playerhumanoidbinder/src/Server/PlayerCharacterBinder.lua"
            }
        },
        {
            "name": "ObserveAutomaticTaggingBrio",
            "desc": "",
            "params": [
                {
                    "name": "predicate",
                    "desc": "Optional predicate",
                    "lua_type": "function"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Brio<boolean>>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 68,
                "path": "src/playerhumanoidbinder/src/Server/PlayerCharacterBinder.lua"
            }
        },
        {
            "name": "Start",
            "desc": "Starts the binder. See [Binder.Start].\nShould be done via a [ServiceBag].",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 76,
                "path": "src/playerhumanoidbinder/src/Server/PlayerCharacterBinder.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "PlayerCharacterBinder",
    "desc": "Binder that will automatically bind to each player's character",
    "source": {
        "line": 5,
        "path": "src/playerhumanoidbinder/src/Server/PlayerCharacterBinder.lua"
    }
}