Gitiles
Code Review Sign In
gerrit.morgengrauen.info / mudlib-public / d7d25acba039d701566ea92a8c31c6157e7dbdcb / . / doc / lfun / remove
blob: 78d8ada4504d041b7794f45573999551c7f65a4b [file] [log] [blame]
Zesstra953f9972017-02-18 15:37:36 +0100[diff] [blame]1
MG Mud User88f12472016-06-24 23:31:02 +0200[diff] [blame]2remove()
Zesstra953f9972017-02-18 15:37:36 +0100[diff] [blame]3********
MG Mud User88f12472016-06-24 23:31:02 +0200[diff] [blame]4
MG Mud User88f12472016-06-24 23:31:02 +0200[diff] [blame]5
Zesstra953f9972017-02-18 15:37:36 +0100[diff] [blame]6FUNKTION
7========
MG Mud User88f12472016-06-24 23:31:02 +0200[diff] [blame]8
Zesstra953f9972017-02-18 15:37:36 +0100[diff] [blame]9 varargs int remove(int silent);
MG Mud User88f12472016-06-24 23:31:02 +0200[diff] [blame]10
MG Mud User88f12472016-06-24 23:31:02 +0200[diff] [blame]11
Zesstra953f9972017-02-18 15:37:36 +0100[diff] [blame]12DEFINIERT IN
13============
MG Mud User88f12472016-06-24 23:31:02 +0200[diff] [blame]14
Zesstrabfab6ac2018-08-29 22:36:57 +0200[diff] [blame]15 /std/thing/moving.c /std/living/moving.c /std/room/moving.c
16 /std/unit.c
MG Mud User88f12472016-06-24 23:31:02 +0200[diff] [blame]17
MG Mud User88f12472016-06-24 23:31:02 +0200[diff] [blame]18
Zesstra953f9972017-02-18 15:37:36 +0100[diff] [blame]19ARGUMENTE
20=========
21
Zesstrabfab6ac2018-08-29 22:36:57 +0200[diff] [blame]22 * silent: Falls ungleich 0, so werden beim Zerstoeren keine
23 Meldungen ausgegeben.
Zesstra953f9972017-02-18 15:37:36 +0100[diff] [blame]24
25
26BESCHREIBUNG
27============
28
Zesstrabfab6ac2018-08-29 22:36:57 +0200[diff] [blame]29 Die meisten Objekte zerstoeren sich durch den Aufruf von remove()
30 selbst.
31
32 Unitobjekte reduzieren P_AMOUNT um U_REQ Einheiten. Will man ein
33 Unit- Objekt vollstaendig zerstoeren, ist vor dem Aufruf von
34 remove() U_REQ auf P_AMOUNT zu setzen. Wird durch remove() P_AMOUNT
35 0, wird das Objekt natuerlich zerstoert.
36
37 Durch Ueberladen dieser Funktion kann man diesen Vorgang noch durch
38 die Ausgabe von Meldungen kommentieren, oder irgendwelche Daten
39 abspeichern, oder das Zerstoeren ganz verhindern (auf diesem Weg...
40 Mit destruct() kann das Objekt immer noch direkt zerstoert werden!)
41
42 ACHTUNG: Wenn ein Objekt durch remove() nicht zerstoert wird,
43 koennte das einen Grund haben. Bitte nicht einfach destruct()
44 verwenden, das ist nur fuer Notfaelle wie ein buggendes remove().
Zesstra953f9972017-02-18 15:37:36 +0100[diff] [blame]45
46
47RUeCKGABEWERT
48=============
49
50 1, wenn sich das Objekt erfolgreich selbst zerstoert hat, sonst 0.
51
52
53BEMERKUNGEN
54===========
55
Zesstrabfab6ac2018-08-29 22:36:57 +0200[diff] [blame]56 Nach einem erfolgreichen ::remove() gelten die selben
57 Einschraenkungen wie nach einem destruct()!
Zesstra953f9972017-02-18 15:37:36 +0100[diff] [blame]58
59
60SIEHE AUCH
61==========
62
Zesstrabfab6ac2018-08-29 22:36:57 +0200[diff] [blame]63 "../efun/destruct", *U_REQ*, *P_AMOUNT*
Zesstra953f9972017-02-18 15:37:36 +0100[diff] [blame]64
Zesstrabfab6ac2018-08-29 22:36:57 +0200[diff] [blame]65Letzte Aenderung: 24.07.2018, Bugfix