Skip to main content

PlayerMockChildrenUtils

The child instances a mock carries: the PlayerGui and PlayerScripts stand-ins the engine inserts at join, and the Backpack and StarterGear it inserts alongside a character spawn.

Use PlayerMock.getPlayerGui, PlayerMock.getPlayerScripts, PlayerMock.getBackpack and PlayerMock.getStarterGear.

Functions​

seedContainers​

</>
PlayerMockChildrenUtils.seedContainers(
player: Player--

must be a PlayerMock

) → ()

Inserts the PlayerGui and PlayerScripts stand-ins the engine creates at join. Neither is Instance.new-able, so like the mock itself they are Folders.

Use PlayerMock.new.

getPlayerGui​

</>
PlayerMockChildrenUtils.getPlayerGui(
player: Player--

must be a PlayerMock

) → PlayerGui

Returns the mock's PlayerGui stand-in.

Use PlayerMock.getPlayerGui.

getPlayerScripts​

</>
PlayerMockChildrenUtils.getPlayerScripts(
player: Player--

must be a PlayerMock

) → PlayerScripts

Returns the mock's PlayerScripts stand-in.

Use PlayerMock.getPlayerScripts.

getBackpack​

</>
PlayerMockChildrenUtils.getBackpack(
player: Player--

must be a PlayerMock

) → Backpack?

Returns the mock's current Backpack stand-in, or nil before the first spawn.

Use PlayerMock.getBackpack.

getStarterGear​

</>
PlayerMockChildrenUtils.getStarterGear(
player: Player--

must be a PlayerMock

) → StarterGear?

Returns the mock's current StarterGear stand-in, or nil before the first spawn.

Use PlayerMock.getStarterGear.

Show raw api
{
    "functions": [
        {
            "name": "seedContainers",
            "desc": "Inserts the `PlayerGui` and `PlayerScripts` stand-ins the engine creates at join. Neither is\n`Instance.new`-able, so like the mock itself they are Folders.\n\nUse [PlayerMock.new].",
            "params": [
                {
                    "name": "player",
                    "desc": "must be a PlayerMock",
                    "lua_type": "Player"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 27,
                "path": "src/player-mock/src/Shared/Helpers/Children/PlayerMockChildrenUtils.lua"
            }
        },
        {
            "name": "getPlayerGui",
            "desc": "Returns the mock's `PlayerGui` stand-in.\n\nUse [PlayerMock.getPlayerGui].",
            "params": [
                {
                    "name": "player",
                    "desc": "must be a PlayerMock",
                    "lua_type": "Player"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "PlayerGui"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 47,
                "path": "src/player-mock/src/Shared/Helpers/Children/PlayerMockChildrenUtils.lua"
            }
        },
        {
            "name": "getPlayerScripts",
            "desc": "Returns the mock's `PlayerScripts` stand-in.\n\nUse [PlayerMock.getPlayerScripts].",
            "params": [
                {
                    "name": "player",
                    "desc": "must be a PlayerMock",
                    "lua_type": "Player"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "PlayerScripts"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 64,
                "path": "src/player-mock/src/Shared/Helpers/Children/PlayerMockChildrenUtils.lua"
            }
        },
        {
            "name": "getBackpack",
            "desc": "Returns the mock's current `Backpack` stand-in, or nil before the first spawn.\n\nUse [PlayerMock.getBackpack].",
            "params": [
                {
                    "name": "player",
                    "desc": "must be a PlayerMock",
                    "lua_type": "Player"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Backpack?"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 81,
                "path": "src/player-mock/src/Shared/Helpers/Children/PlayerMockChildrenUtils.lua"
            }
        },
        {
            "name": "getStarterGear",
            "desc": "Returns the mock's current `StarterGear` stand-in, or nil before the first spawn.\n\nUse [PlayerMock.getStarterGear].",
            "params": [
                {
                    "name": "player",
                    "desc": "must be a PlayerMock",
                    "lua_type": "Player"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "StarterGear?"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 95,
                "path": "src/player-mock/src/Shared/Helpers/Children/PlayerMockChildrenUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "PlayerMockChildrenUtils",
    "desc": "The child instances a mock carries: the `PlayerGui` and `PlayerScripts` stand-ins the engine\ninserts at join, and the `Backpack` and `StarterGear` it inserts alongside a character spawn.\n\nUse [PlayerMock.getPlayerGui], [PlayerMock.getPlayerScripts], [PlayerMock.getBackpack] and\n[PlayerMock.getStarterGear].",
    "source": {
        "line": 11,
        "path": "src/player-mock/src/Shared/Helpers/Children/PlayerMockChildrenUtils.lua"
    }
}