blob: 1970367a240c8b522f666a51ca995076ec0142a6 [file] [log] [blame]
MG Mud User88f12472016-06-24 23:31:02 +02001FUNKTION:
2 #include <notify_fail.h>
3
4 varargs void notify_fail(string str, int prio)
5 varargs void notify_fail(closure cl, int prio)
6
7ARGUMENTE:
8 str Meldung die an den Spieler anstatt des 'Wie bitte' ausgegeben
9 werden soll
10 cl Closure, die bei Fehlschlag ausgefuehrt werden soll
11 prio Prioritaet dieses Objekts bei diesem Setzen der Meldung
12
13BESCHREIBUNG:
14 Merkt sich den angegebenen str und gibt ihn im Falle einer inkorrekten
15 Eingabe des Spielers anstatt eines 'Wie bitte' aus.
16
17 Gedacht ist notify_fail, um dem Spieler eine bessere Hilfestellung
18 bei Kommandos / Eingaben zu geben, um ihn u.U. auf die richtige
19 Syntax hinzuweisen.
20
21 Wird notify_fail mehrfach (durch verschiedene Objekte o.ae.) auf-
22 gerufen, wird der letzte erfolgreiche Aufruf gewertet. Eine Meldung wird
23 dann tatsaechlich gesetzt, wenn die Prioritaet dieses Objekts gleich
24 gross oder groesser ist als die Prioritaet des Objekts, was das bisher
25 gueltige notify_fail() gesetzt hat. Folgende Prioritaeten sind
26 vordefiniert und werden automatisch ermittelt:
27 NF_NL_OWN 100 // eigenes Objekt (soul) ueberschreibt kaum was
28 NF_NL_THING 100000
29 NF_NL_ROOM 1000000 // Raeume ueberschreiben sonstigen Krams
30 NF_NL_LIVING 10000000 // Lebewesen ueberschreiben auch Raeume
31 2 weitere vordefinierte koennen von Magier angegeben werden:
32 NF_NL_NONE -1 // wird von allem ueberschrieben
33 NF_NL_MAX __INT_MAX__ // hoechste Prioritaet, ueberschreibt alles
34
35 Wird eine Closure als Argument gegeben, wird sie im Fehlerfall
36 (also erst wenn ein Kommando endgueltig fehlgeschlagen hat)
37 ausgefuehrt und hat die Fehlermeldung als Resultat
38 zurueckzugeben. Die Closure erhaelt als Argument den
39 originalen Befehlsgeber; in der Regel dies ist this_player(),
40 was aber vom MODIFY_CMD hook geaendert werden kann.
41
42 notify_fail() erkennt verschachtelte Kommandos (siehe Efun
43 command()), und ein notify_fail() in einem Unterkommando
44 hat keinen Einfluss auf das uebergeordnete Kommando.
45
46BEMERKUNGEN:
47 - solange man sich nicht absolut sicher ist, dass ein bestimmtes Objekt
48 mit dem Kommando gemeint ist (Identifikation ueber id()), sollte man
49 - notify_fail(str); return 0;
50 nutzen anstatt mit
51 - write(str) return 1;
52 die Kommandoauswertung abzubrechen (und anderen Objekten die Chance
53 zu nehmen das Kommando zu erfuellen)
54 - Kommandos werden uebrigens oft erst vom betretenen Raum, dann von den
55 Objekten abgearbeitet (je nachdem wann diese dazukamen)
56 - die Prioritaet wird momentan nicht gespeichert, sie ist nur beim Setzen
57 relevant. Will spaeter ein anderes Objekt eine Meldung setzen, wird
58 fuer das eigene Objekt die Standardprioritaet ermittelt, auch wenn man
59 eine andere hier uebergeben hat
60 - Die NF_NL_* sind in /sys/notify_fail.h defniert.
61
62BEISPIELE:
63 Ein Raum erwartet die korrekte Eingabe von 'iss suppe':
64
65 int iss_cmd(string str){
66 // zu Anfang der Funktion das notify_fail definieren
67 notify_fail("Moechtest Du vielleicht von der Suppe essen?\n");
68
69 // Spieler hat nur 'iss' ohne Parameter eingegeben oder einen anderen
70 // Parameter angegeben ... Abbruch!
71 // Falls kein weiteres Objekt das Kommando erfuellt oder das
72 // notify_fail() mit einer eigenen Meldung ueberschreibt, wird obige
73 // Meldung an den Spieler ausgegeben.
74
75 if(!str || str!="suppe") return 0;
76 // ab hier ist die Eingabe dann wirklich 'suppe' und die Funktion
77 // kann beliebig fortgefuehrt werden
78 ...
79 return 1;
80
81SIEHE AUCH:
82 add_action(E), AddCmd(L), AddAction(L),
83 query_verb(E), query_notify_fail(E)
84
858.Aug 2007 Gloinson