Skip to main content

DeathReportServiceClient

This item only works when running on the client. Client

Centralized death reporting service which can be used to track deaths. Receives the reports DeathReportService replicates and feeds them to DeathReportDataService, which this service aliases.

Properties​

NewDeathReport​

</>
DeathReportServiceClient.NewDeathReport: Signal<DeathReport>

Fires with every [DeathReport] the server replicates. Same signal as DeathReportDataService.NewDeathReport.

Functions​

Init​

</>
DeathReportServiceClient.Init(
serviceBag: ServiceBag
) → ()

Initializes the death report service for the given service bag. Should be done via ServiceBag.

ObservePlayerKillerReports​

</>
DeathReportServiceClient.ObservePlayerKillerReports(
player: Player
) → Observable<DeathReport>

Observes killer reports for the given player

ObservePlayerDeathReports​

</>
DeathReportServiceClient.ObservePlayerDeathReports(
player: Player
) → Observable<DeathReport>

Observes death reports for the given player

ObserveHumanoidKillerReports​

</>
DeathReportServiceClient.ObserveHumanoidKillerReports(
humanoid: Humanoid
) → Observable<DeathReport>

Observes killer reports for the given humanoid

ObserveHumanoidDeathReports​

</>
DeathReportServiceClient.ObserveHumanoidDeathReports(
humanoid: Humanoid
) → Observable<DeathReport>

Observes death reports for the given humanoid

ObserveCharacterKillerReports​

</>
DeathReportServiceClient.ObserveCharacterKillerReports(
character: Model
) → Observable<DeathReport>

Observes killer reports for the given character

ObserveCharacterDeathReports​

</>
DeathReportServiceClient.ObserveCharacterDeathReports(
character: Model
) → Observable<DeathReport>

Observes death reports for the given character

GetLastDeathReports​

</>
DeathReportServiceClient.GetLastDeathReports(self: DeathReportServiceClient) → {DeathReport}

Gets the last recorded death reports, oldest first

Show raw api
{
    "functions": [
        {
            "name": "Init",
            "desc": "Initializes the death report service for the given service bag. Should be done\nvia [ServiceBag].",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "DeathReportServiceClient"
                },
                {
                    "name": "serviceBag",
                    "desc": "",
                    "lua_type": "ServiceBag"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 47,
                "path": "src/deathreport/src/Client/DeathReportServiceClient.lua"
            }
        },
        {
            "name": "ObservePlayerKillerReports",
            "desc": "Observes killer reports for the given player",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "DeathReportServiceClient"
                },
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<DeathReport>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 82,
                "path": "src/deathreport/src/Client/DeathReportServiceClient.lua"
            }
        },
        {
            "name": "ObservePlayerDeathReports",
            "desc": "Observes death reports for the given player",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "DeathReportServiceClient"
                },
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<DeathReport>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 95,
                "path": "src/deathreport/src/Client/DeathReportServiceClient.lua"
            }
        },
        {
            "name": "ObserveHumanoidKillerReports",
            "desc": "Observes killer reports for the given humanoid",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "DeathReportServiceClient"
                },
                {
                    "name": "humanoid",
                    "desc": "",
                    "lua_type": "Humanoid"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<DeathReport>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 108,
                "path": "src/deathreport/src/Client/DeathReportServiceClient.lua"
            }
        },
        {
            "name": "ObserveHumanoidDeathReports",
            "desc": "Observes death reports for the given humanoid",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "DeathReportServiceClient"
                },
                {
                    "name": "humanoid",
                    "desc": "",
                    "lua_type": "Humanoid"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<DeathReport>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 121,
                "path": "src/deathreport/src/Client/DeathReportServiceClient.lua"
            }
        },
        {
            "name": "ObserveCharacterKillerReports",
            "desc": "Observes killer reports for the given character",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "DeathReportServiceClient"
                },
                {
                    "name": "character",
                    "desc": "",
                    "lua_type": "Model"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<DeathReport>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 134,
                "path": "src/deathreport/src/Client/DeathReportServiceClient.lua"
            }
        },
        {
            "name": "ObserveCharacterDeathReports",
            "desc": "Observes death reports for the given character",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "DeathReportServiceClient"
                },
                {
                    "name": "character",
                    "desc": "",
                    "lua_type": "Model"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<DeathReport>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 147,
                "path": "src/deathreport/src/Client/DeathReportServiceClient.lua"
            }
        },
        {
            "name": "GetLastDeathReports",
            "desc": "Gets the last recorded death reports, oldest first",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "DeathReportServiceClient"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{ DeathReport }"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 158,
                "path": "src/deathreport/src/Client/DeathReportServiceClient.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "NewDeathReport",
            "desc": "Fires with every [DeathReport] the server replicates. Same signal as\n[DeathReportDataService.NewDeathReport].",
            "lua_type": "Signal<DeathReport>",
            "source": {
                "line": 66,
                "path": "src/deathreport/src/Client/DeathReportServiceClient.lua"
            }
        }
    ],
    "types": [],
    "name": "DeathReportServiceClient",
    "desc": "Centralized death reporting service which can be used to track\ndeaths. Receives the reports [DeathReportService] replicates and feeds them to\n[DeathReportDataService], which this service aliases.",
    "realm": [
        "Client"
    ],
    "source": {
        "line": 10,
        "path": "src/deathreport/src/Client/DeathReportServiceClient.lua"
    }
}