Lock

The km.lock_[button_lock_name] command is used to read and write the state of the lock on any mouse button.

By replacing button_lock_name with one of the button lock names defined below, it can be made to work with any button.

Calling the command with no arguments (by using ()) will return the state of the lock on the button.

Calling the command with one argument will set the lock’s state. If the argument is 1 it will enable it. If it is 0, it will disable it.

When the lock is enabled, any physical button presses will not be sent to the Output PC. The Input PC can still read the button states via either the Get Button State or Button State Event commands. The Input PC can also still press/release the button via either the Click or Press/Release commands.

This is also known as “input masking”, as the physical input is “masked” from the Output PC.

Examples

Locking the Left Mouse Button

Input:

km.lock_ml(1)  # Since the value is 1, the lock is now on.

Output:

km.lock_ml(1)
>>>

Locking, Reading, Unlocking, and Reading the Front Side Mouse Button

Input:

km.lock_ms2(1)   # The side button will no longer function on the Output PC.
km.lock_ms2()
km.lock_ms2(0)   # The side button will now work again on the Output PC.
km.lock_ms2()

Output:

km.lock_ms2(1)
>>> km.lock_ms2()
1                  # Since the lock is enabled, this outputs 1.
>>> km.lock_ms2(0)
>>> km.lock_ms2()
0                  # Since the lock is disabled, this outputs 0.
>>>