blob: c57822ff001b89f7d1f7889be2b76a059904bf96 [file] [log] [blame]
MG Mud User88f12472016-06-24 23:31:02 +02001GESCHUETZT
2SYNOPSIS
Zesstrad59c3892019-11-28 20:53:39 +01003 #include <functionlist.h>
4 #include <lpctypes.h>
MG Mud User88f12472016-06-24 23:31:02 +02005
Zesstra5481d492021-04-08 20:07:06 +02006 mixed *variable_list(object|lwobject obj,
7 int flags = RETURN_FUNCTION_NAME)
MG Mud User88f12472016-06-24 23:31:02 +02008
9BESCHREIBUNG
10 Liefert ein Array mit Informationen ueber die Variablen von <obj>.
11 Fuer jede Variable werden 1 bis 4 Werte in diesem Array gespeichert,
12 abhaengig von <flags>. Die Resultate werden in dieser Reihenfolge
13 im Array abgespeichert:
14 - der Name der Variablen
15 - die Flags der Variablen (siehe weiter unten)
Zesstrad59c3892019-11-28 20:53:39 +010016 - der Rueckgabetyp (gemaess <lpctypes.h>)
MG Mud User88f12472016-06-24 23:31:02 +020017 - der Wert der Variablen
18
19 <obj> kann als Objekt oder als Dateinamen uebergeben werden. Im
20 zweiten Fall versucht variable_list() nicht, das Objekt vor der
21 Verarbeitung zu laden.
22
23 Wenn <obj> nicht das aufrufende Objekt ist und der Wert der Variablen
24 abgefragt wird, erzeugt dies eine Schutzverletzung ("variable_list",
25 <obj>).
26
27 Mit <flags> wird festgelegt, welche Informationen ueber welche
Zesstrad59c3892019-11-28 20:53:39 +010028 Variablen abgefragt werden. Folgende Flags aus <functionlist.h>
MG Mud User88f12472016-06-24 23:31:02 +020029 koennen mit binaerem Oder kombiniert werden:
30
31 Auswahl der gesammelten Information:
32 RETURN_FUNCTION_NAME liefert den Namen der Variablen
33 RETURN_FUNCTION_FLAGS liefert die Flags der Variablen (s. unten)
34 RETURN_FUNCTION_TYPE liefert den Rueckgabetyp
35 RETURN_VARIABLE_VALUE liefert den Wert der Variablen
36
37 Auswahl der Variablen, die ausgewertet werden:
38 NAME_INHERITED schliesst geerbte Variablen aus
39 TYPE_MOD_STATIC schliesst "static" deklarierte Variablen aus
40 TYPE_MOD_NOSAVE schliesst "nosave" deklarierte Variablen aus
41 TYPE_MOD_PRIVATE schliesst "private" deklarierte Variablen aus
42 TYPE_MOD_PROTECTED schliesst "protected" deklarierte Variablen
43 aus
44 NAME_HIDDEN enthaelt Variablen, die geerbt wurden.
45
46 Die Flags der Variablen koennen die Auswahl-Flags enthalten und
47 zusaeztlich folgende Werte:
48 TYPE_MOD_VIRTUAL die Variable wurde virtuell geerbt
49 TYPE_MOD_NO_MASGK die Variable ist "nomask" deklariert
50 TYPE_MOD_PUBLIC die Variable ist "public" deklariert
51
Zesstrad59c3892019-11-28 20:53:39 +010052 All diese Flags sind in <functionlist.h>, die Rueckgabewerte in
53 <lpctypes.h> definiert.
MG Mud User88f12472016-06-24 23:31:02 +020054
Zesstrad59c3892019-11-28 20:53:39 +010055GESCHICHTE
56 Eingefuehrt in LDMud 3.2.10.
MG Mud User88f12472016-06-24 23:31:02 +020057
58SIEHE AUCH
59 inherit_list(E), functionlist(E), variable_exists(E)