New master lfun query_userlist().
Introduces a new master function for querying the
userlist (i.e. data from the secure savefiles).
Contrary to get_userinfo() it returns specific
records from the userlist instead of a whole array.
The existing get_userinfo() function had a very
ill-defined interface. It returned an array which
was usually accessed by the *internal* symbolic
constants from userinfo.h plus an offset. These
could therefore never be changed internally. It
was also completely undocumented.
Also removes the now obsolete query_player_object()
which was also undocumented and used at only two
places (one being the master itself).
Change-Id: I5948deb69fd750dadd746f9089ba9ee9170c8a81
diff --git a/doc/sphinx/lfun/query_userlist.rst b/doc/sphinx/lfun/query_userlist.rst
new file mode 100644
index 0000000..58f1f14
--- /dev/null
+++ b/doc/sphinx/lfun/query_userlist.rst
@@ -0,0 +1,60 @@
+query_userlist()
+================
+
+FUNKTION
+--------
+
+ public mixed query_userlist(string user, int prop)
+
+DEFINIERT IN
+------------
+
+ /secure/master/userinfo.c
+
+ARGUMENTE
+---------
+
+ user
+ UID des abzufragenden Users
+ prop
+ Datum aus der Userliste, welches abgefragt werden soll
+
+BESCHREIBUNG
+------------
+
+ Aus der Userliste des MG wird eine der folgenden Informationen ueber den
+ Spieler <user> abgefragt:
+
+ USER_LEVEL (int)
+ Magierlevel (1 fuer Seher)
+ USER_DOMAIN (string*)
+ Liste der Regionen, in der der Magier RM ist
+ USER_OBJECT (string)
+ Shell des Spielers
+ USER_CREATION_DATE (int)
+ Zeit des ersten Logins
+ USER_GUILD (string*)
+ Gilden, fuer welche die Spielerin Gildenmagierin ist
+ USER_EKTIPS (string)
+ Fuer welche EKs hat der Spieler einen Tip erhalten? Rueckgabe als
+ Bitstring, in welchem die entsprechenden Bits gesetzt sind.
+ USER_FPTIPS (string)
+ Fuer welche FPs hat der Spieler einen Tip erhalten? Rueckgabe als
+ Bitstring, in welchem die entsprechenden Bits gesetzt sind.
+ USER_UIDS_TO_TAKE_CARE (string*)
+ UIDs, fuer welche die Magierin zustaendig ist. Hierbei sind nur explizit
+ eingetragene in diesem Array, nicht welche, fuer sie implizit kraft ihres
+ Amtes zustaendig ist (z.B. als GM oder RM).
+
+ Die o.a. Konstanten sind in <userinfo.h> definiert.
+
+ Wenn der Spieler nicht existiert, wird 0 zurueckgegeben. Ein nicht
+ unterstuetztes <prop> loest einen Laufzeitfehler aus.
+
+SIEHE AUCH
+----------
+
+ :doc:`find_userinfo`
+
+Last modified: 21.01.2020, Zesstra
+