Doku zu Startraeumen erweitert
SetDefaultHome() und QueryDefaultHome() hinzugefuegt, P_START_HOME
ergaenzt.
Change-Id: Ib429058d506c56cb65eadc84f18f71cfb3d48850
diff --git a/doc/sphinx/lfun/QueryDefaultHome.rst b/doc/sphinx/lfun/QueryDefaultHome.rst
new file mode 100644
index 0000000..d607d9a
--- /dev/null
+++ b/doc/sphinx/lfun/QueryDefaultHome.rst
@@ -0,0 +1,40 @@
+QueryDefaultHome()
+==================
+
+FUNKTION
+--------
+
+ string QueryDefaultHome()
+
+DEFINIERT IN
+------------
+
+ /std/player/base.c
+
+BESCHREIBUNG
+------------
+
+ Diese Funktion wird verwendet, um den Standard-Startraum der Shell
+ abzufragen.
+ Um den konkreten Startraum eines Spielerobjekts zu ermitteln, sollte
+ hingegen zunaechst P_START_HOME abgefragt werden.
+
+RUECKGABEWERT
+-------------
+
+ Der Pfad zum Standard-Startraum.
+
+BEMERKUNGEN
+-----------
+
+ Diese Funktion wird **nicht** verwendet, um Seherhaeuser oder
+ Magier-Workrooms abzufragen. Seherhaeuser werden ueber
+ /d/seher/haeuser/hausverwalter.c konfiguriert, Workrooms ueber
+ :doc:`../props/P_STARTHOME`.
+
+SIEHE AUCH
+----------
+
+ :doc:`SetDefaultHome`, :doc:`../props/P_START_HOME`
+
+Letzte Aenderung: 28.09.2022, Bugfix
diff --git a/doc/sphinx/lfun/SetDefaultHome.rst b/doc/sphinx/lfun/SetDefaultHome.rst
new file mode 100644
index 0000000..874aae9
--- /dev/null
+++ b/doc/sphinx/lfun/SetDefaultHome.rst
@@ -0,0 +1,47 @@
+SetDefaultHome()
+================
+
+FUNKTION
+--------
+
+ protected string SetDefaultHome(string home)
+
+DEFINIERT IN
+------------
+
+ /std/player/base.c
+ /sys/player/base.h
+
+ARGUMENTE
+---------
+
+ string home
+ Der Startraum des Spielers
+
+BESCHREIBUNG
+------------
+
+ Diese Funktion wird in der Shell verwendet, um den Standard-Startraum zu
+ setzen fuer alle Objekte dieser Shell (Rasse) zu setzen.
+ Fuer individuelle Spielerobjekte kann dieser ggf. mit der Property
+ P_START_HOME geaendert werden.
+
+RUeCKGABEWERT
+-------------
+
+ Das neue Default-Home.
+
+BEMERKUNGEN
+-----------
+
+ Diese Funktion wird **nicht** verwendet, um Seherhaeuser oder
+ Magier-Workrooms zu setzen. Seherhaeuser werden ueber
+ /d/seher/haeuser/hausverwalter konfiguriert, Workrooms ueber
+ :doc:`../props/P_START_HOME`.
+
+SIEHE AUCH
+----------
+
+ :doc:`QueryDefaultHome`, :doc:`../props/P_START_HOME`
+
+Letzte Aenderung: 28.09.2022, Bugfix
diff --git a/doc/sphinx/props/P_START_HOME.rst b/doc/sphinx/props/P_START_HOME.rst
index f81b611..80cea19 100644
--- a/doc/sphinx/props/P_START_HOME.rst
+++ b/doc/sphinx/props/P_START_HOME.rst
@@ -3,19 +3,29 @@
NAME
----
-::
- P_START_HOME "start_home"
+ P_START_HOME "start_home"
DEFINIERT IN
------------
-::
- /sys/player/base.h
+ /sys/player/base.h
BESCHREIBUNG
------------
-::
- Raum, in dem der Spieler nach dem Einloggen landen soll
+ Enthaelt den Pfad zu einem Startraum des Spielerobjekts.
+ Dieser wird bevorzugt vor dem Standard-Startraum der Shell verwendet.
+BEMERKUNGEN
+-----------
+
+ Diese Property ist nicht zum Eintragen des Seherhauses gedacht, hierfuer
+ ist /d/seher/haeuser/hausverwalter zustaendig.
+
+SIEHE AUCH
+----------
+
+ :doc:`../lfun/SetDefaultHome`, :doc:`../lfun/QueryDefaultHome`
+
+Letzte Aenderung: 28.09.2022, Bugfix