Skip to main content

TeamKillTrackerClient

This item only works when running on the client. Client

Client view of a [TeamKillTracker]: reads the replicated kill count of a team.

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

Properties​

KillsChanged​

</>
TeamKillTrackerClient.KillsChanged: RBXScriptSignal

Fires when the kill count changes

Functions​

new​

</>
TeamKillTrackerClient.new(tracker: IntValue) → TeamKillTrackerClient

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

GetKillValue​

</>
TeamKillTrackerClient.GetKillValue(self: TeamKillTrackerClient) → IntValue

Returns the value holding the kill count

GetTeam​

</>
TeamKillTrackerClient.GetTeam(self: TeamKillTrackerClient) → Instance?

Returns the team whose kills are tracked

GetKills​

</>
TeamKillTrackerClient.GetKills(self: TeamKillTrackerClient) → number

Returns the number of kills scored by the team

ObserveKills​

</>
TeamKillTrackerClient.ObserveKills(self: TeamKillTrackerClient) → Observable.Observable<number>

Observes the number of kills scored by the team

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new TeamKillTrackerClient. Should be done via the binder.",
            "params": [
                {
                    "name": "tracker",
                    "desc": "",
                    "lua_type": "IntValue"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "TeamKillTrackerClient"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 39,
                "path": "src/deathreport/src/Client/Stats/TeamKillTrackerClient.lua"
            }
        },
        {
            "name": "GetKillValue",
            "desc": "Returns the value holding the kill count",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "TeamKillTrackerClient"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "IntValue"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 58,
                "path": "src/deathreport/src/Client/Stats/TeamKillTrackerClient.lua"
            }
        },
        {
            "name": "GetTeam",
            "desc": "Returns the team whose kills are tracked",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "TeamKillTrackerClient"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Instance?"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 66,
                "path": "src/deathreport/src/Client/Stats/TeamKillTrackerClient.lua"
            }
        },
        {
            "name": "GetKills",
            "desc": "Returns the number of kills scored by the team",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "TeamKillTrackerClient"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 74,
                "path": "src/deathreport/src/Client/Stats/TeamKillTrackerClient.lua"
            }
        },
        {
            "name": "ObserveKills",
            "desc": "Observes the number of kills scored by the team",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "TeamKillTrackerClient"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable.Observable<number>\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 81,
                "path": "src/deathreport/src/Client/Stats/TeamKillTrackerClient.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "KillsChanged",
            "desc": "Fires when the kill count changes",
            "lua_type": "RBXScriptSignal",
            "source": {
                "line": 47,
                "path": "src/deathreport/src/Client/Stats/TeamKillTrackerClient.lua"
            }
        }
    ],
    "types": [],
    "name": "TeamKillTrackerClient",
    "desc": "Client view of a [TeamKillTracker]: reads the replicated kill count of a team.\n\nRetrieve the binder from a [ServiceBag] with `serviceBag:GetService(require(\"TeamKillTrackerClient\"))`.",
    "realm": [
        "Client"
    ],
    "source": {
        "line": 10,
        "path": "src/deathreport/src/Client/Stats/TeamKillTrackerClient.lua"
    }
}