Skip to main content

EquippedTracker

Tracks the equipped player of a tool

Properties​

Player​

</>
EquippedTracker.Player: ValueObject<Player>

Tracks current equipped player who has an alive humanoid

Functions​

new​

</>
EquippedTracker.new(tool: Tool) → EquippedTracker

Tracks the state of a tool being equipped

Destroy​

</>
EquippedTracker:Destroy() → ()

Cleans up the EquippedTracker

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Tracks the state of a tool being equipped",
            "params": [
                {
                    "name": "tool",
                    "desc": "",
                    "lua_type": "Tool"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "EquippedTracker"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 21,
                "path": "src/equippedtracker/src/Shared/EquippedTracker.lua"
            }
        },
        {
            "name": "Destroy",
            "desc": "Cleans up the EquippedTracker",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 72,
                "path": "src/equippedtracker/src/Shared/EquippedTracker.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "Player",
            "desc": "Tracks current equipped player who has an alive humanoid",
            "lua_type": "ValueObject<Player>",
            "source": {
                "line": 34,
                "path": "src/equippedtracker/src/Shared/EquippedTracker.lua"
            }
        }
    ],
    "types": [],
    "name": "EquippedTracker",
    "desc": "Tracks the equipped player of a tool",
    "source": {
        "line": 5,
        "path": "src/equippedtracker/src/Shared/EquippedTracker.lua"
    }
}