Skip to main content

IKRigClient

Handles IK rigging for a humanoid

Functions​

GetPositionOrNil​

</>
IKRigClient:GetPositionOrNil() → Vector3?

Retrieves where the IK rig's position is, if it exists

GetLocalPlayerAimer​

</>
IKRigClient:GetLocalPlayerAimer() → IKRigAimerLocalPlayer?

Retrieves the local player aimer if it exists

GetTarget​

</>
IKRigClient:GetTarget() → Vector3?

Returns where the rig is looking at

Show raw api
{
    "functions": [
        {
            "name": "GetPositionOrNil",
            "desc": "Retrieves where the IK rig's position is, if it exists",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Vector3?"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 50,
                "path": "src/ik/src/Client/Rig/IKRigClient.lua"
            }
        },
        {
            "name": "GetLocalPlayerAimer",
            "desc": "Retrieves the local player aimer if it exists",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "IKRigAimerLocalPlayer?"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 64,
                "path": "src/ik/src/Client/Rig/IKRigClient.lua"
            }
        },
        {
            "name": "GetTarget",
            "desc": "Returns where the rig is looking at",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Vector3?"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 73,
                "path": "src/ik/src/Client/Rig/IKRigClient.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "IKRigClient",
    "desc": "Handles IK rigging for a humanoid",
    "source": {
        "line": 5,
        "path": "src/ik/src/Client/Rig/IKRigClient.lua"
    }
}