summaryrefslogtreecommitdiffstats
path: root/DOCS/man/input.rst
diff options
context:
space:
mode:
authorDudemanguy <random342@airmail.cc>2023-09-21 11:35:14 -0500
committerDudemanguy <random342@airmail.cc>2023-11-22 16:29:43 +0000
commit86b498ecc0e6276bb905df57f479d0506b45ba53 (patch)
tree399cea9a9207eea5e8298f072768550ec1356c13 /DOCS/man/input.rst
parent5220725ca506bc40f1f0c3f0507fa337605f1dba (diff)
downloadmpv-86b498ecc0e6276bb905df57f479d0506b45ba53.tar.bz2
mpv-86b498ecc0e6276bb905df57f479d0506b45ba53.tar.xz
player: remove shared-script-properties property
This property was never encouraged. The manual even stated that "You should avoid using it, unless you absolutely have to." Since we now have user-data which is superior in every single way and replaces this, delete this property. The manual also has threatened people for years with the line "It's a makeshift solution which could go away any time (for example, when a better solution becomes available)." We were nice and deprecated it in 1d00aee8e191c9689a20e67e3d6dfd2af6ad2588 for a while to give script authors some time to update. Let's remove it for good now.
Diffstat (limited to 'DOCS/man/input.rst')
-rw-r--r--DOCS/man/input.rst24
1 files changed, 0 insertions, 24 deletions
diff --git a/DOCS/man/input.rst b/DOCS/man/input.rst
index 8dbf58b973..a314bfb5ed 100644
--- a/DOCS/man/input.rst
+++ b/DOCS/man/input.rst
@@ -3328,36 +3328,12 @@ Property list
``current-ao``
Current audio output driver (name as used with ``--ao``).
-``shared-script-properties`` (RW)
- This is a key/value map of arbitrary strings shared between scripts for
- general use. The player itself does not use any data in it (although some
- builtin scripts may). The property is not preserved across player restarts.
-
- This is very primitive, inefficient, and annoying to use. It's a makeshift
- solution which could go away any time (for example, when a better solution
- becomes available). This is also why this property has an annoying name. You
- should avoid using it, unless you absolutely have to.
-
- Lua scripting has helpers starting with ``utils.shared_script_property_``.
- They are undocumented because you should not use this property. If you still
- think you must, you should use the helpers instead of the property directly.
-
- You are supposed to use the ``change-list`` command to modify the contents.
- Reading, modifying, and writing the property manually could data loss if two
- scripts update different keys at the same time due to lack of
- synchronization. The Lua helpers take care of this.
-
- (There is no way to ensure synchronization if two scripts try to update the
- same key at the same time.)
-
``user-data`` (RW)
This is a recursive key/value map of arbitrary nodes shared between clients for
general use (i.e. scripts, IPC clients, host applications, etc).
The player itself does not use any data in it (although some builtin scripts may).
The property is not preserved across player restarts.
- This is a more powerful replacement for ``shared-script-properties``.
-
Sub-paths can be accessed directly; e.g. ``user-data/my-script/state/a`` can be
read, written, or observed.