blob: 0917d1cea82fb5d78126af153014792a9c04edbf [file] [log] [blame]
Zesstra953f9972017-02-18 15:37:36 +01001UnregisterEvent()
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 UnregisterEvent(string eid, object listener);
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 /p/daemon/eventd.c
MG Mud User88f12472016-06-24 23:31:02 +020015
MG Mud User88f12472016-06-24 23:31:02 +020016
Zesstra953f9972017-02-18 15:37:36 +010017DEKLARIERT IN
18=============
MG Mud User88f12472016-06-24 23:31:02 +020019
Zesstra953f9972017-02-18 15:37:36 +010020 /sys/events.h
21
22
23ARGUMENTE
24=========
25
26 string eid,
27 Die ID des Events, vom dem man sich abmelden will.
28 object listener,
29 Das Objekt, das als Lauscher ausgetragen werden soll.
30
31
32BESCHREIBUNG
33============
34
35 Das Objekt 'listener' wird als Lauscher dieses Events ausgetragen. Ab
36 diesem Moment wird es bei Events vom Typ 'eid' nicht mehr informiert.
37
38 Hat der Event 'eid' im Anschluss keine Lauscher mehr, wird er implizit
39 geloescht.
40
41
42RUeCKGABEWERT
43=============
44
45 1 fuer Erfolg, <=0 fuer Misserfolg.
46 1 - Erfolg, 'listener' wurde eingetragen.
47 -1 - falsche Argumente uebergeben
48 -2 - 'listener' ist nicht fuer 'eid' registriert.
49
50
51BEMERKUNGEN
52===========
53
54 Wenn sich ein Objekt vor Zerstoerung nicht abmeldet, wird es ggf. beim
55 naechsten Auftreten von 'eid' automatisch ausgetragen.
56 Falls Blueprints nach Neuladen nicht automatisch angemeldet sein sollen,
57 sollten sie sich im remove() explizit abmelden.
58
59
60BEISPIELE
61=========
62
63 1. Ein Objekt moechte nicht mehr ueber Spielertode informiert werden:
64 EVENTD->UnregisterEvent(EVT_LIB_PLAYER_DEATH, this_object());
65
66 2. Ein Objekt moechte sich bei Zerstoerung abmelden:
67 varargs int remove(int silent) {
68 ...
69 EVENTD->UnregisterEvent("zesstra_vulkanausbruch",this_object());
70 }
71
72
73SIEHE AUCH
74==========
75
76 events, eventd, UnregisterEvent(), RegisterEvent()
77
MG Mud User88f12472016-06-24 23:31:02 +020078Last modified: 15.08.2007, Zesstra