blob: f0318e0bfedef7685a18e57db4d81bf309475287 [file] [log] [blame]
MG Mud User88f12472016-06-24 23:31:02 +02001P_DISABLE_COMMANDS
2
3NAME:
4 P_DISABLE_COMMANDS "p_lib_disablecommands"
5
6DEFINIERT IN:
7 /sys/player/command.h
8
9BESCHREIBUNG:
10 Mit dieser Prop kann man verhindern, dass Kommandos eines Spielers
11 verarbeitet werden. Dies ist z.B. in Sequenzen nuetzlich, wo der Spieler
12 rein passiv konsumieren soll.
13 In diese Property muss ein Array mit 2 oder 3 Elementen geschrieben
14 werden:
15 1) Endzeitpunkt in Sekunden seit 1.1.1970 (int)
16 2) Meldung (String oder Closure)
17 3) (optional) Array von trotzdem erlaubten Verben (string*)
18 (nur ausgewertet, wenn die Meldung ein String ist)
19
20 Ist die Meldung ein String, wird dieser einfach bei jedem Kommando so wie
21 er ist an den Spieler ausgegeben und das Kommando abgebrochen.
22 Ist die Meldung eine Closure wird diese bei jedem Kommando aufgerufen und
23 das Kommando abgebrochen, wenn sie einen Rueckgabewert != 0 zurueckgibt.
24 In diesem Fall ist die gerufene Funktion dafuer verantwortlich, geeignete
25 Meldungen an den Spieler auszugeben!
26 Der Funktion wird der vom Spieler eingebene Befehl (string) als erstes
27 Argument uebergeben. Zu diesem Zeitpunkt wurde alle Aliase schon
28 ausgewertet. Die Funktion kann den Kommandogeber via this_player()
29 ermitteln.
30 Fuer weitere Informationen steht auch command_stack() zur Verfuegung,
31 allerdings ist dort die Alias-Ersetzung nicht beruecksichtigt.
32
33 Die Ausnahmeliste wird nur fuer simple Strings als Meldung ausgewertet,
34 wird eine Closure verwendet, kann diese besser selber die Ausnahmen
35 bestimmen.
36
37 Fragt man diese Prop ab, erhaelt man ein Array mit 4 Elementen: setzendes
38 Objekt (object), Ablaufzeit (int), Meldung (String oder Closure) und
39 Liste von Ausnahmen (string*).
40
41BEMERKUNGEN:
42 1. Die Prop wird fuer Magier mit eingeschaltetem P_WANTS_TO_LEARN
43 ignoriert.
44 2. Wenn das Objekt zerstoert wird, was die Prop gesetzt hat, wird der
45 Eintrag unwirksam.
46 3. Wenn diese Prop gesetzt und nicht abgelaufen ist, kann nur das gleiche
47 Objekt sie mit neuen Daten ueberschreiben. Alle anderen Objekte koennen
48 die Prop nur loeschen. Dies soll verhindern, dass Magier unabsichtlich
49 einfach anderer Leute Eintraege ueberschreiben. Dementsprechend: Lasst
50 die Finger davon, wenn die schon gesetzt ist. ;-)
51 4. Diese Prop darf _ausschliesslich_ mit SetProp() und QueryProp() benutzt
52 werden, Set() und Query() funktionieren _nicht_.
53 5. Es gibt einige Verben, die NIE blockiert werden. Zur Zeit sind dies
54 "mrufe", "mschau", "bug", "idee", "typo" und "detail".
55 6. Bitte nicht missbrauchen, speziell nicht dazu, die Kommandos von
56 Spieler zu ueberwachen/mitzuschreiben. Das Setzen dieser Prop wird
57 geloggt.
58
59BEISPIEL:
60 In einem Raum startet eine Sequenz, in der der Spieler nichts machen soll:
61
62 if (!pl->QueryProp(P_DISABLE_COMMANDS))
63 pl->SetProp(P_DISABLE_COMMANDS,
64 ({ time() + 120, "Du bist tief in Deinem Traum gefangen!\n" }) );
65 else // ... Fehlerbehandlung, falls Prop schon gesetzt ...
66
67 Soll die Prop aus irgendeinem Grund (vorzeitig) geloescht werden:
68 pl->SetProp(P_DISABLE_COMMANDS, 0);
69
70SIEHE AUCH:
71 command(), query_command(), command_stack(), modify_command(),
72 this_player()
73
7401.12.2012, Zesstra