Skip to main content

RoundEventBus

Provides an event bus for the round manager, allowing for event-driven communication between different parts of the system with Sleitnick's signal.

Functions​

new​

</>
RoundEventBus.new() → RoundEventBus

Constructor method for a new RoundEventBus

Get​

</>
RoundEventBus:Get(eventName: string) → signalSignal

Gets an event from the event bus, if it does not exist it will be created.

Connect​

</>
RoundEventBus:Connect(
eventName: string,
callback: any
) → RBXScriptConnection

Connects to an event on the event bus, if it does not exist it will be created.

Fire​

</>
RoundEventBus:Fire(
eventName: string,
...: any
) → ()

Fires an event on the event bus.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructor method for a new RoundEventBus",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "RoundEventBus"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 10,
                "path": "src/Systems/RoundEventBus.lua"
            }
        },
        {
            "name": "Get",
            "desc": "Gets an event from the event bus, if it does not exist it will be created.",
            "params": [
                {
                    "name": "eventName",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "signal Signal"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 19,
                "path": "src/Systems/RoundEventBus.lua"
            }
        },
        {
            "name": "Connect",
            "desc": "Connects to an event on the event bus, if it does not exist it will be created.",
            "params": [
                {
                    "name": "eventName",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "callback",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "RBXScriptConnection"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 32,
                "path": "src/Systems/RoundEventBus.lua"
            }
        },
        {
            "name": "Fire",
            "desc": "Fires an event on the event bus.",
            "params": [
                {
                    "name": "eventName",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "...",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 39,
                "path": "src/Systems/RoundEventBus.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "RoundEventBus",
    "desc": "Provides an event bus for the round manager, allowing for event-driven communication between different parts of the system with Sleitnick's signal.",
    "source": {
        "line": 5,
        "path": "src/Systems/RoundEventBus.lua"
    }
}