summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorwm4 <wm4@nowhere>2019-11-21 22:30:45 +0100
committerwm4 <wm4@nowhere>2019-11-22 01:15:08 +0100
commita394d9e3aeadb0a2dedd7c15d8322252742b2fe4 (patch)
tree6adad49c3566be2a6a0b93479979ac86851e09e9
parent0a6c09b96f17fa0247d3fe53ff396f61e5868d0c (diff)
downloadmpv-a394d9e3aeadb0a2dedd7c15d8322252742b2fe4.tar.bz2
mpv-a394d9e3aeadb0a2dedd7c15d8322252742b2fe4.tar.xz
manpage: improve "complex" key binding list of table entries
-rw-r--r--DOCS/man/lua.rst19
1 files changed, 13 insertions, 6 deletions
diff --git a/DOCS/man/lua.rst b/DOCS/man/lua.rst
index 5f9525d6b6..13cd3dbad0 100644
--- a/DOCS/man/lua.rst
+++ b/DOCS/man/lua.rst
@@ -251,12 +251,19 @@ The ``mp`` module is preloaded, although it can be loaded manually with
``complex``
If set to ``true``, then ``fn`` is called on both key up and down
events (as well as key repeat, if enabled), with the first
- argument being a table. This table has an ``event`` entry, which
- is set to one of the strings ``down``, ``repeat``, ``up`` or
- ``press`` (the latter if key up/down can't be tracked). The
- ``is_mouse`` entry tells whether the event was caused by a mouse
- button. The ``key_name`` entry contains the name of they key that
- triggered this, or ``nil`` if unknown or invoked artificially.
+ argument being a table. This table has the following entries (and
+ may contain undocumented ones):
+
+ ``event``
+ Set to one of the strings ``down``, ``repeat``, ``up`` or
+ ``press`` (the latter if key up/down can't be tracked).
+
+ ``is_mouse``
+ Boolean Whether the event was caused by a mouse button.
+
+ ``key_name``
+ The name of they key that triggered this, or ``nil`` if unknown
+ or invoked artificially.
Internally, key bindings are dispatched via the ``script-message-to`` or
``script-binding`` input commands and ``mp.register_script_message``.