Skip to main content

HumanoidTrackerService

Centralized humanoid tracking service.

Functions​

GetHumanoidTracker​

</>
HumanoidTrackerService:GetHumanoidTracker(
player: Player?--

If not set, uses local player

) → HumanoidTracker

Gets a humanoid tracker for a given player

GetHumanoid​

</>
HumanoidTrackerService:GetHumanoid(
player: Player?--

If not set, uses local player

) → Humanoid?

Gets a player's humanoid

ObserveHumanoid​

</>
HumanoidTrackerService:ObserveHumanoid(
player: Player?--

If not set, uses local player

) → Observable<Humanoid | nil>

Observe a player's humanoid

ObserveHumanoidBrio​

</>
HumanoidTrackerService:ObserveHumanoidBrio(
player: Player?--

If not set, uses local player

) → Observable<Brio<Humanoid>>

Observe a player's humanoid

GetAliveHumanoid​

</>
HumanoidTrackerService:GetAliveHumanoid(
player: Player?--

If not set, uses local player

) → Humanoid?

Gets a player's alive humanoid

ObserveAliveHumanoid​

</>
HumanoidTrackerService:ObserveAliveHumanoid(
player: Player?--

If not set, uses local player

) → Observable<Humanoid | nil>

Observe a player's alive humanoid

ObserveAliveHumanoidBrio​

</>
HumanoidTrackerService:ObserveAliveHumanoidBrio(
player: Player?--

If not set, uses local player

) → Observable<Brio<Humanoid>>

Observe a player's alive humanoid

Destroy​

</>
HumanoidTrackerService:Destroy() → ()

Cleans up the humanoid tracking service

Show raw api
{
    "functions": [
        {
            "name": "GetHumanoidTracker",
            "desc": "Gets a humanoid tracker for a given player",
            "params": [
                {
                    "name": "player",
                    "desc": "If not set, uses local player",
                    "lua_type": "Player?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "HumanoidTracker"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 34,
                "path": "src/humanoidtracker/src/Shared/HumanoidTrackerService.lua"
            }
        },
        {
            "name": "GetHumanoid",
            "desc": "Gets a player's humanoid",
            "params": [
                {
                    "name": "player",
                    "desc": "If not set, uses local player",
                    "lua_type": "Player?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Humanoid?"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 63,
                "path": "src/humanoidtracker/src/Shared/HumanoidTrackerService.lua"
            }
        },
        {
            "name": "ObserveHumanoid",
            "desc": "Observe a player's humanoid",
            "params": [
                {
                    "name": "player",
                    "desc": "If not set, uses local player",
                    "lua_type": "Player?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Humanoid | nil>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 76,
                "path": "src/humanoidtracker/src/Shared/HumanoidTrackerService.lua"
            }
        },
        {
            "name": "ObserveHumanoidBrio",
            "desc": "Observe a player's humanoid",
            "params": [
                {
                    "name": "player",
                    "desc": "If not set, uses local player",
                    "lua_type": "Player?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Brio<Humanoid>>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 90,
                "path": "src/humanoidtracker/src/Shared/HumanoidTrackerService.lua"
            }
        },
        {
            "name": "GetAliveHumanoid",
            "desc": "Gets a player's alive humanoid",
            "params": [
                {
                    "name": "player",
                    "desc": "If not set, uses local player",
                    "lua_type": "Player?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Humanoid?"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 106,
                "path": "src/humanoidtracker/src/Shared/HumanoidTrackerService.lua"
            }
        },
        {
            "name": "ObserveAliveHumanoid",
            "desc": "Observe a player's alive humanoid",
            "params": [
                {
                    "name": "player",
                    "desc": "If not set, uses local player",
                    "lua_type": "Player?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Humanoid | nil>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 119,
                "path": "src/humanoidtracker/src/Shared/HumanoidTrackerService.lua"
            }
        },
        {
            "name": "ObserveAliveHumanoidBrio",
            "desc": "Observe a player's alive humanoid",
            "params": [
                {
                    "name": "player",
                    "desc": "If not set, uses local player",
                    "lua_type": "Player?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Brio<Humanoid>>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 133,
                "path": "src/humanoidtracker/src/Shared/HumanoidTrackerService.lua"
            }
        },
        {
            "name": "Destroy",
            "desc": "Cleans up the humanoid tracking service",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 146,
                "path": "src/humanoidtracker/src/Shared/HumanoidTrackerService.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "HumanoidTrackerService",
    "desc": "Centralized humanoid tracking service.",
    "source": {
        "line": 6,
        "path": "src/humanoidtracker/src/Shared/HumanoidTrackerService.lua"
    }
}