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