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