diff options
author | Guido Cella <guido@guidocella.xyz> | 2024-01-02 18:58:32 +0100 |
---|---|---|
committer | Dudemanguy <random342@airmail.cc> | 2024-01-13 02:53:08 +0000 |
commit | 871f7a152a3f0b3561a627d21f7417d10ac9c25c (patch) | |
tree | c793a9c700b2e52b2a896234b679af5ec9c3f006 /DOCS/man/javascript.rst | |
parent | 2dd3951a9c05e7a4fc0a614f13de1bfe0e7f132f (diff) | |
download | mpv-871f7a152a3f0b3561a627d21f7417d10ac9c25c.tar.bz2 mpv-871f7a152a3f0b3561a627d21f7417d10ac9c25c.tar.xz |
scripting: add mp.input
This lets scripts get textual input from the user using console.lua.
Diffstat (limited to 'DOCS/man/javascript.rst')
-rw-r--r-- | DOCS/man/javascript.rst | 23 |
1 files changed, 17 insertions, 6 deletions
diff --git a/DOCS/man/javascript.rst b/DOCS/man/javascript.rst index bdbb04b198..0edb01f674 100644 --- a/DOCS/man/javascript.rst +++ b/DOCS/man/javascript.rst @@ -27,16 +27,17 @@ otherwise, the documented Lua options, script directories, loading, etc apply to JavaScript files too. Script initialization and lifecycle is the same as with Lua, and most of the Lua -functions at the modules ``mp``, ``mp.utils``, ``mp.msg`` and ``mp.options`` are -available to JavaScript with identical APIs - including running commands, -getting/setting properties, registering events/key-bindings/hooks, etc. +functions in the modules ``mp``, ``mp.utils``, ``mp.msg``, ``mp.options`` and +``mp.input`` are available to JavaScript with identical APIs - including running +commands, getting/setting properties, registering events/key-bindings/hooks, +etc. Differences from Lua -------------------- -No need to load modules. ``mp``, ``mp.utils``, ``mp.msg`` and ``mp.options`` -are preloaded, and you can use e.g. ``var cwd = mp.utils.getcwd();`` without -prior setup. +No need to load modules. ``mp``, ``mp.utils``, ``mp.msg``, ``mp.options`` and +``mp.input`` are preloaded, and you can use e.g. ``var cwd = +mp.utils.getcwd();`` without prior setup. Errors are slightly different. Where the Lua APIs return ``nil`` for error, the JavaScript ones return ``undefined``. Where Lua returns ``something, error`` @@ -195,6 +196,16 @@ meta-paths like ``~~/foo`` (other JS file functions do expand meta paths). ``mp.options.read_options(obj [, identifier [, on_update]])`` (types: string/boolean/number) +``mp.input.get(obj)`` (LE) + +``mp.input.terminate()`` + +``mp.input.log(message, style)`` + +``mp.input.log_error(message)`` + +``mp.input.set_log(log)`` + Additional utilities -------------------- |