blob: 9664be8f9fc62342ea2bc7446f6454ad034b799b [file] [log] [blame]
Zesstra953f9972017-02-18 15:37:36 +01001
MG Mud User88f12472016-06-24 23:31:02 +02002SetProp()
Zesstra953f9972017-02-18 15:37:36 +01003*********
MG Mud User88f12472016-06-24 23:31:02 +02004
MG Mud User88f12472016-06-24 23:31:02 +02005
Zesstra953f9972017-02-18 15:37:36 +01006FUNKTION
7========
MG Mud User88f12472016-06-24 23:31:02 +02008
Zesstra953f9972017-02-18 15:37:36 +01009 public mixed SetProp(string name, mixed Value);
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
24
25
26BESCHREIBUNG
27============
28
29 Der Datenwert der Property 'name' wird auf den Wert 'Value' gesetzt.
30
31 Existiert eine F_SET_METHOD oder eine _set_'name'()-Methode fuer
32 diese Property, so wird diese aufgerufen und ihr 'Value' uebergeben.
33 Eine F_SET_METHOD hat dabei Vorrang vor _set_'name'(), d.h.
34 _set_'name'() wird nach erfolgreicher F_QUERY_METHOD nicht mehr
35 gerufen.
36
37 (Diese Methoden nutzen dann Set(), um den Datenwert der Property
38 'name' zu aendern. Teilweise werden aber auch interne Variablen so
39 oeffentlich gemacht und sind nicht in der ueber Set/Query verfuegbaren
40 Property 'name' abgelegt.)
41
42
43RUeCKGABEWERT
44=============
45
46 Der Wert, der nun in der Property gespeichert ist.
47 In der Regel ist das 'Value'. Wenn die Property ueber eine SET_METHOD
48 oder eine _set_'name'()-Funktion verfuegt und diese 'Value' aendert
49 (zum Beispiel, indem sie 'Value' an einen bestimmten erlaubten
50 Wertebereich anpasst), kann der Rueckgabewert jedoch auch veraendert
51 sein.
52
53 Wenn die Property nicht veraendert werden darf, wird -1 zurueckgegeben.
54
55
56BEISPIELE
57=========
58
59 // geben wir dem Zwerg eine Kurzbeschreibung
60 SetProp(P_SHORT, "Ein kleiner Zwerg");
61
62
63SIEHE AUCH
64==========
65
66 Aehnliches: QueryProp(L), Set(L), Query(L)
67 Generell: SetProperties(L), QueryProperties(L)
68 Konzept: properties, /std/thing/properties.c
MG Mud User88f12472016-06-24 23:31:02 +020069
7015.Dez 2004 Gloinson