]> jfr.im git - irc/hexchat/documentation.git/commitdiff
lua: Document users list
authorPatrick Griffis <redacted>
Sun, 18 Dec 2016 03:49:42 +0000 (22:49 -0500)
committerPatrick Griffis <redacted>
Sun, 18 Dec 2016 03:49:42 +0000 (22:49 -0500)
script_lua.rst

index d9ca23de216c7915108ba844fbb1c793d9be5e09..65aff55796d077d0d068e448ab908434fbd8f703 100644 (file)
@@ -225,6 +225,28 @@ List of possible values of ``list``, along with respective keys:
 +--------------+--------------------------------------------------------------------+
 
 
++------------+----------------------------------------------+
+| ``users``  | Current contexts users                       |
++------------+----------------------------------------------+
+| Name       | Description                                  |
++============+==============================================+
+| account    | Account name or ``nil``                      |
++------------+----------------------------------------------+
+| away       | Away message or ``nil``                      |
++------------+----------------------------------------------+
+| host       | Host name in form of ``user@host`` or ``nil``|
++------------+----------------------------------------------+
+| lasttalk   | Time stamp of last time they spoke           |
++------------+----------------------------------------------+
+| nick       | Nick name                                    |
++------------+----------------------------------------------+
+| prefix     | Prefix character such as ``@``               |
++------------+----------------------------------------------+
+| realname   | Real name                                    |
++------------+----------------------------------------------+
+| selected   | If they are selected in the userlist         |
++------------+----------------------------------------------+
+
 +------------+----------------------------------------------------------------------+
 | ``dcc``    | List of DCC file transfers                                           |
 +------------+----------------------------------------------------------------------+