blob: eefd84ebc02f07ddecec571254dd8628532fedcb [file] [log] [blame]
MG Mud User88f12472016-06-24 23:31:02 +02001FUNKTION:
2 int UnregisterHelperObject(object helper, int type);
3
4DEFINIERT IN:
5 /std/living/helpers.c
6
7ARGUMENTE:
8 object helper
9 Das Objekt, das als Hilfsobjekt deregistriert werden soll.
10 int type
11 Helfertyp, einer der in /sys/living/helpers.h definierten Typen:
12 - HELPER_TYPE_AERIAL fuer die Flug-/Segelunterstuetzung
13 - HELPER_TYPE_AQUATIC fuer Tauchunterstuetzung
14
15BESCHREIBUNG:
16 Das als Hilfsobjekt fuer bestimmte Aktivitaeten wie zum Beispiel Tauchen
17 oder Fliegen bei einem Lebewesen registrierte Objekt "helper" meldet
18 sich bei diesem ab.
19 Hinweis: fuer eine temporaer gueltige "Nicht-Zustaendigkeit" kaeme auch
20 in Frage, in dieser Zeit einfach "0" zurueckzugeben, statt sich
21 komplett abzumelden.
22
23RUECKGABEWERTE:
24 1 Objekt wurde erfolgreich ausgetragen (HELPER_SUCCESS)
25 -1 angegebenes Hilfsobjekt existiert nicht (HELPER_NO_CALLBACK_OBJECT)
26 -3 angegebenes Hilfsobjekt war gar nicht angemeldet
27 (HELPER_NOTHING_TO_UNREGISTER)
28
29BEISPIEL:
30 Eine luftgefuellte Blase hatte sich als Tauch-Helfer am Spieler
31 angemeldet, ist jetzt aber verbraucht und meldet sich daher ab:
32
33 // Austragen im Spielerobjekt
34 void BlaseAustragen() {
35 [...]
36 if ( TP->UnregisterHelperObject(ME, HELPER_TYPE_AQUATIC)
37 == HELPER_SUCCESS )
38 remove();
39 }
40
41SIEHE AUCH:
42 Funktionen: RegisterHelperObject()
43 Properties: P_HELPER_OBJECTS, P_AERIAL_HELPERS, P_AQUATIC_HELPERS
44 Sonstiges: /sys/living/helpers.h
45
4619.02.2013 Arathorn
47