Skip to main content

DeathReportUtils

Functions​

fromDeceasedHumanoid​

</>
DeathReportUtils.fromDeceasedHumanoid(
humanoid: Humanomid,
weaponData: WeaponData
) → DeathReport

Constructs a new DeathReport from a humanoid

create​

</>
DeathReportUtils.create(
adornee: Instance,--

The humanoid or character that died

killerAdornee: Instance?,--

The humanoid or character that killed it

weaponData: WeaponData?
) → DeathReport

Constructs a death report for the adornee that died

isDeathReport​

</>
DeathReportUtils.isDeathReport(deathReport: any) → boolean

Returns true if a DeathReport

isWeaponData​

</>
DeathReportUtils.isWeaponData(weaponData: any) → boolean

Returns true if a WeaponData

createWeaponData​

</>
DeathReportUtils.createWeaponData(weaponInstance: Instance?) → WeaponData

Creates weapon data information

getDeadDisplayName​

</>
DeathReportUtils.getDeadDisplayName(deathReport: DeathReport) → string

Gets the dead display name for the player who died.

involvesPlayer​

</>
DeathReportUtils.involvesPlayer(
deathReport: DeathReport,
player: Player
) → string

Returns true if the death involves another player

getKillerDisplayName​

</>
DeathReportUtils.getKillerDisplayName(deathReport: DeathReport) → string?

Gets the killer display name for the player who died.

getDeadColor​

</>
DeathReportUtils.getDeadColor(deathReport: DeathReport) → Color3?

Returns the dead's color

getKillerColor​

</>
DeathReportUtils.getKillerColor(deathReport: DeathReport) → Color3?

Returns the killer's color

getDefaultColor​

</>
DeathReportUtils.getDefaultColor() → Color3

Gets the default color of a death report to use.

Show raw api
{
    "functions": [
        {
            "name": "fromDeceasedHumanoid",
            "desc": "Constructs a new DeathReport from a humanoid",
            "params": [
                {
                    "name": "humanoid",
                    "desc": "",
                    "lua_type": "Humanomid"
                },
                {
                    "name": "weaponData",
                    "desc": "",
                    "lua_type": "WeaponData"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "DeathReport"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 23,
                "path": "src/deathreport/src/Shared/DeathReportUtils.lua"
            }
        },
        {
            "name": "create",
            "desc": "Constructs a death report for the adornee that died",
            "params": [
                {
                    "name": "adornee",
                    "desc": "The humanoid or character that died",
                    "lua_type": "Instance"
                },
                {
                    "name": "killerAdornee",
                    "desc": "The humanoid or character that killed it",
                    "lua_type": "Instance?"
                },
                {
                    "name": "weaponData",
                    "desc": "",
                    "lua_type": "WeaponData?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "DeathReport"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 53,
                "path": "src/deathreport/src/Shared/DeathReportUtils.lua"
            }
        },
        {
            "name": "isDeathReport",
            "desc": "Returns true if a DeathReport",
            "params": [
                {
                    "name": "deathReport",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 81,
                "path": "src/deathreport/src/Shared/DeathReportUtils.lua"
            }
        },
        {
            "name": "isWeaponData",
            "desc": "Returns true if a WeaponData",
            "params": [
                {
                    "name": "weaponData",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 91,
                "path": "src/deathreport/src/Shared/DeathReportUtils.lua"
            }
        },
        {
            "name": "createWeaponData",
            "desc": "Creates weapon data information",
            "params": [
                {
                    "name": "weaponInstance",
                    "desc": "",
                    "lua_type": "Instance?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "WeaponData"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 102,
                "path": "src/deathreport/src/Shared/DeathReportUtils.lua"
            }
        },
        {
            "name": "getDeadDisplayName",
            "desc": "Gets the dead display name for the player who died.",
            "params": [
                {
                    "name": "deathReport",
                    "desc": "",
                    "lua_type": "DeathReport"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 116,
                "path": "src/deathreport/src/Shared/DeathReportUtils.lua"
            }
        },
        {
            "name": "involvesPlayer",
            "desc": "Returns true if the death involves another player",
            "params": [
                {
                    "name": "deathReport",
                    "desc": "",
                    "lua_type": "DeathReport"
                },
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 142,
                "path": "src/deathreport/src/Shared/DeathReportUtils.lua"
            }
        },
        {
            "name": "getKillerDisplayName",
            "desc": "Gets the killer display name for the player who died.",
            "params": [
                {
                    "name": "deathReport",
                    "desc": "",
                    "lua_type": "DeathReport"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "string?"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 154,
                "path": "src/deathreport/src/Shared/DeathReportUtils.lua"
            }
        },
        {
            "name": "getDeadColor",
            "desc": "Returns the dead's color",
            "params": [
                {
                    "name": "deathReport",
                    "desc": "",
                    "lua_type": "DeathReport"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Color3?"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 180,
                "path": "src/deathreport/src/Shared/DeathReportUtils.lua"
            }
        },
        {
            "name": "getKillerColor",
            "desc": "Returns the killer's color",
            "params": [
                {
                    "name": "deathReport",
                    "desc": "",
                    "lua_type": "DeathReport"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Color3?"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 198,
                "path": "src/deathreport/src/Shared/DeathReportUtils.lua"
            }
        },
        {
            "name": "getDefaultColor",
            "desc": "Gets the default color of a death report to use.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Color3"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 216,
                "path": "src/deathreport/src/Shared/DeathReportUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "DeathReportUtils",
    "desc": "",
    "source": {
        "line": 5,
        "path": "src/deathreport/src/Shared/DeathReportUtils.lua"
    }
}