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