| Zesstra | 953f997 | 2017-02-18 15:37:36 +0100 | [diff] [blame] | 1 | |
| 2 | P_SYNTAX_HELP |
| 3 | ************* |
| 4 | |
| 5 | |
| 6 | NAME |
| 7 | ==== |
| 8 | |
| 9 | P_SYNTAX_HELP "lib_p_syntax_help" |
| 10 | |
| 11 | |
| 12 | DEFINIERT IN |
| 13 | ============ |
| 14 | |
| 15 | /sys/thing/commands.h |
| 16 | |
| 17 | |
| 18 | BESCHREIBUNG |
| 19 | ============ |
| 20 | |
| 21 | In dieser Property kann man fuer Spieler eine ausfuehrliche Syntaxhilfe zu |
| 22 | den Kommandos eines Objektes ablegen. Diese wird angezeigt, wenn der |
| 23 | Spieler das Kommando "synxtaxhilfe <objekt>" eingibt. |
| 24 | Die Property kann verschiedene Datenstrukturen enthalten: |
| 25 | |
| 26 | 1) ein String |
| 27 | Der String wird angezeigt, hierbei ggf. umgebrochen, vorhandene |
| 28 | Zeilenumbrueche werden beibehalten. |
| 29 | |
| 30 | 2) ein Array: ({hilfetext, bedingungen}) |
| 31 | |
| 32 | <hilfetext>: |
| 33 | * ein string: |
| 34 | Der String wird angezeigt, hierbei ggf. umgebrochen, vorhandene |
| 35 | Zeilenumbrueche werden beibehalten. |
| 36 | * eine lfun-closure: |
| 37 | Diese erhaelt beim Aufruf das betreffende Objekt als Argument. |
| 38 | Wenn diese dann einen String zurueckliefert, wird dieser dem Spieler |
| 39 | angezeigt. Hierbei wird ggf. umgebrochen, vorhandene Zeilenumbrueche |
| 40 | werden beibehalten. |
| 41 | |
| 42 | <bedingungen>, welche erfuellt sein muessen, damit dem Spieler die Hilfe |
| 43 | angezeigt wird. Die Bedingungen sind entweder: |
| 44 | * ein Mapping fuer check_restriction() |
| 45 | * eine lfun-closure |
| 46 | Diese erhaelt beim Aufruf das betreffende Objekt als Argument und darf |
| 47 | eine 0 fuer 'erlaubt', 1 fuer 'nicht erlaubt (mit Standardtext)' oder |
| 48 | einen string fuer 'nicht erlaubt mit individuellem Text' sein. |
| 49 | |
| 50 | |
| 51 | BEMERKUNGEN |
| 52 | =========== |
| 53 | |
| 54 | Hat ein Objekt keine Syntaxhilfe, wird das Kommando "syntaxhilfe" aus dem |
| 55 | Objekt wieder entfernt (d.h. die Property muss gesetzt sein, bevor der |
| 56 | erste Spieler das Kommando eingibt). |
| 57 | |
| 58 | |
| 59 | SIEHE AUCH |
| 60 | ========== |
| 61 | |
| 62 | AddCmd |