Skip to content

Commit

Permalink
DOCS/man/lua.rst: document scale for mp.add_key_binding()
Browse files Browse the repository at this point in the history
  • Loading branch information
na-na-hi committed Nov 15, 2024
1 parent e838a56 commit 49284a7
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions DOCS/man/lua.rst
Original file line number Diff line number Diff line change
Expand Up @@ -323,6 +323,10 @@ The ``mp`` module is preloaded, although it can be loaded manually with
If set to ``true``, enables key repeat for this specific binding.
This option only makes sense when ``complex`` is not set to ``true``.

``scalable``
If set to ``true``, enables key scaling for this specific binding.
This option only makes sense when ``complex`` is set to ``true``.

``complex``
If set to ``true``, then ``fn`` is called on key down, repeat and up
events, with the first argument being a table. This table has the
Expand Down Expand Up @@ -350,6 +354,10 @@ The ``mp`` module is preloaded, although it can be loaded manually with
description of ``script-binding`` command for details (this
field is equivalent to the 5th argument).

``scale``
The scale of the key, such as the ones produced by ``WHEEL_*``
keys. The scale is 1 if the key is nonscalable.

Internally, key bindings are dispatched via the ``script-message-to`` or
``script-binding`` input commands and ``mp.register_script_message``.

Expand Down

0 comments on commit 49284a7

Please sign in to comment.