blob: 7c124fb739e4f3b0476bc60612b9f98746184612 [file] [log] [blame]
Zesstra953f9972017-02-18 15:37:36 +01001
2clean_up()
3**********
4
5
6FUNKTION
7========
8
9 int clean_up(int ref);
10
11
12DEFINIERT IN
13============
14
15 /std/room.c
16 man kann die Funktion jedoch auch in beliebigen Objekten selbst
17 definieren.
18
19
20ARGUMENTE
21=========
22
23 ref
24 + 0 bei gecloneten Objekten
25 + 1 bei einfachen geladenen Objekten
26 + >1 bei Objekten, die geerbt wurden oder als Blueprint dienen
27 + <0, wenn clean_up() von aussen aufgerufen wurde (das muss man
28 selbst beachten!)
29
30
31BESCHREIBUNG
32============
33
34 Wenn ein Objekt seit langer Zeit nicht mehr benutzt wurde, kann es sich
35 hier selbst zerstoeren. Das sollte das Objekt allerdings nur tun, wenn
36 ref kleiner oder gleich 1 ist.
37
38
39RUeCKGABEWERT
40=============
41
42 Der Rueckgabewert hat nur dann eine Bedeutung, wenn sich das Objekt
43 nicht selbst zerstoert hat. Wird 0 zurueckgegeben, so wird clean_up()
44 erst dann wieder aufgerufen, nachdem das Objekt aus- und wieder
45 eingeswappt wurde.
46
47 Ein Rueckgabewert ungleich 0 zeigt an, dass das Objekt sich
48 wahrscheinlich in der naechsten clean_up()-Runde zerstoeren kann, wenn
49 in der Zwischenzeit zB. noch einmal reset() aufgerufen wurde.
50
51
52BEMERKUNGEN
53===========
54
55 Standardmaessig definieren nur Raeume clean_up().
56
57 Die Zeiten zwischen zwei Aufrufen von clean_up() betragen momentan
58 einen Tag (86400 Sekunden).
59
60
61SIEHE AUCH
62==========
63
64 reset(), P_NEVER_CLEAN
65 memory
66
6721. Maerz 2004 Gloinson