Nucleus handler tools โบ Docs โบ ProtoInput โบ InstallHook
ProtoInput.InstallHook
Open in the workbench (search, and try it in a handler)
ProtoInput.InstallHook(
instanceHandle: number,
hookID: number
): void
Installs a Proto Input hook in the game instance. Parameters: the instance handle (Player.ProtoInputInstanceHandle) and a hook ID from ProtoInput.Values (the HookID values). An unknown handle does nothing, and the call waits until Proto Input in the game has connected.
instanceHandle: The player's Proto Input instance, Player.ProtoInputInstanceHandle (or PlayerList[i].ProtoInputInstanceHandle); Nucleus sets it when it injects Proto Input, otherwise it is 0.hookID: Which hook to install: a ProtoInput.Values.*HookID value, e.g. ProtoInput.Values.GetCursorPosHookID or ProtoInput.Values.FocusHooksHookID.
In practice
Handlers call it in Game.ProtoInput.OnInputLocked, in a loop over PlayerList, so a hook acts only while input is locked, and remove it again with ProtoInput.UninstallHook in Game.ProtoInput.OnInputUnlocked. The cursor and key state hooks are the usual ones: GetCursorPosHookID, SetCursorPosHookID, GetKeyStateHookID, GetAsyncKeyStateHookID, GetKeyboardStateHookID.
Example: From Hub handlers
for (var i = 0; i < PlayerList.Count; i++) {
var player = PlayerList[i];
ProtoInput.InstallHook(
player.ProtoInputInstanceHandle,
ProtoInput.Values.GetCursorPosHookID
);
}