Skip to main content

DeathReportService

This item only works when running on the server. Server

Centralized death reporting service which can be used to track deaths.

Functions​

Init​

</>
DeathReportService:Init(serviceBag: ServiceBag) → ()

Initializes the DeathReportService. Should be done via ServiceBag.

ObservePlayerKillerReports​

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

Observes killer reports for the given player

ObservePlayerDeathReports​

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

Observes death reports for the given player

ObserveHumanoidKillerReports​

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

Observes killer reports for the given humanoid

ObserveHumanoidDeathReports​

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

Observes death reports for the given humanoid

ObserveCharacterKillerReports​

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

Observes killer reports for the given character

ObserveCharacterDeathReports​

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

Observes killer reports for the given character

ReportHumanoidDeath​

</>
DeathReportService:ReportHumanoidDeath(
humanoid: Humanoid,--

Humanoid that died

weaponData: WeaponData?--

Weapon data to report

) → ()

Reports the death of a humanoid. This is called automatically by DeathTrackedHumanoid.

Show raw api
{
    "functions": [
        {
            "name": "Init",
            "desc": "Initializes the DeathReportService. Should be done via [ServiceBag].",
            "params": [
                {
                    "name": "serviceBag",
                    "desc": "",
                    "lua_type": "ServiceBag"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 26,
                "path": "src/deathreport/src/Server/DeathReportService.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": 76,
                "path": "src/deathreport/src/Server/DeathReportService.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": 88,
                "path": "src/deathreport/src/Server/DeathReportService.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": 100,
                "path": "src/deathreport/src/Server/DeathReportService.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": 112,
                "path": "src/deathreport/src/Server/DeathReportService.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": 124,
                "path": "src/deathreport/src/Server/DeathReportService.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": 136,
                "path": "src/deathreport/src/Server/DeathReportService.lua"
            }
        },
        {
            "name": "ReportHumanoidDeath",
            "desc": "Reports the death of a humanoid. This is called automatically\nby [DeathTrackedHumanoid].",
            "params": [
                {
                    "name": "humanoid",
                    "desc": "Humanoid that died",
                    "lua_type": "Humanoid"
                },
                {
                    "name": "weaponData",
                    "desc": "Weapon data to report",
                    "lua_type": "WeaponData?"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 149,
                "path": "src/deathreport/src/Server/DeathReportService.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "DeathReportService",
    "desc": "Centralized death reporting service which can be used to track\ndeaths.",
    "realm": [
        "Server"
    ],
    "source": {
        "line": 8,
        "path": "src/deathreport/src/Server/DeathReportService.lua"
    }
}