Skip to content

Commit ad2ac00

Browse files
Improve documentation of overlay dev guide overlay_trigger fun
1 parent 0805097 commit ad2ac00

1 file changed

Lines changed: 13 additions & 13 deletions

File tree

docs/dev/overlay-dev-guide.rst

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -71,21 +71,21 @@ beyond your everyday `widgets.Widget <widget>`:
7171
widgets owned by the overlay framework must not be attached to that new
7272
screen, but the returned screen can instantiate and configure any new views
7373
that it wants to. See the `hotkeys` DFHack logo widget for an example.
74-
75-
The ``overlay_trigger()`` command enables the activation of overlay widgets
76-
via the command line interface (CLI) or keybindings.
77-
For example, executing ``overlay trigger notes.map_notes add Kitchen``::
78-
79-
function MyOverlayWidget:overlay_trigger(arg1, arg2)
80-
if arg1 == 'add' then
81-
-- Add a new note to the map
82-
self:addSomething(arg2)
83-
elseif arg1 == 'delete' then
84-
self:deleteSomething(arg2)
74+
The ``overlay_trigger()`` function enables the activation of overlay widgets
75+
via the command line interface (CLI) or keybindings.
76+
77+
For example, executing ``overlay trigger notes.map_notes add Kitchen``::
78+
79+
function MyOverlayWidget:overlay_trigger(arg1, arg2)
80+
if arg1 == 'add' then
81+
-- Add a new note to the map
82+
self:addSomething(arg2)
83+
elseif arg1 == 'delete' then
84+
self:deleteSomething(arg2)
85+
end
8586
end
86-
end
8787

88-
This allows for dynamic updates to the game's UI overlays directly from the CLI.
88+
This allows for dynamic updates to UI overlays directly from the CLI.
8989

9090
If the widget can take up a variable amount of space on the screen, and you want
9191
the widget to adjust its position according to the size of its contents, you can

0 commit comments

Comments
 (0)