Skip to main content

IKRig

This item only works when running on the server. Server

Serverside implementation of IKRig

Functions​

GetAimPosition​

</>
IKRig.GetAimPosition(self: IKRig) → Vector3?

Returns where the rig is looking at

SetAimPosition​

</>
IKRig.SetAimPosition(
self: IKRig,
target: Vector3?
) → ()

Sets the IK Rig target and replicates it to the client

Show raw api
{
    "functions": [
        {
            "name": "GetAimPosition",
            "desc": "Returns where the rig is looking at",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "IKRig"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Vector3?"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 50,
                "path": "src/ik/src/Server/Rig/IKRig.lua"
            }
        },
        {
            "name": "SetAimPosition",
            "desc": "Sets the IK Rig target and replicates it to the client",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "IKRig"
                },
                {
                    "name": "target",
                    "desc": "",
                    "lua_type": "Vector3?"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 59,
                "path": "src/ik/src/Server/Rig/IKRig.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "IKRig",
    "desc": "Serverside implementation of IKRig",
    "realm": [
        "Server"
    ],
    "source": {
        "line": 7,
        "path": "src/ik/src/Server/Rig/IKRig.lua"
    }
}