blob: 8bc5d8d75b4d5a4487723c5c4c34e73e3f8d7b85 [file] [log] [blame]
MG Mud User88f12472016-06-24 23:31:02 +02001
2FUNKTION:
3 int RegisterEvent(string eid, string fun, object listener);
4
5DEFINIERT IN:
6 /p/daemon/eventd.c
7DEKLARIERT IN:
8 /sys/events.h
9
10ARGUMENTE:
11 string eid,
12 Die ID des Events, fuer den man sich registrieren will. Da dieser
13 String fuer alle Events jeweils eindeutig sein muss, empfiehlt es sich,
14 fuer eigene Events z.B. als Praefix den eigenen Magiernamen zu nehmen,
15 z.B. "zesstra_vulkanausbruch".
16 ACHTUNG: IDs, die mit '_evt_lib_' beginnen, sind AUSSCHLIESSLICH der
17 Mudlib vorbehalten!
18 string fun,
19 Name der Funktion, die im Objekt listener bei Auftreten des Events
20 gerufen werden soll.
21 object listener,
22 Das Objekt, das als Lauscher fuer diesen Event registriert werden soll.
23
24BESCHREIBUNG:
25 Das Objekt 'listener' wird als Lauscher dieses Events registriert. Ab
26 diesem Moment wird immer dann, wenn ein Event mit der ID 'eid' ausgeloest
27 wird, in 'listener' die Funktion 'fun' aufgerufen (zeitverzoegert, meist
28 0-2s).
29
30 Die Funktion wird dabei immer mit 3 Argumenten aufgerufen:
31 listener->fun(eid, triggerob, data);
32 Hierbei ist 'eid' die jeweilige Event-ID und 'triggerob' ist das Objekt,
33 welches den Event ausloeste.
34 'data' kann jeder LPC-Datentyp sein und enthaelt die Daten, die das
35 triggernde Objekt an alle Listener uebermitteln will (damit sind Datentyp
36 und Inhalt komplett abhaengig vom Event!)
37
38 Existiert bisher noch kein Event mit der ID 'eid', wird implizit ein
39 neuer Event erstellt, der erstmal nur das sich gerade registrierende
40 Objekt als Lauscher hat.
41
42
43RUeCKGABEWERT:
44 1 fuer Erfolg, <=0 fuer Misserfolg.
45 1 - Erfolg, 'listener' wurde eingetragen.
46 -1 - falsche Argumente wurden uebergeben
47 -2 - nicht-oeffentlicher Event und 'listener' wurde nicht fuer diesen
48 Event freigegeben (momentan gibt es noch keine nicht-oeffentlichen
49 Events)
50 -3 - 'fun' in 'listener' ist nicht vorhanden oder nicht von aussen
51 aufrufbar (protected, static, private).
52
53BEMERKUNGEN:
54 Wenn 'listener' bereits fuer den Event registriert wird, wird die alte
55 Registrierung ueberschrieben (als ggf. gilt dann der jetzt uebergebene
56 Funktionsname).
57 Die Funktion 'fun' sollte sparsam mit den Eval-Ticks umgehen. Momentan
58 ist die max. Menge an Ticks auf 30000 beschraenkt. Dies kann bei
59 Problemen auch jederzeit reduziert werden!
60 Der EVENTD merkt sich Event-Lauscher nicht ueber Reboots hinaus.
61 Sollte sich eine Blueprint anmelden, sich zerstoeren und neugeladen
62 werden, ist die neue Blueprint noch angemeldet, weil das neue Objekt
63 unter dem alten Namen wiedergefunden wird. Dies gilt _nicht_ fuer
64 Clones!
65
66BEISPIELE:
67 1. Ein Objekt moechte ueber Spielertode informiert werden:
68 EVENTD->RegisterEvent(EVT_LIB_PLAYER_DEATH, "spieler_ist_tot",
69 this_object());
70 Ab jetzt wird im Objekt jedes Mal, wenn ein Spieler stirbt, die
71 Funktion "spieler_ist_tot" aufgerufen.
72
73 2. Ein Objekt will informiert werden, wenn der Event
74 "boing_zwergenkoenig_angriff" ausgeloest wird:
75 EVENTD->RegisterEvent("boing_zwergenkoenig_angriff","alarm",
76 this_object());
77
78SIEHE AUCH:
79 events, eventd, UnregisterEvent(), TriggerEvent()
80
81----------------------------------------------------------------------------
82Last modified: 15.08.2007, Zesstra