@lock


Description:

public bool @lock ()

Lock the screen.

This should be called before assigning any windows to monitors. If this function fails the failed signal is emitted, if it succeeds the locked signal is emitted. The failed signal may be emitted before the function returns (for example, if another Instance holds a lock) or later (if another process holds a lock). The only case where neither signal is triggered is if the instance is already locked.

Parameters:

this

the instance to lock

Returns:

false on immediate fail, true if lock acquisition was successfully started