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.

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 killer reports for the given character

GetLastDeathReports​

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

Gets the last recorded death reports

Show raw api
{
    "functions": [
        {
            "name": "Init",
            "desc": "Initializes the death report service for the given service bag. Should be done\nvia [ServiceBag].",
            "params": [
                {
                    "name": "serviceBag",
                    "desc": "",
                    "lua_type": "ServiceBag"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 30,
                "path": "src/deathreport/src/Client/DeathReportServiceClient.lua"
            }
        },
        {
            "name": "ObservePlayerKillerReports",
            "desc": "Observes killer reports for the given player",
            "params": [
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<DeathReport>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 62,
                "path": "src/deathreport/src/Client/DeathReportServiceClient.lua"
            }
        },
        {
            "name": "ObservePlayerDeathReports",
            "desc": "Observes death reports for the given player",
            "params": [
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<DeathReport>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 74,
                "path": "src/deathreport/src/Client/DeathReportServiceClient.lua"
            }
        },
        {
            "name": "ObserveHumanoidKillerReports",
            "desc": "Observes killer reports for the given humanoid",
            "params": [
                {
                    "name": "humanoid",
                    "desc": "",
                    "lua_type": "Humanoid"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<DeathReport>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 86,
                "path": "src/deathreport/src/Client/DeathReportServiceClient.lua"
            }
        },
        {
            "name": "ObserveHumanoidDeathReports",
            "desc": "Observes death reports for the given humanoid",
            "params": [
                {
                    "name": "humanoid",
                    "desc": "",
                    "lua_type": "Humanoid"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<DeathReport>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 98,
                "path": "src/deathreport/src/Client/DeathReportServiceClient.lua"
            }
        },
        {
            "name": "ObserveCharacterKillerReports",
            "desc": "Observes killer reports for the given character",
            "params": [
                {
                    "name": "character",
                    "desc": "",
                    "lua_type": "Model"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<DeathReport>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 110,
                "path": "src/deathreport/src/Client/DeathReportServiceClient.lua"
            }
        },
        {
            "name": "ObserveCharacterDeathReports",
            "desc": "Observes killer reports for the given character",
            "params": [
                {
                    "name": "character",
                    "desc": "",
                    "lua_type": "Model"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<DeathReport>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 122,
                "path": "src/deathreport/src/Client/DeathReportServiceClient.lua"
            }
        },
        {
            "name": "GetLastDeathReports",
            "desc": "Gets the last recorded death reports",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{ DeathReport }"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 132,
                "path": "src/deathreport/src/Client/DeathReportServiceClient.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "DeathReportServiceClient",
    "desc": "Centralized death reporting service which can be used to track\ndeaths.",
    "realm": [
        "Client"
    ],
    "source": {
        "line": 8,
        "path": "src/deathreport/src/Client/DeathReportServiceClient.lua"
    }
}