Add the abstract zCZone

Gothic-Modding-Community · Feb 24, 2024 · 5ac4c19 · 5ac4c19
1 parent aba3d71
commit 5ac4c19
Show file tree

Hide file tree

Showing 9 changed files with 148 additions and 34 deletions.
diff --git a/docs/zengin/worlds/Classes/zCVob/zCZone/index.md b/docs/zengin/worlds/Classes/zCVob/zCZone/index.md
@@ -0,0 +1,52 @@
+# zCZone
+
+!!! abstract inline end "Quick Infos"
+    **Class Name:** `zCZone`<br/>
+    **Version Identifiers:**<br />
+    — Gothic I: `12289`<br/>
+    — Gothic II: `52224`<br/>
+    **Sources:**<br/>
+    — [zk.gothickit.dev](https://zk.gothickit.dev/engine/objects/zCZone/)
+
+The base class for effect zones.
+
+!!! warning
+    This object is an abstract base class and cannot be instantiated by itself.
+
+## Class members
+
+=== "Gothic 1"
+
+    - [zCVob](../index.md)
+      {: .sp-class}
+    - zCZone
+      {: .sp-class}
+        - &lt;empty&gt;
+          {: .sp-empty}
+
+=== "Gothic 2"
+
+    - [zCVob](../index.md)
+      {: .sp-class}
+    - zCZone
+      {: .sp-class}
+        - &lt;empty&gt;
+          {: .sp-empty}
+
+=== "Gothic 1 (Save)"
+
+    - [zCVob](../index.md)
+      {: .sp-class}
+    - zCZone
+      {: .sp-class}
+        - &lt;empty&gt;
+          {: .sp-empty}
+
+=== "Gothic 2 (Save)"
+
+    - [zCVob](../index.md)
+      {: .sp-class}
+    - zCZone
+      {: .sp-class}
+        - &lt;empty&gt;
+          {: .sp-empty}
diff --git a/...worlds/Classes/zCVob/oCZoneMusic/index.md → ...Classes/zCVob/zCZone/oCZoneMusic/index.md b/...worlds/Classes/zCVob/oCZoneMusic/index.md → ...Classes/zCVob/zCZone/oCZoneMusic/index.md
@@ -15,7 +15,7 @@ A VObject which defines the music to be played within its bounding box. Music zo
 music zone applies. If no music zone applies the music defined in the optional [`oCZoneMusicDefault`](oCZoneMusicDefault.md)
 is used.
 
-The name of the music theme to be played is defined by the [`vobName`](../index.md#vobname).
+The name of the music theme to be played is defined by the [`vobName`](../../index.md#vobname).
 
 !!! tip
     If the suffix `_NCI` or `_NCO` is added to the end of the zone name, it snows instead of rains in the zone.
@@ -24,7 +24,9 @@ The name of the music theme to be played is defined by the [`vobName`](../index.
 
 === "Gothic 1"
 
-    - [zCVob](../index.md)
+    - [zCVob](../../index.md)
+      {: .sp-class}
+    - [*zCZone*](../index.md)
       {: .sp-class}
     - oCZoneMusic
       {: .sp-class}
@@ -43,7 +45,9 @@ The name of the music theme to be played is defined by the [`vobName`](../index.
 
 === "Gothic 2"
 
-    - [zCVob](../index.md)
+    - [zCVob](../../index.md)
+      {: .sp-class}
+    - [*zCZone*](../index.md)
       {: .sp-class}
     - oCZoneMusic
       {: .sp-class}
@@ -62,7 +66,9 @@ The name of the music theme to be played is defined by the [`vobName`](../index.
 
 === "Gothic 1 (Save)"
 
-    - [zCVob](../index.md)
+    - [zCVob](../../index.md)
+      {: .sp-class}
+    - [*zCZone*](../index.md)
       {: .sp-class}
     - oCZoneMusic
       {: .sp-class}
@@ -87,7 +93,9 @@ The name of the music theme to be played is defined by the [`vobName`](../index.
 
 === "Gothic 2 (Save)"
 
-    - [zCVob](../index.md)
+    - [zCVob](../../index.md)
+      {: .sp-class}
+    - [*zCZone*](../index.md)
       {: .sp-class}
     - oCZoneMusic
       {: .sp-class}

diff --git a/...s/zCVob/oCZoneMusic/oCZoneMusicDefault.md → .../zCZone/oCZoneMusic/oCZoneMusicDefault.md b/...s/zCVob/oCZoneMusic/oCZoneMusicDefault.md → .../zCZone/oCZoneMusic/oCZoneMusicDefault.md
@@ -16,7 +16,9 @@ volume-related options of the zone are ignored. There may only be one `oCZoneMus
 
 === "Gothic 1"
 
-    - [zCVob](../index.md)
+    - [zCVob](../../index.md)
+      {: .sp-class}
+    - [*zCZone*](../index.md)
       {: .sp-class}
     - [oCZoneMusic](index.md)
       {: .sp-class}
@@ -27,7 +29,9 @@ volume-related options of the zone are ignored. There may only be one `oCZoneMus
 
 === "Gothic 2"
 
-    - [zCVob](../index.md)
+    - [zCVob](../../index.md)
+      {: .sp-class}
+    - [*zCZone*](../index.md)
       {: .sp-class}
     - [oCZoneMusic](index.md)
       {: .sp-class}
@@ -38,7 +42,9 @@ volume-related options of the zone are ignored. There may only be one `oCZoneMus
 
 === "Gothic 1 (Save)"
 
-    - [zCVob](../index.md)
+    - [zCVob](../../index.md)
+      {: .sp-class}
+    - [*zCZone*](../index.md)
       {: .sp-class}
     - [oCZoneMusic](index.md)
       {: .sp-class}
@@ -49,7 +55,9 @@ volume-related options of the zone are ignored. There may only be one `oCZoneMus
 
 === "Gothic 2 (Save)"
 
-    - [zCVob](../index.md)
+    - [zCVob](../../index.md)
+      {: .sp-class}
+    - [*zCZone*](../index.md)
       {: .sp-class}
     - [oCZoneMusic](index.md)
       {: .sp-class}

diff --git a/.../worlds/Classes/zCVob/zCVobSound/index.md → .../Classes/zCVob/zCZone/zCVobSound/index.md b/.../worlds/Classes/zCVob/zCVobSound/index.md → .../Classes/zCVob/zCZone/zCVobSound/index.md
@@ -17,7 +17,9 @@ Emits a sound defined by a script instance in a given radius. The sound playback
 
 === "Gothic 1"
 
-    - [zCVob](../index.md)
+    - [zCVob](../../index.md)
+      {: .sp-class}
+    - [*zCZone*](../index.md)
       {: .sp-class}
     - zCVobSound
       {: .sp-class}
@@ -48,7 +50,9 @@ Emits a sound defined by a script instance in a given radius. The sound playback
 
 === "Gothic 2"
 
-    - [zCVob](../index.md)
+    - [zCVob](../../index.md)
+      {: .sp-class}
+    - [*zCZone*](../index.md)
       {: .sp-class}
     - zCVobSound
       {: .sp-class}
@@ -79,7 +83,9 @@ Emits a sound defined by a script instance in a given radius. The sound playback
 
 === "Gothic 1 (Save)"
 
-    - [zCVob](../index.md)
+    - [zCVob](../../index.md)
+      {: .sp-class}
+    - [*zCZone*](../index.md)
       {: .sp-class}
     - zCVobSound
       {: .sp-class}
@@ -114,7 +120,9 @@ Emits a sound defined by a script instance in a given radius. The sound playback
 
 === "Gothic 2 (Save)"
 
-    - [zCVob](../index.md)
+    - [zCVob](../../index.md)
+      {: .sp-class}
+    - [*zCZone*](../index.md)
       {: .sp-class}
     - zCVobSound
       {: .sp-class}

diff --git a/...ses/zCVob/zCVobSound/zCVobSoundDaytime.md → ...ob/zCZone/zCVobSound/zCVobSoundDaytime.md b/...ses/zCVob/zCVobSound/zCVobSoundDaytime.md → ...ob/zCZone/zCVobSound/zCVobSoundDaytime.md
@@ -17,7 +17,9 @@ sound can be defined which is played outside the defined time range (example: bi
 
 === "Gothic 1"
 
-    - [zCVob](../index.md)
+    - [zCVob](../../index.md)
+      {: .sp-class}
+    - [*zCZone*](../index.md)
       {: .sp-class}
     - [zCVobSound](index.md)
       {: .sp-class}
@@ -34,7 +36,9 @@ sound can be defined which is played outside the defined time range (example: bi
 
 === "Gothic 2"
 
-    - [zCVob](../index.md)
+    - [zCVob](../../index.md)
+      {: .sp-class}
+    - [*zCZone*](../index.md)
       {: .sp-class}
     - [zCVobSound](index.md)
       {: .sp-class}
@@ -51,7 +55,9 @@ sound can be defined which is played outside the defined time range (example: bi
 
 === "Gothic 1 (Save)"
 
-    - [zCVob](../index.md)
+    - [zCVob](../../index.md)
+      {: .sp-class}
+    - [*zCZone*](../index.md)
       {: .sp-class}
     - [zCVobSound](index.md)
       {: .sp-class}
@@ -68,7 +74,9 @@ sound can be defined which is played outside the defined time range (example: bi
 
 === "Gothic 2 (Save)"
 
-    - [zCVob](../index.md)
+    - [zCVob](../../index.md)
+      {: .sp-class}
+    - [*zCZone*](../index.md)
       {: .sp-class}
     - [zCVobSound](index.md)
       {: .sp-class}

diff --git a/.../Classes/zCVob/zCZoneVobFarPlane/index.md → ...s/zCVob/zCZone/zCZoneVobFarPlane/index.md b/.../Classes/zCVob/zCZoneVobFarPlane/index.md → ...s/zCVob/zCZone/zCZoneVobFarPlane/index.md
@@ -15,7 +15,9 @@ A VObject which defines the loading range of VObjects within its bounding box.
 
 === "Gothic 1"
 
-    - [zCVob](../index.md)
+    - [zCVob](../../index.md)
+      {: .sp-class}
+    - [*zCZone*](../index.md)
       {: .sp-class}
     - zCZoneVobFarPlane
       {: .sp-class}
@@ -26,7 +28,9 @@ A VObject which defines the loading range of VObjects within its bounding box.
 
 === "Gothic 2"
 
-    - [zCVob](../index.md)
+    - [zCVob](../../index.md)
+      {: .sp-class}
+    - [*zCZone*](../index.md)
       {: .sp-class}
     - zCZoneVobFarPlane
       {: .sp-class}
@@ -37,7 +41,9 @@ A VObject which defines the loading range of VObjects within its bounding box.
 
 === "Gothic 1 (Save)"
 
-    - [zCVob](../index.md)
+    - [zCVob](../../index.md)
+      {: .sp-class}
+    - [*zCZone*](../index.md)
       {: .sp-class}
     - zCZoneVobFarPlane
       {: .sp-class}
@@ -48,7 +54,9 @@ A VObject which defines the loading range of VObjects within its bounding box.
 
 === "Gothic 2 (Save)"
 
-    - [zCVob](../index.md)
+    - [zCVob](../../index.md)
+      {: .sp-class}
+    - [*zCZone*](../index.md)
       {: .sp-class}
     - zCZoneVobFarPlane
       {: .sp-class}

diff --git a/...neVobFarPlane/zCZoneVobFarPlaneDefault.md → ...neVobFarPlane/zCZoneVobFarPlaneDefault.md b/...neVobFarPlane/zCZoneVobFarPlaneDefault.md → ...neVobFarPlane/zCZoneVobFarPlaneDefault.md
@@ -17,7 +17,9 @@ objects in each world. Its effect can be overridden using [zCZoneVobFarPlane](in
 
 === "Gothic 1"
 
-    - [zCVob](../index.md)
+    - [zCVob](../../index.md)
+      {: .sp-class}
+    - [*zCZone*](../index.md)
       {: .sp-class}
     - [zCZoneVobFarPlane](index.md)
       {: .sp-class}
@@ -28,9 +30,9 @@ objects in each world. Its effect can be overridden using [zCZoneVobFarPlane](in
 
 === "Gothic 2"
 
-    - [zCVob](../index.md)
+    - [zCVob](../../index.md)
       {: .sp-class}
-    - [zCZoneVobFarPlane](index.md)
+    - [*zCZone*](../index.md)
       {: .sp-class}
     - zCZoneVobFarPlane
       {: .sp-class}
@@ -39,7 +41,9 @@ objects in each world. Its effect can be overridden using [zCZoneVobFarPlane](in
 
 === "Gothic 1 (Save)"
 
-    - [zCVob](../index.md)
+    - [zCVob](../../index.md)
+      {: .sp-class}
+    - [*zCZone*](../index.md)
       {: .sp-class}
     - [zCZoneVobFarPlane](index.md)
       {: .sp-class}
@@ -50,7 +54,9 @@ objects in each world. Its effect can be overridden using [zCZoneVobFarPlane](in
 
 === "Gothic 2 (Save)"
 
-    - [zCVob](../index.md)
+    - [zCVob](../../index.md)
+      {: .sp-class}
+    - [*zCZone*](../index.md)
       {: .sp-class}
     - [zCZoneVobFarPlane](index.md)
       {: .sp-class}

diff --git a/.../worlds/Classes/zCVob/zCZoneZFog/index.md → .../Classes/zCVob/zCZone/zCZoneZFog/index.md b/.../worlds/Classes/zCVob/zCZoneZFog/index.md → .../Classes/zCVob/zCZone/zCZoneZFog/index.md
@@ -15,7 +15,9 @@ A VObject which causes fog to appear within its bounding box.
 
 === "Gothic 1"
 
-    - [zCVob](../index.md)
+    - [zCVob](../../index.md)
+      {: .sp-class}
+    - [*zCZone*](../index.md)
       {: .sp-class}
     - zCZoneZFog
       {: .sp-class}
@@ -30,7 +32,9 @@ A VObject which causes fog to appear within its bounding box.
 
 === "Gothic 2"
 
-    - [zCVob](../index.md)
+    - [zCVob](../../index.md)
+      {: .sp-class}
+    - [*zCZone*](../index.md)
       {: .sp-class}
     - zCZoneZFog
       {: .sp-class}
@@ -49,7 +53,9 @@ A VObject which causes fog to appear within its bounding box.
 
 === "Gothic 1 (Save)"
 
-    - [zCVob](../index.md)
+    - [zCVob](../../index.md)
+      {: .sp-class}
+    - [*zCZone*](../index.md)
       {: .sp-class}
     - zCZoneZFog
       {: .sp-class}
@@ -64,7 +70,9 @@ A VObject which causes fog to appear within its bounding box.
 
 === "Gothic 2 (Save)"
 
-    - [zCVob](../index.md)
+    - [zCVob](../../index.md)
+      {: .sp-class}
+    - [*zCZone*](../index.md)
       {: .sp-class}
     - zCZoneZFog
       {: .sp-class}