blob: b2602fbb31de56e7480e37620b2802f977a1a23b [file] [log] [blame]
MG Mud User88f12472016-06-24 23:31:02 +02001SetProp()
2FUNKTION:
3 public mixed SetProp(string name, mixed Value);
4
5DEFINIERT IN:
6 /std/thing/properties.c
7 /sys/thing/properties.h (Prototyp)
8
9ARGUMENTE:
10 name - Property, deren Wert veraendert werden soll.
11 Value - Wert, auf den der Inhalt der Property gesetzt werden soll
12
13BESCHREIBUNG:
14 Der Datenwert der Property 'name' wird auf den Wert 'Value' gesetzt.
15
16 Existiert eine F_SET_METHOD oder eine _set_'name'()-Methode fuer
17 diese Property, so wird diese aufgerufen und ihr 'Value' uebergeben.
18 Eine F_SET_METHOD hat dabei Vorrang vor _set_'name'(), d.h.
19 _set_'name'() wird nach erfolgreicher F_QUERY_METHOD nicht mehr
20 gerufen.
21
22 (Diese Methoden nutzen dann Set(), um den Datenwert der Property
23 'name' zu aendern. Teilweise werden aber auch interne Variablen so
24 oeffentlich gemacht und sind nicht in der ueber Set/Query verfuegbaren
25 Property 'name' abgelegt.)
26
27RUeCKGABEWERT:
28 Der Wert, der nun in der Property gespeichert ist.
29 In der Regel ist das 'Value'. Wenn die Property ueber eine SET_METHOD
30 oder eine _set_'name'()-Funktion verfuegt und diese 'Value' aendert
31 (zum Beispiel, indem sie 'Value' an einen bestimmten erlaubten
32 Wertebereich anpasst), kann der Rueckgabewert jedoch auch veraendert
33 sein.
34
35 Wenn die Property nicht veraendert werden darf, wird -1 zurueckgegeben.
36
37BEISPIELE:
38 // geben wir dem Zwerg eine Kurzbeschreibung
39 SetProp(P_SHORT, "Ein kleiner Zwerg");
40
41SIEHE AUCH:
42 Aehnliches: QueryProp(L), Set(L), Query(L)
43 Generell: SetProperties(L), QueryProperties(L)
44 Konzept: properties, /std/thing/properties.c
45
4615.Dez 2004 Gloinson
47