blob: 1bfff53f22b32c0e7c9cb3e6730d407318562faf [file] [log] [blame]
Zesstra18626972017-01-31 10:38:27 +01001P_SYNTAX_HELP
2=============
3
4NAME
5----
Zesstra18626972017-01-31 10:38:27 +01006
Bugfixc294d1d2017-06-13 21:30:43 +02007 P_SYNTAX_HELP
8 "lib_p_syntax_help"
Zesstra18626972017-01-31 10:38:27 +01009
10DEFINIERT IN
11------------
12::
13
Bugfixc294d1d2017-06-13 21:30:43 +020014 /sys/thing/commands.h
Zesstra18626972017-01-31 10:38:27 +010015
16BESCHREIBUNG
17------------
Zesstra18626972017-01-31 10:38:27 +010018
Bugfixc294d1d2017-06-13 21:30:43 +020019 In dieser Property kann man fuer Spieler eine ausfuehrliche Syntaxhilfe zu
20 den Kommandos eines Objektes ablegen. Diese wird angezeigt, wenn der
21 Spieler das Kommando "syntaxhilfe <objekt>" eingibt.
22 Die Property kann verschiedene Datenstrukturen enthalten:
Zesstra18626972017-01-31 10:38:27 +010023
Bugfixc294d1d2017-06-13 21:30:43 +020024 1) ein String
25 Der String wird angezeigt, hierbei ggf. umgebrochen, vorhandene
26 Zeilenumbrueche werden beibehalten.
Zesstra18626972017-01-31 10:38:27 +010027
Bugfixc294d1d2017-06-13 21:30:43 +020028 2) ein Array: ({hilfetext, bedingungen})
Zesstra18626972017-01-31 10:38:27 +010029
Bugfixc294d1d2017-06-13 21:30:43 +020030 <hilfetext>:
31 * ein string:
32 Der String wird angezeigt, hierbei ggf. umgebrochen, vorhandene
33 Zeilenumbrueche werden beibehalten.
34 * eine lfun-closure:
35 Diese erhaelt beim Aufruf das betreffende Objekt als Argument.
36 Wenn diese dann einen String zurueckliefert, wird dieser dem Spieler
37 angezeigt. Hierbei wird ggf. umgebrochen, vorhandene Zeilenumbrueche
38 werden beibehalten.
Zesstra18626972017-01-31 10:38:27 +010039
Bugfixc294d1d2017-06-13 21:30:43 +020040 <bedingungen>, welche erfuellt sein muessen, damit dem Spieler die Hilfe
41 angezeigt wird. Die Bedingungen sind entweder:
42 * ein Mapping fuer check_restriction()
43 * eine lfun-closure
44 Diese erhaelt beim Aufruf das betreffende Objekt als Argument und darf
45 eine 0 fuer 'erlaubt', 1 fuer 'nicht erlaubt (mit Standardtext)' oder
46 einen string fuer 'nicht erlaubt mit individuellem Text' sein.
Zesstra18626972017-01-31 10:38:27 +010047
48BEMERKUNGEN
49-----------
50::
51
Bugfixc294d1d2017-06-13 21:30:43 +020052 Hat ein Objekt keine Syntaxhilfe, wird das Kommando "syntaxhilfe" aus dem
53 Objekt wieder entfernt (d.h. die Property muss gesetzt sein, bevor der
54 erste Spieler das Kommando eingibt).
Zesstra18626972017-01-31 10:38:27 +010055
56SIEHE AUCH
57----------
Zesstra18626972017-01-31 10:38:27 +010058
Bugfixc294d1d2017-06-13 21:30:43 +020059 :doc:`../lfun/AddCmd`