diff options
Diffstat (limited to 'DOCS/man/lua.rst')
| -rw-r--r-- | DOCS/man/lua.rst | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/DOCS/man/lua.rst b/DOCS/man/lua.rst index 63aaca4dbd..d8791e7381 100644 --- a/DOCS/man/lua.rst +++ b/DOCS/man/lua.rst @@ -2,7 +2,7 @@ LUA SCRIPTING ============= mpv can load Lua scripts. Scripts in ``~/.mpv/lua/`` will be loaded on program -start, or if passed to ``--lua``. mpv provides the builtin module ``mp``, which +start, or if passed to ``--lua``. mpv provides the built-in module ``mp``, which provides functions to send commands to the mpv core and to retrieve information about playback state, user settings, file information, and so on. @@ -98,9 +98,9 @@ The ``mp`` module is preloaded, although it can be loaded manually with will always result in a string. ``mp.get_property_bool(name [,def])`` - Similar to ``mp.get_property``, but return the property value as boolean. + Similar to ``mp.get_property``, but return the property value as Boolean. - Returns a boolean on success, or ``def, error`` on error. + Returns a Boolean on success, or ``def, error`` on error. ``mp.get_property_number(name [,def])`` Similar to ``mp.get_property``, but return the property value as number. @@ -113,7 +113,7 @@ The ``mp`` module is preloaded, although it can be loaded manually with ``mp.get_property_native(name [,def])`` Similar to ``mp.get_property``, but return the property value using the best - Lua type for the property. Most time, this will return a string, boolean, + Lua type for the property. Most time, this will return a string, Boolean, or number. Some properties (for example ``chapter-list``) are returned as tables. @@ -128,7 +128,7 @@ The ``mp`` module is preloaded, although it can be loaded manually with ``mp.set_property_bool(name, value)`` Similar to ``mp.set_property``, but set the given property to the given - boolean value. + Boolean value. ``mp.set_property_number(name, value)`` Similar to ``mp.set_property``, but set the given property to the given @@ -163,7 +163,7 @@ The ``mp`` module is preloaded, although it can be loaded manually with (e.g. ``ctrl+a``). After calling this function, key presses will cause the function ``fn`` to - be called (unless the user overmapped the key with another binding). + be called (unless the user remapped the key with another binding). The ``name`` argument should be a short symbolic string. It allows the user to remap the key binding via input.conf using the ``script_message`` @@ -201,7 +201,7 @@ The ``mp`` module is preloaded, although it can be loaded manually with This will print the message when the key ``y`` is pressed. (``x`` will - still work, unless the user overmaps it.) + still work, unless the user remaps it.) You can also explicitly send a message to a named script only. Assume the above script was using the filename ``fooscript.lua``: @@ -315,7 +315,7 @@ The ``mp`` module is preloaded, although it can be loaded manually with ``oneshot`` (RW) Whether the timer is periodic (``false``) or fires just once (``true``). This value is used when the timer expires (but before - the timer calback function fn is run). + the timer callback function fn is run). ``mp.get_opt(key)`` @@ -377,7 +377,7 @@ are useful only in special situations. control what the Lua script does (instead of being called by the default event loop), you can set the global variable ``mp_event_loop`` to your own function running the event loop. From your event loop, you should call - ``mp.dispatch_events()`` to unqueue and dispatch mpv events. + ``mp.dispatch_events()`` to dequeue and dispatch mpv events. If the ``allow_wait`` parameter is set to ``true``, the function will block until the next event is received or the next timer expires. Otherwise (and |