docs(zCZone): add the abstract zCZone

GothicKit · Feb 24, 2024 · 443e3de · 443e3de
1 parent 77e9409
commit 443e3de
Show file tree

Hide file tree

Showing 10 changed files with 125 additions and 8 deletions.
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
@@ -62,8 +62,6 @@
                             * [oCMobContainer](engine/objects/oCMobContainer.md)
                             * [oCMobDoor](engine/objects/oCMobDoor.md)
                 * [oCItem](engine/objects/oCItem.md)
-            * [zCVobSound](engine/objects/zCVobSound.md)
-                * [zCVobSoundDaytime](engine/objects/zCVobSoundDaytime.md)
             * [zCTriggerBase](engine/objects/zCTriggerBase.md)
                 * [zCCodeMaster](engine/objects/zCCodeMaster.md)
                 * [zCMessageFilter](engine/objects/zCMessageFilter.md)
@@ -76,12 +74,15 @@
                     * [oCTriggerChangeLevel](engine/objects/oCTriggerChangeLevel.md)
                     * [oCCSTrigger](engine/objects/oCCSTrigger.md)
                     * [zCMover](engine/objects/zCMover.md)
-            * [oCZoneMusic](engine/objects/oCZoneMusic.md)
-                * [oCZoneMusicDefault](engine/objects/oCZoneMusicDefault.md)
-            * [zCZoneVobFarPlane](engine/objects/zCZoneVobFarPlane.md)
-                * [zCZoneVobFarPlaneDefault](engine/objects/zCZoneVobFarPlaneDefault.md)
-            * [zCZoneZFog](engine/objects/zCZoneZFog.md)
-                * [zCZoneZFogDefault](engine/objects/zCZoneZFogDefault.md)
+            * [zCZone](engine/objects/zCZone.md)
+                * [oCZoneMusic](engine/objects/oCZoneMusic.md)
+                    * [oCZoneMusicDefault](engine/objects/oCZoneMusicDefault.md)
+                * [zCZoneVobFarPlane](engine/objects/zCZoneVobFarPlane.md)
+                    * [zCZoneVobFarPlaneDefault](engine/objects/zCZoneVobFarPlaneDefault.md)
+                * [zCZoneZFog](engine/objects/zCZoneZFog.md)
+                    * [zCZoneZFogDefault](engine/objects/zCZoneZFogDefault.md)
+                * [zCVobSound](engine/objects/zCVobSound.md)
+                    * [zCVobSoundDaytime](engine/objects/zCVobSoundDaytime.md)
         * [zCVisual](engine/objects/zCVisual.md)
             * [zCDecal](engine/objects/zCDecal.md)
         * [oCSavegameInfo](engine/objects/oCSavegameInfo.md)

diff --git a/docs/engine/objects/oCZoneMusic.md b/docs/engine/objects/oCZoneMusic.md
@@ -28,6 +28,8 @@ The name of the music theme to be played is defined by the [`vobName`](zCVob.md#
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [*zCZone*](zCZone.md)
+      {: .sp-class}
     - oCZoneMusic
       {: .sp-class}
         - [enabled](#enabled) = TRUE
@@ -47,6 +49,8 @@ The name of the music theme to be played is defined by the [`vobName`](zCVob.md#
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [*zCZone*](zCZone.md)
+      {: .sp-class}
     - oCZoneMusic
       {: .sp-class}
         - [enabled](#enabled) = TRUE
@@ -66,6 +70,8 @@ The name of the music theme to be played is defined by the [`vobName`](zCVob.md#
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [*zCZone*](zCZone.md)
+      {: .sp-class}
     - oCZoneMusic
       {: .sp-class}
         - [enabled](#enabled) = TRUE
@@ -91,6 +97,8 @@ The name of the music theme to be played is defined by the [`vobName`](zCVob.md#
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [*zCZone*](zCZone.md)
+      {: .sp-class}
     - oCZoneMusic
       {: .sp-class}
         - [enabled](#enabled) = TRUE

diff --git a/docs/engine/objects/oCZoneMusicDefault.md b/docs/engine/objects/oCZoneMusicDefault.md
@@ -19,6 +19,8 @@ volume-related options of the zone are ignored. There may only be one `oCZoneMus
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [*zCZone*](zCZone.md)
+      {: .sp-class}
     - [oCZoneMusic](oCZoneMusic.md)
       {: .sp-class}
     - oCZoneMusicDefault
@@ -30,6 +32,8 @@ volume-related options of the zone are ignored. There may only be one `oCZoneMus
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [*zCZone*](zCZone.md)
+      {: .sp-class}
     - [oCZoneMusic](oCZoneMusic.md)
       {: .sp-class}
     - oCZoneMusicDefault
@@ -41,6 +45,8 @@ volume-related options of the zone are ignored. There may only be one `oCZoneMus
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [*zCZone*](zCZone.md)
+      {: .sp-class}
     - [oCZoneMusic](oCZoneMusic.md)
       {: .sp-class}
     - oCZoneMusicDefault
@@ -52,6 +58,8 @@ volume-related options of the zone are ignored. There may only be one `oCZoneMus
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [*zCZone*](zCZone.md)
+      {: .sp-class}
     - [oCZoneMusic](oCZoneMusic.md)
       {: .sp-class}
     - oCZoneMusicDefault

diff --git a/docs/engine/objects/zCVobSound.md b/docs/engine/objects/zCVobSound.md
@@ -20,6 +20,8 @@ Emits a sound defined by a script instance in a given radius. The sound playback
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [*zCZone*](zCZone.md)
+      {: .sp-class}
     - zCVobSound
       {: .sp-class}
         - Sound
@@ -51,6 +53,8 @@ Emits a sound defined by a script instance in a given radius. The sound playback
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [*zCZone*](zCZone.md)
+      {: .sp-class}
     - zCVobSound
       {: .sp-class}
         - Sound
@@ -82,6 +86,8 @@ Emits a sound defined by a script instance in a given radius. The sound playback
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [*zCZone*](zCZone.md)
+      {: .sp-class}
     - zCVobSound
       {: .sp-class}
         - Sound
@@ -117,6 +123,8 @@ Emits a sound defined by a script instance in a given radius. The sound playback
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [*zCZone*](zCZone.md)
+      {: .sp-class}
     - zCVobSound
       {: .sp-class}
         - Sound

diff --git a/docs/engine/objects/zCVobSoundDaytime.md b/docs/engine/objects/zCVobSoundDaytime.md
@@ -20,6 +20,8 @@ sound can be defined which is played outside the defined time range (example: bi
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [*zCZone*](zCZone.md)
+      {: .sp-class}
     - [zCVobSound](zCVobSound.md)
       {: .sp-class}
     - zCVobSoundDaytime
@@ -37,6 +39,8 @@ sound can be defined which is played outside the defined time range (example: bi
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [*zCZone*](zCZone.md)
+      {: .sp-class}
     - [zCVobSound](zCVobSound.md)
       {: .sp-class}
     - zCVobSoundDaytime
@@ -54,6 +58,8 @@ sound can be defined which is played outside the defined time range (example: bi
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [*zCZone*](zCZone.md)
+      {: .sp-class}
     - [zCVobSound](zCVobSound.md)
       {: .sp-class}
     - zCVobSoundDaytime
@@ -71,6 +77,8 @@ sound can be defined which is played outside the defined time range (example: bi
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [*zCZone*](zCZone.md)
+      {: .sp-class}
     - [zCVobSound](zCVobSound.md)
       {: .sp-class}
     - zCVobSoundDaytime

diff --git a/docs/engine/objects/zCZone.md b/docs/engine/objects/zCZone.md
@@ -0,0 +1,52 @@
+# zCZone
+
+!!! abstract inline end "Quick Infos"
+    **Type:** Virtual Object<br/>
+    **Format Name:** ZenGin Archive<br/>
+    **File Extension:** `.ZEN`<br/>
+    **Class Name:** `zCZone`<br/>
+    **Version Identifiers:**<br />
+    — Gothic I: `12289`<br/>
+    — Gothic II: `52224`<br/>
+    **ZenKit Class:** —<br/>
+
+The base class for effect zones.
+
+!!! warning
+    This object is an abstract base class and cannot be instantiated by itself.
+
+=== "Gothic 1"
+
+    - [zCVob](zCVob.md)
+      {: .sp-class}
+    - zCZone
+      {: .sp-class}
+        - &lt;empty&gt;
+          {: .sp-empty}
+
+=== "Gothic 2"
+
+    - [zCVob](zCVob.md)
+      {: .sp-class}
+    - zCZone
+      {: .sp-class}
+        - &lt;empty&gt;
+          {: .sp-empty}
+
+=== "Gothic 1 (Save)"
+
+    - [zCVob](zCVob.md)
+      {: .sp-class}
+    - zCZone
+      {: .sp-class}
+        - &lt;empty&gt;
+          {: .sp-empty}
+
+=== "Gothic 2 (Save)"
+
+    - [zCVob](zCVob.md)
+      {: .sp-class}
+    - zCZone
+      {: .sp-class}
+        - &lt;empty&gt;
+          {: .sp-empty}
diff --git a/docs/engine/objects/zCZoneVobFarPlane.md b/docs/engine/objects/zCZoneVobFarPlane.md
@@ -19,6 +19,8 @@ A VObject which defines the loading range of VObjects within its bounding box.
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [*zCZone*](zCZone.md)
+      {: .sp-class}
     - zCZoneVobFarPlane
       {: .sp-class}
         - [vobFarPlaneZ](#vobfarplanez) = 12000.0
@@ -30,6 +32,8 @@ A VObject which defines the loading range of VObjects within its bounding box.
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [*zCZone*](zCZone.md)
+      {: .sp-class}
     - zCZoneVobFarPlane
       {: .sp-class}
         - [vobFarPlaneZ](#vobfarplanez) = 12000.0
@@ -41,6 +45,8 @@ A VObject which defines the loading range of VObjects within its bounding box.
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [*zCZone*](zCZone.md)
+      {: .sp-class}
     - zCZoneVobFarPlane
       {: .sp-class}
         - [vobFarPlaneZ](#vobfarplanez) = 12000.0
@@ -52,6 +58,8 @@ A VObject which defines the loading range of VObjects within its bounding box.
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [*zCZone*](zCZone.md)
+      {: .sp-class}
     - zCZoneVobFarPlane
       {: .sp-class}
         - [vobFarPlaneZ](#vobfarplanez) = 12000.0

diff --git a/docs/engine/objects/zCZoneVobFarPlaneDefault.md b/docs/engine/objects/zCZoneVobFarPlaneDefault.md
@@ -20,6 +20,8 @@ objects in each world. Its effect can be overridden using [zCZoneVobFarPlane](zC
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [*zCZone*](zCZone.md)
+      {: .sp-class}
     - [zCZoneVobFarPlane](zCZoneVobFarPlane.md)
       {: .sp-class}
     - zCZoneVobFarPlane
@@ -31,6 +33,8 @@ objects in each world. Its effect can be overridden using [zCZoneVobFarPlane](zC
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [*zCZone*](zCZone.md)
+      {: .sp-class}
     - [zCZoneVobFarPlane](zCZoneVobFarPlane.md)
       {: .sp-class}
     - zCZoneVobFarPlane
@@ -42,6 +46,8 @@ objects in each world. Its effect can be overridden using [zCZoneVobFarPlane](zC
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [*zCZone*](zCZone.md)
+      {: .sp-class}
     - [zCZoneVobFarPlane](zCZoneVobFarPlane.md)
       {: .sp-class}
     - zCZoneVobFarPlane
@@ -53,6 +59,8 @@ objects in each world. Its effect can be overridden using [zCZoneVobFarPlane](zC
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [*zCZone*](zCZone.md)
+      {: .sp-class}
     - [zCZoneVobFarPlane](zCZoneVobFarPlane.md)
       {: .sp-class}
     - zCZoneVobFarPlane

diff --git a/docs/engine/objects/zCZoneZFog.md b/docs/engine/objects/zCZoneZFog.md
@@ -19,6 +19,8 @@ A VObject which causes fog to appear within its bounding box.
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [*zCZone*](zCZone.md)
+      {: .sp-class}
     - zCZoneZFog
       {: .sp-class}
         - ZoneZFog
@@ -34,6 +36,8 @@ A VObject which causes fog to appear within its bounding box.
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [*zCZone*](zCZone.md)
+      {: .sp-class}
     - zCZoneZFog
       {: .sp-class}
         - ZoneZFog
@@ -53,6 +57,8 @@ A VObject which causes fog to appear within its bounding box.
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [*zCZone*](zCZone.md)
+      {: .sp-class}
     - zCZoneZFog
       {: .sp-class}
         - ZoneZFog
@@ -68,6 +74,8 @@ A VObject which causes fog to appear within its bounding box.
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [*zCZone*](zCZone.md)
+      {: .sp-class}
     - zCZoneZFog
       {: .sp-class}
         - ZoneZFog

diff --git a/docs/engine/objects/zCZoneZFogDefault.md b/docs/engine/objects/zCZoneZFogDefault.md
@@ -20,6 +20,8 @@ Its effect can be overridden using [zCZoneZFog](zCZoneZFog.md) objects.
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [*zCZone*](zCZone.md)
+      {: .sp-class}
     - [zCZoneZFog](zCZoneZFog.md)
       {: .sp-class}
     - zCZoneZFogDefault
@@ -31,6 +33,8 @@ Its effect can be overridden using [zCZoneZFog](zCZoneZFog.md) objects.
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [*zCZone*](zCZone.md)
+      {: .sp-class}
     - [zCZoneZFog](zCZoneZFog.md)
       {: .sp-class}
     - zCZoneZFogDefault
@@ -42,6 +46,8 @@ Its effect can be overridden using [zCZoneZFog](zCZoneZFog.md) objects.
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [*zCZone*](zCZone.md)
+      {: .sp-class}
     - [zCZoneZFog](zCZoneZFog.md)
       {: .sp-class}
     - zCZoneZFogDefault
@@ -53,6 +59,8 @@ Its effect can be overridden using [zCZoneZFog](zCZoneZFog.md) objects.
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [*zCZone*](zCZone.md)
+      {: .sp-class}
     - [zCZoneZFog](zCZoneZFog.md)
       {: .sp-class}
     - zCZoneZFogDefault