Skip to main content

PlayerHumanoidBinderTestUtils

Helpers for the player binder specs, with init and start split so mocks can be staged in between.

Functions​

setup​

PlayerHumanoidBinderTestUtils.setup(
tagPrefix: string,--

keeps tags distinct between the two spec files

constructor: any?--

defaults to a fresh tracking class

) → {...}

Builds a controller around one binder of the given class, registered in a ServiceBag.

Show raw api
{
    "functions": [
        {
            "name": "setup",
            "desc": "Builds a controller around one binder of the given class, registered in a [ServiceBag].",
            "params": [
                {
                    "name": "binderClass",
                    "desc": "",
                    "lua_type": "PlayerCharacterBinder | PlayerHumanoidBinder"
                },
                {
                    "name": "tagPrefix",
                    "desc": "keeps tags distinct between the two spec files",
                    "lua_type": "string"
                },
                {
                    "name": "constructor",
                    "desc": "defaults to a fresh tracking class",
                    "lua_type": "any?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{ ... }"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 29,
                "path": "src/playerhumanoidbinder/src/Server/PlayerHumanoidBinderTestUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "PlayerHumanoidBinderTestUtils",
    "desc": "Helpers for the player binder specs, with init and start split so mocks can be staged in between.",
    "source": {
        "line": 7,
        "path": "src/playerhumanoidbinder/src/Server/PlayerHumanoidBinderTestUtils.lua"
    }
}