blob: 2e8e09e5bcb9a2d5a86ba4191b1e0aeca7154f83 [file] [log] [blame]
Zesstra18626972017-01-31 10:38:27 +01001TriggerEvent()
2==============
3
4FUNKTION
5--------
6::
7
8 varargs int TriggerEvent(string eid, mixed data);
9
10DEFINIERT IN
11------------
12::
13
14 /p/daemon/eventd.c
15
16DEKLARIERT IN
17-------------
18::
19
20 /sys/events.h
21
22ARGUMENTE
23---------
24::
25
26 string eid,
27 Die ID des Events, der ausgeloest werden soll.
28 Da dieser String fuer alle Events jeweils eindeutig sein muss,
29 empfiehlt es sich, fuer eigene Events z.B. als Praefix den eigenen
30 Magiernamen zu nehmen, z.B. "zesstra_vulkanausbruch".
31 ACHTUNG: IDs, die mit 'evt_lib_' beginnen, sind AUSSCHLIESSLICH der
32 Mudlib vorbehalten!
33
34 mixed data,
35 Daten, die jeder Lauscher uebergeben bekommt. Kann ein beliebiger
36 Datentyp sein. Ggf. ein Mapping oder Array benutzen.
37
38BESCHREIBUNG
39------------
40::
41
42 Der Event mit der ID 'eid' wird ausgeloest. Mit kurzer Verzoegerung
43 (meist 0-2s) werden alle fuer 'eid' registrierten Lauscher durch Aufruf
44 einer Funktion in ihnen informiert:
45 listener->fun(eid, triggerob, data);
46 'triggerob' ist hierbei das Objekt, welche TriggerEvent() gerufen hat,
47 'data' das, was das triggernde Objekte als Daten weiterverteilen moechte.
48 Die einzelnen fun() in den lauschenden Objekten muessen wissen, was sie
49 mit 'data' anfangen sollen. ;-)
50
51RUeCKGABEWERT
52-------------
53::
54
55 1 fuer Erfolg, <=0 fuer Misserfolg.
56 1 - Erfolg, Event 'eid' wurde ausgeloest.
57 -1 - falsche Argumente wurden uebergeben
58 -2 - nicht-oeffentlicher Event und das triggernde Objekt wurde nicht
59 fuer diesen Event freigegeben (momentan gibt es noch keine
60 nicht-oeffentlichen Events)
61 -3 - Event 'eid' existiert nicht, d.h. es gibt keine Lauscher.
62 -4 - Es gibt zuviele nicht verarbeitete Events.
63
64BEMERKUNGEN
65-----------
66::
67
68BEISPIELE
69---------
70::
71
72 1. Ein Waechter wird angegriffen:
73 EVENTD->TriggerEvent("xand_holzfaellerlager_angriff",
74 (["angreifer": enemy,
75 "ort": environment(this_object()) ]) );
76 Alle anderen angemeldeten Waechter der Lagers werden nun informiert
77 und koennen ihrerseits reagieren (dem ersten Waechter zuhilfe kommen
78 oder auch die Lagertore schliessen).
79
80SIEHE AUCH
81----------
82::
83
84 events, eventd, UnregisterEvent(), RegisterEvent()
85
86
87Last modified: 15.08.2007, Zesstra
88