Skip to main content

PlayerDeathTracker

This item only works when running on the server. Server

Counts the deaths of one player. Bound to every Player automatically through a PlayerBinder; every death report for that player increments a replicated IntValue kept under the player.

Retrieve the binder from a ServiceBag with serviceBag:GetService(require("PlayerDeathTracker")).

Functions​

new​

</>
PlayerDeathTracker.new(
player: Player,
serviceBag: ServiceBag
) → PlayerDeathTracker

Constructs a new PlayerDeathTracker. Should be done via the binder.

GetDeathValue​

</>
PlayerDeathTracker.GetDeathValue(self: PlayerDeathTracker) → IntValue

Returns the replicated value holding the death count

GetPlayer​

</>
PlayerDeathTracker.GetPlayer(self: PlayerDeathTracker) → Player

Returns the player whose deaths are tracked

GetDeaths​

</>
PlayerDeathTracker.GetDeaths(self: PlayerDeathTracker) → number

Returns the number of deaths of the player

ObserveDeaths​

</>
PlayerDeathTracker.ObserveDeaths(self: PlayerDeathTracker) → Observable.Observable<number>

Observes the number of deaths of the player

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new PlayerDeathTracker. Should be done via the binder.",
            "params": [
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                },
                {
                    "name": "serviceBag",
                    "desc": "",
                    "lua_type": "ServiceBag"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "PlayerDeathTracker"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 48,
                "path": "src/deathreport/src/Server/Stats/PlayerDeathTracker.lua"
            }
        },
        {
            "name": "GetDeathValue",
            "desc": "Returns the replicated value holding the death count",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "PlayerDeathTracker"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "IntValue"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 75,
                "path": "src/deathreport/src/Server/Stats/PlayerDeathTracker.lua"
            }
        },
        {
            "name": "GetPlayer",
            "desc": "Returns the player whose deaths are tracked",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "PlayerDeathTracker"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Player"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 83,
                "path": "src/deathreport/src/Server/Stats/PlayerDeathTracker.lua"
            }
        },
        {
            "name": "GetDeaths",
            "desc": "Returns the number of deaths of the player",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "PlayerDeathTracker"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 91,
                "path": "src/deathreport/src/Server/Stats/PlayerDeathTracker.lua"
            }
        },
        {
            "name": "ObserveDeaths",
            "desc": "Observes the number of deaths of the player",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "PlayerDeathTracker"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable.Observable<number>\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 98,
                "path": "src/deathreport/src/Server/Stats/PlayerDeathTracker.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "PlayerDeathTracker",
    "desc": "Counts the deaths of one player. Bound to every [Player] automatically through a\n[PlayerBinder]; every death report for that player increments a replicated [IntValue] kept\nunder the player.\n\nRetrieve the binder from a [ServiceBag] with `serviceBag:GetService(require(\"PlayerDeathTracker\"))`.",
    "realm": [
        "Server"
    ],
    "source": {
        "line": 12,
        "path": "src/deathreport/src/Server/Stats/PlayerDeathTracker.lua"
    }
}