blob: 02b674e9f2e5cce41d85e9d55b99991fbad73b9e [file] [log] [blame]
Zesstra18626972017-01-31 10:38:27 +01001P_HARBOUR
2=========
3
4NAME
5----
Zesstra18626972017-01-31 10:38:27 +01006
7 P_HARBOUR "harbour_name"
8
9DEFINIERT IN
10------------
Zesstra18626972017-01-31 10:38:27 +010011
12 /sys/transport.h
13
14BESCHREIBUNG
15------------
Zesstra18626972017-01-31 10:38:27 +010016
17 Array mit eindeutiger Bezeichnung des 'Hafens'
18
19BEMERKUNGEN
20-----------
Zesstra18626972017-01-31 10:38:27 +010021
22 Diese Property wird in Raeumen gesetzt, die als Anleger fuer Transporter
23 dienen sollen. Sie enthaelt ein Array aus zwei Elementen, einem String
24 und einem String-Array, zum Beispiel:
25
Zesstra92f90572018-02-15 21:55:23 +010026 Hafen der Sonneninsel: ({ "zur Sonneninsel", ({"sonneninsel"}) })
27 oder
Zesstra362c7372018-02-05 00:02:24 +010028 Hafen von Titiwu: ({ "nach Titiwu", ({"titiwu"}) })
29
30 Damit bekommt der Spieler bei einer Abfrage seiner Reiseroute mittels
31 "reise route", sofern er schon eine gesetzt hat, eine Ausgabe wie
Zesstra07613292018-02-07 23:47:52 +010032 ..
33
Zesstra18626972017-01-31 10:38:27 +010034 'Du reist mit dem Floss nach Titiwu' oder
35 'Du reist mit dem Wal zur Sonneninsel'.
36
37 Das zweite Element der Property enthaelt eine Liste der IDs, mit denen
38 sich der Hafen mit dem Befehl "reise nach <ID>" ansprechen laesst. Im
39 Beispiel oben wuerde also "reise nach sonneninsel" und
40 "reise nach titiwu" akzeptiert werden. Der erste Eintrag in dieser ID-
41 Liste wird in der Ausgabe des Befehls "reise route" verwendet, sollte
42 also den Anlegeort korrekt bezeichnen und nicht z.B. eine Abkuerzung
43 enthalten.
44 Es bietet sich an, bei bestimmten, deklinierbaren Bezeichnungen alle
45 Varianten einzutragen, z.B. "verlorenes land" und zusaetzlich
46 "verlorene land" und "verlorenen land", damit alle Varianten von
47 "reise nach ..." funktionieren.
48
49 Ist in einem Hafen diese Property nicht gesetzt, so bekommt der
50 Spieler keinerlei Hinweis darauf, wohin ihn ein bestimmter Trans-
51 porter befoerdert.
52 Stattdessen erhaelt er die Bezeichnung 'unbekannt'.
53
54HINWEISE
55--------
Zesstra18626972017-01-31 10:38:27 +010056
57 Wird der zweite Parameter in dieser Property, d.h. die Liste der
58 Anleger-IDs, nicht korrekt gesetzt, kann das dazu fuehren, dass Spieler
59 den hier anlegenden Transporter nicht benutzen koennen, weil es
60 keine sinnvolle Syntax gibt, um den gewuenschten Zielhafen zu finden.
61
62 Zu achten ist auch darauf, das der erste Eintrag unveraendert in einer
63 Meldung an den Spieler ausgegeben wird, d.h. Gross-und Kleinschreibung
64 sollte korrekt sein.
65
66HISTORIE
67--------
Zesstra18626972017-01-31 10:38:27 +010068
69 Frueher war der zweite Eintrag in dieser Property ein einzelner String.
70 Es existiert eine SetMethode auf dieser Property, die solche Daten in
71 altem Code auf die neue Datenstruktur umbiegt. Dies fuehrt dazu, dass
72 bei solchen Objekten die im geladenen Raum enthaltenen Daten nicht mit
73 den Daten im File uebereinstimmen. Dies moege aber bitte niemand
74 zum Anlass nehmen, in neuem Code veraltete Daten in die Property zu
75 schreiben!
Zesstra18626972017-01-31 10:38:27 +010076
77
78SIEHE AUCH
79----------
Zesstra18626972017-01-31 10:38:27 +010080
Zesstra362c7372018-02-05 00:02:24 +010081 Properties: :doc:`P_NO_TRAVELING`, :doc:`P_TRAVEL_INFO`
82 Funktionen: :doc:`../lfun/AddRoute`
Zesstra18626972017-01-31 10:38:27 +010083 Spielerbefehle: reise
84 weitere Doku: /d/inseln/schiffe/HowTo
85
86LETZTE AENDERUNG
87----------------
Zesstra18626972017-01-31 10:38:27 +010088
Zesstra362c7372018-02-05 00:02:24 +01008904.02.2018, Arathorn