diff options
| author | wm4 <wm4@nowhere> | 2014-03-17 18:27:25 +0100 |
|---|---|---|
| committer | wm4 <wm4@nowhere> | 2014-03-17 18:27:25 +0100 |
| commit | 780f172a8a09bbd4a1ce5a582ba26b5737788d3b (patch) | |
| tree | 88ea6f60726ce9b75d49137cfd98b3e4ed143863 /DOCS/man/en/lua.rst | |
| parent | 637664d95ad5e2ad72b91998dc4685bf0fe6cdeb (diff) | |
| download | mpv-780f172a8a09bbd4a1ce5a582ba26b5737788d3b.tar.bz2 mpv-780f172a8a09bbd4a1ce5a582ba26b5737788d3b.tar.xz | |
lua: rename mp.register_script_command() to mp.register_script_message()
More consistent naming.
Diffstat (limited to 'DOCS/man/en/lua.rst')
| -rw-r--r-- | DOCS/man/en/lua.rst | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/DOCS/man/en/lua.rst b/DOCS/man/en/lua.rst index fc7606a5fc..2cf485ba35 100644 --- a/DOCS/man/en/lua.rst +++ b/DOCS/man/en/lua.rst @@ -169,7 +169,7 @@ The ``mp`` module is preloaded, although it can be loaded manually with internally. Internally, key bindings are dispatched via the ``script_message_to`` input - command and ``mp.register_script_command``. + command and ``mp.register_script_message``. Trying to map multiple commands to a key will essentially prefer a random binding, while the other bindings are not called. It is guaranteed that @@ -298,17 +298,17 @@ The ``mp`` module is preloaded, although it can be loaded manually with the ``log-message`` event. See the description of this event for details. The level is a string, see ``msg.log`` for allowed log levels. -``mp.register_script_command(name, fn)`` +``mp.register_script_message(name, fn)`` This is a helper to dispatch ``script_message`` or ``script_message_to`` invocations to Lua functions. ``fn`` is called if ``script_message`` or ``script_message_to`` (with this script as destination) is run with ``name`` as first parameter. The other parameters are passed to ``fn``. - If a command with the given name is already registered, it's overwritten. + If a message with the given name is already registered, it's overwritten. Used by ``mp.add_key_binding``, so be careful about name collisions. -``mp.unregister_script_command(name)`` - Undo a previous registration with ``mp.register_script_command``. Does +``mp.unregister_script_message(name)`` + Undo a previous registration with ``mp.register_script_message``. Does nothing if the ``name`` wasn't registered. mp.msg functions |