Skip to main content

PlayerMockSignalUtils

The events a mock stands in for, each backed by a same-named BindableEvent. A one-element path names a Player event ("Chatted"); a two-element one names an event of a client-global service ("UserInputService.WindowFocused"), which the mock keeps per-mock, a headless server having one of each while a test may hold several mocks.

Paths are checked against the engine's own reflection, so a typo errors instead of returning a signal that can never fire.

Use PlayerMock.getSignal and PlayerMock.fireSignal.

Functions​

getSignal​

</>
PlayerMockSignalUtils.getSignal(
player: Player,--

must be a PlayerMock

eventPath: InstancePathTableLike--

"Chatted" or "UserInputService.WindowFocused"

) → RBXScriptSignal

Returns the genuine native signal for events the mock's backing Folder inherits from Instance, otherwise a BindableEvent-backed stand-in.

Use PlayerMock.getSignal.

fireSignal​

</>
PlayerMockSignalUtils.fireSignal(
player: Player,--

must be a PlayerMock

eventPath: InstancePathTableLike,--

"Chatted" or "UserInputService.WindowFocused"

...: any--

Event arguments delivered to connected handlers.

) → ()

Fires the stand-in a consumer connected through PlayerMockSignalUtils.getSignal as if the engine had fired the real event.

Use PlayerMock.fireSignal.

Show raw api
{
    "functions": [
        {
            "name": "getSignal",
            "desc": "Returns the genuine native signal for events the mock's backing Folder inherits from `Instance`,\notherwise a `BindableEvent`-backed stand-in.\n\nUse [PlayerMock.getSignal].",
            "params": [
                {
                    "name": "player",
                    "desc": "must be a PlayerMock",
                    "lua_type": "Player"
                },
                {
                    "name": "eventPath",
                    "desc": "`\"Chatted\"` or `\"UserInputService.WindowFocused\"`",
                    "lua_type": "InstancePathTableLike"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "RBXScriptSignal"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 35,
                "path": "src/player-mock/src/Shared/Helpers/Signals/PlayerMockSignalUtils.lua"
            }
        },
        {
            "name": "fireSignal",
            "desc": "Fires the stand-in a consumer connected through [PlayerMockSignalUtils.getSignal] as if the engine\nhad fired the real event.\n\nUse [PlayerMock.fireSignal].",
            "params": [
                {
                    "name": "player",
                    "desc": "must be a PlayerMock",
                    "lua_type": "Player"
                },
                {
                    "name": "eventPath",
                    "desc": "`\"Chatted\"` or `\"UserInputService.WindowFocused\"`",
                    "lua_type": "InstancePathTableLike"
                },
                {
                    "name": "...",
                    "desc": "Event arguments delivered to connected handlers.",
                    "lua_type": "any"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 69,
                "path": "src/player-mock/src/Shared/Helpers/Signals/PlayerMockSignalUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "PlayerMockSignalUtils",
    "desc": "The events a mock stands in for, each backed by a same-named BindableEvent. A one-element path\nnames a `Player` event (`\"Chatted\"`); a two-element one names an event of a client-global service\n(`\"UserInputService.WindowFocused\"`), which the mock keeps per-mock, a headless server having one\nof each while a test may hold several mocks.\n\nPaths are checked against the engine's own reflection, so a typo errors instead of returning a\nsignal that can never fire.\n\nUse [PlayerMock.getSignal] and [PlayerMock.fireSignal].",
    "source": {
        "line": 15,
        "path": "src/player-mock/src/Shared/Helpers/Signals/PlayerMockSignalUtils.lua"
    }
}