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