Skip to main content

IKRigAimerLocalPlayer

This item only works when running on the client. Client

Handles repliation and aiming of the local player's character for IK.

Functions​

new​

</>
IKRigAimerLocalPlayer.new(
serviceBag: ServiceBag,
ikRig: IKRigClient
) → IKRigAimerLocalPlayer

Constructs a new IKRigAimerLocalPlayer. Should not be used directly. See IKServiceClient for the correct usage.

SetRemoteEvent​

</>
IKRigAimerLocalPlayer:SetRemoteEvent(remoteEvent: RemoteEvent) → ()

Sets the remote event for replication

SetLookAround​

</>
IKRigAimerLocalPlayer:SetLookAround(lookAround: boolean) → ()

Sets whether the local player should look around automatically.

SetAimPosition​

</>
IKRigAimerLocalPlayer:SetAimPosition(
position: Vector3?,--

May be nil to say to aim at nothing

optionalPriority: number
) → ()

Sets the aim position for the local player for this frame. See IKAimPositionPriorites.

GetAimPosition​

</>
IKRigAimerLocalPlayer:GetAimPosition() → Vector3?

Gets the current aim position.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new IKRigAimerLocalPlayer. Should not be used directly.\nSee [IKServiceClient] for the correct usage.",
            "params": [
                {
                    "name": "serviceBag",
                    "desc": "",
                    "lua_type": "ServiceBag"
                },
                {
                    "name": "ikRig",
                    "desc": "",
                    "lua_type": "IKRigClient"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "IKRigAimerLocalPlayer"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 30,
                "path": "src/ik/src/Client/Rig/IKRigAimerLocalPlayer.lua"
            }
        },
        {
            "name": "SetRemoteEvent",
            "desc": "Sets the remote event for replication",
            "params": [
                {
                    "name": "remoteEvent",
                    "desc": "",
                    "lua_type": "RemoteEvent"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 53,
                "path": "src/ik/src/Client/Rig/IKRigAimerLocalPlayer.lua"
            }
        },
        {
            "name": "SetLookAround",
            "desc": "Sets whether the local player should look around automatically.",
            "params": [
                {
                    "name": "lookAround",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 63,
                "path": "src/ik/src/Client/Rig/IKRigAimerLocalPlayer.lua"
            }
        },
        {
            "name": "SetAimPosition",
            "desc": "Sets the aim position for the local player for this frame. See [IKAimPositionPriorites].",
            "params": [
                {
                    "name": "position",
                    "desc": "May be nil to say to aim at nothing",
                    "lua_type": "Vector3?"
                },
                {
                    "name": "optionalPriority",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 75,
                "path": "src/ik/src/Client/Rig/IKRigAimerLocalPlayer.lua"
            }
        },
        {
            "name": "GetAimPosition",
            "desc": "Gets the current aim position.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Vector3?"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 130,
                "path": "src/ik/src/Client/Rig/IKRigAimerLocalPlayer.lua"
            }
        },
        {
            "name": "UpdateStepped",
            "desc": "Updates the aimer on stepped.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "private": true,
            "source": {
                "line": 167,
                "path": "src/ik/src/Client/Rig/IKRigAimerLocalPlayer.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "IKRigAimerLocalPlayer",
    "desc": "Handles repliation and aiming of the local player's character for\nIK.",
    "realm": [
        "Client"
    ],
    "source": {
        "line": 8,
        "path": "src/ik/src/Client/Rig/IKRigAimerLocalPlayer.lua"
    }
}