blob: f65afbc323c1e9eae82c5192fb29640a96dd7c60 [file] [log] [blame]
Zesstra953f9972017-02-18 15:37:36 +01001UnregisterHelperObject()
2************************
MG Mud User88f12472016-06-24 23:31:02 +02003
MG Mud User88f12472016-06-24 23:31:02 +02004
Zesstra953f9972017-02-18 15:37:36 +01005FUNKTION
6========
MG Mud User88f12472016-06-24 23:31:02 +02007
Zesstra953f9972017-02-18 15:37:36 +01008 int UnregisterHelperObject(object helper, int type);
MG Mud User88f12472016-06-24 23:31:02 +02009
MG Mud User88f12472016-06-24 23:31:02 +020010
Zesstra953f9972017-02-18 15:37:36 +010011DEFINIERT IN
12============
MG Mud User88f12472016-06-24 23:31:02 +020013
Zesstra953f9972017-02-18 15:37:36 +010014 /std/living/helpers.c
15
16
17ARGUMENTE
18=========
19
20 object helper
21 Das Objekt, das als Hilfsobjekt deregistriert werden soll.
22 int type
23 Helfertyp, einer der in /sys/living/helpers.h definierten Typen:
24 - HELPER_TYPE_AERIAL fuer die Flug-/Segelunterstuetzung
25 - HELPER_TYPE_AQUATIC fuer Tauchunterstuetzung
26
27
28BESCHREIBUNG
29============
30
31 Das als Hilfsobjekt fuer bestimmte Aktivitaeten wie zum Beispiel Tauchen
32 oder Fliegen bei einem Lebewesen registrierte Objekt "helper" meldet
33 sich bei diesem ab.
34 Hinweis: fuer eine temporaer gueltige "Nicht-Zustaendigkeit" kaeme auch
35 in Frage, in dieser Zeit einfach "0" zurueckzugeben, statt sich
36 komplett abzumelden.
37
38
39RUECKGABEWERTE
40==============
41
42 1 Objekt wurde erfolgreich ausgetragen (HELPER_SUCCESS)
43 -1 angegebenes Hilfsobjekt existiert nicht (HELPER_NO_CALLBACK_OBJECT)
44 -3 angegebenes Hilfsobjekt war gar nicht angemeldet
45 (HELPER_NOTHING_TO_UNREGISTER)
46
47
48BEISPIEL
49========
50
51 Eine luftgefuellte Blase hatte sich als Tauch-Helfer am Spieler
52 angemeldet, ist jetzt aber verbraucht und meldet sich daher ab:
53
54 // Austragen im Spielerobjekt
55 void BlaseAustragen() {
56 [...]
57 if ( TP->UnregisterHelperObject(ME, HELPER_TYPE_AQUATIC)
58 == HELPER_SUCCESS )
59 remove();
60 }
61
62
63SIEHE AUCH
64==========
65
66 Funktionen: RegisterHelperObject()
67 Properties: P_HELPER_OBJECTS, P_AERIAL_HELPERS, P_AQUATIC_HELPERS
68 Sonstiges: /sys/living/helpers.h
MG Mud User88f12472016-06-24 23:31:02 +020069
7019.02.2013 Arathorn