| Zesstra | 953f997 | 2017-02-18 15:37:36 +0100 | [diff] [blame] | 1 | |
| 2 | UnregisterHelperObject() |
| 3 | ************************ |
| 4 | |
| 5 | |
| 6 | FUNKTION |
| 7 | ======== |
| 8 | |
| 9 | int UnregisterHelperObject(object helper, int type); |
| 10 | |
| 11 | |
| 12 | DEFINIERT IN |
| 13 | ============ |
| 14 | |
| 15 | /std/living/helpers.c |
| 16 | |
| 17 | |
| 18 | ARGUMENTE |
| 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 | |
| 29 | BESCHREIBUNG |
| 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 | |
| 40 | RUECKGABEWERTE |
| 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 | |
| 49 | BEISPIEL |
| 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 | |
| 64 | SIEHE AUCH |
| 65 | ========== |
| 66 | |
| 67 | Funktionen: RegisterHelperObject() |
| 68 | Properties: P_HELPER_OBJECTS, P_AERIAL_HELPERS, P_AQUATIC_HELPERS |
| 69 | Sonstiges: /sys/living/helpers.h |
| 70 | |
| 71 | 19.02.2013 Arathorn |