blob: 8958f62c6f84c66370bbae1acf8cd57cf080fbdc [file] [log] [blame]
MG Mud User88f12472016-06-24 23:31:02 +02001SetProp()
Zesstra953f9972017-02-18 15:37:36 +01002*********
MG Mud User88f12472016-06-24 23:31:02 +02003
MG Mud User88f12472016-06-24 23:31:02 +02004
Zesstra953f9972017-02-18 15:37:36 +01005FUNKTION
6========
MG Mud User88f12472016-06-24 23:31:02 +02007
Zesstrae959e722025-07-09 22:11:16 +02008 public mixed SetProp(string name, mixed Value,
9 int drop_priv = extern_call());
MG Mud User88f12472016-06-24 23:31:02 +020010
MG Mud User88f12472016-06-24 23:31:02 +020011
Zesstra953f9972017-02-18 15:37:36 +010012DEFINIERT IN
13============
MG Mud User88f12472016-06-24 23:31:02 +020014
Zesstra953f9972017-02-18 15:37:36 +010015 /std/thing/properties.c
16 /sys/thing/properties.h (Prototyp)
MG Mud User88f12472016-06-24 23:31:02 +020017
MG Mud User88f12472016-06-24 23:31:02 +020018
Zesstra953f9972017-02-18 15:37:36 +010019ARGUMENTE
20=========
MG Mud User88f12472016-06-24 23:31:02 +020021
Zesstra953f9972017-02-18 15:37:36 +010022 name - Property, deren Wert veraendert werden soll.
23 Value - Wert, auf den der Inhalt der Property gesetzt werden soll
Zesstrae959e722025-07-09 22:11:16 +020024 drop_priv - Interne Verwendung, wenn Aufrufer Privilegien abgibt,
25 z.B. objekt-interner Aufruf extern zaehlen soll.
Zesstra953f9972017-02-18 15:37:36 +010026
27
28BESCHREIBUNG
29============
30
31 Der Datenwert der Property 'name' wird auf den Wert 'Value' gesetzt.
32
33 Existiert eine F_SET_METHOD oder eine _set_'name'()-Methode fuer
34 diese Property, so wird diese aufgerufen und ihr 'Value' uebergeben.
35 Eine F_SET_METHOD hat dabei Vorrang vor _set_'name'(), d.h.
36 _set_'name'() wird nach erfolgreicher F_QUERY_METHOD nicht mehr
37 gerufen.
38
39 (Diese Methoden nutzen dann Set(), um den Datenwert der Property
40 'name' zu aendern. Teilweise werden aber auch interne Variablen so
41 oeffentlich gemacht und sind nicht in der ueber Set/Query verfuegbaren
42 Property 'name' abgelegt.)
43
44
45RUeCKGABEWERT
46=============
47
48 Der Wert, der nun in der Property gespeichert ist.
49 In der Regel ist das 'Value'. Wenn die Property ueber eine SET_METHOD
50 oder eine _set_'name'()-Funktion verfuegt und diese 'Value' aendert
51 (zum Beispiel, indem sie 'Value' an einen bestimmten erlaubten
52 Wertebereich anpasst), kann der Rueckgabewert jedoch auch veraendert
53 sein.
54
55 Wenn die Property nicht veraendert werden darf, wird -1 zurueckgegeben.
56
57
58BEISPIELE
59=========
60
61 // geben wir dem Zwerg eine Kurzbeschreibung
62 SetProp(P_SHORT, "Ein kleiner Zwerg");
63
64
65SIEHE AUCH
66==========
67
68 Aehnliches: QueryProp(L), Set(L), Query(L)
69 Generell: SetProperties(L), QueryProperties(L)
70 Konzept: properties, /std/thing/properties.c
MG Mud User88f12472016-06-24 23:31:02 +020071
7215.Dez 2004 Gloinson