2021-03-11 06:29:17 +03:00
|
|
|
# `update-right-status`
|
|
|
|
|
|
2021-03-14 21:55:12 +03:00
|
|
|
*Since: 20210314-114017-04b7cedd*
|
2021-03-11 06:29:17 +03:00
|
|
|
|
|
|
|
|
The `update-right-status` event is emitted periodically (based on the
|
|
|
|
|
interval specified by the [status_update_interval](../config/status_update_interval.md)
|
|
|
|
|
configuration value).
|
|
|
|
|
|
|
|
|
|
There is no defined return value for the event, but its purpose is to allow
|
|
|
|
|
you the chance to carry out some activity and then ultimately call
|
|
|
|
|
[window:set_right_status](../window/set_right_status.md).
|
|
|
|
|
|
|
|
|
|
The first event parameter is a [`window` object](../window/index.md) that
|
|
|
|
|
represents the gui window.
|
|
|
|
|
|
|
|
|
|
The second event parameter is a [`pane` object](../pane/index.md) that
|
|
|
|
|
represents the active pane in that window.
|
|
|
|
|
|
|
|
|
|
`wezterm` will ensure that only a single instance of this event is outstanding;
|
|
|
|
|
if the hook takes longer than the
|
|
|
|
|
[status_update_interval](../config/status_update_interval.md) to complete,
|
|
|
|
|
`wezterm` won't schedule another call until `status_update_interval`
|
|
|
|
|
milliseconds have elapsed since the last call completed.
|
|
|
|
|
|
2022-08-10 16:10:25 +03:00
|
|
|
*Since: nightly builds only*
|
|
|
|
|
|
|
|
|
|
This event is considered to be deprecated and you should migrate
|
|
|
|
|
to using [update-status](update-status.md), which behaves the
|
|
|
|
|
same way, but doesn't overly focus on the right status area.
|
|
|
|
|
|
