work_props.md

Work Props

WorkPropsMakers works just like PresenceMakers.
They generate the WorkProps, a set of properties that dictate how the plugin behaves.

---@class WorkProps
---@field client_id? string
---@field multiple?  boolean
---@field events?    boolean
---@field idle_time? integer

• client_id

  It is the Discord bot's application id.

  Changing the bot doesn't alter the key for asset access.
  If an invalid key is used, Discord won't provide a warning or display anything.

  But if you wish to change it, don't worry, all the assets are in lua/default_makers/assets/images.

• multiple

  It means whether the plugin handles multiple Vim instances.
  If you disable it, each instance will have its own presence on Discord.

• events

  It determines whether the plugin loads Vim events for presence updates.

• idle_time

  It specifies the seconds the plugin waits before considering in idle mode.
  It doesn't work when events is disabled.

See makers definition

---@class WorkPropsMakers : WorkProps
---@field client_id? (fun(): string)|string
---@field mutliple?  (fun(): boolean)|boolean
---@field events?    (fun(): boolean)|boolean
---@field idle_time? (fun(): integer)|integer

lua/types/work_props.lua