Description

The DeskLocked Lua function returns a boolean indicating if the station is locked.

Arguments

This function does not accept any arguments.

Return

• Boolean:
  The boolean indicates if the station is desk locked or not.
  • True (or 1): The station is locked.
  • False (or 0): The station is not locked.

Example

This example prints the boolean number indicating the "DeskLocked" status to the Command Line History.

return function()
    -- The DeskLocked() return is printed.
    Printf("The desk is locked: " .. tostring(DeskLocked()))
end