docs(zCEffect): add documentation for zCEffect

GothicKit · Feb 23, 2024 · 5d5932b · 5d5932b
1 parent b663e70
commit 5d5932b
Show file tree

Hide file tree

Showing 7 changed files with 96 additions and 6 deletions.
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
@@ -35,23 +35,26 @@
         * [ZenGin Save Game](engine/formats/savegame.md)
     * Objects
         * [zCVob](engine/objects/zCVob.md)
-            * [zCVobAnimate](engine/objects/zCVobAnimate.md)
-            * [zCVobLensFlare](engine/objects/zCVobLensFlare.md)
             * [zCVobLevelCompo](engine/objects/zCVobLevelCompo.md)
             * [zCVobLight](engine/objects/zCVobLight.md)
-            * [zCVobScreenFX](engine/objects/zCVobScreenFX.md)
             * [zCVobSpot](engine/objects/zCVobSpot.md)
             * [zCVobStair](engine/objects/zCVobStair.md)
             * [zCVobStartpoint](engine/objects/zCVobStartpoint.md)
             * [zCCodeMaster](engine/objects/zCCodeMaster.md)
             * [zCEarthquake](engine/objects/zCEarthquake.md)
             * [zCMessageFilter](engine/objects/zCMessageFilter.md)
             * [zCMoverControler](engine/objects/zCMoverController.md)
-            * [zCPFXControler](engine/objects/zCPFXController.md)
             * [zCTriggerWorldStart](engine/objects/zCTriggerWorldStart.md)
             * [zCTriggerUntouch](engine/objects/zCTriggerUntouch.md)
             * [zCCSCamera](engine/objects/zCCSCamera.md)
             * [zCCamTrj_KeyFrame](engine/objects/zCCamTrj_KeyFrame.md)
+            * [zCEffect](engine/objects/zCEffect.md)
+                * [zCVobAnimate](engine/objects/zCVobAnimate.md)
+                * [zCVobLensFlare](engine/objects/zCVobLensFlare.md)
+                * [zCVobScreenFX](engine/objects/zCVobScreenFX.md)
+                * [zCPFXControler](engine/objects/zCPFXController.md)
+                * [zCTouchDamage](engine/objects/zCTouchDamage.md)
+                    * [oCTouchDamage](engine/objects/oCTouchDamage.md)
             * [oCVob](engine/objects/oCVob.md)
                 * [oCMOB](engine/objects/oCMOB.md)
                     * [oCMobInter](engine/objects/oCMobInter.md)
@@ -77,8 +80,6 @@
                 * [zCZoneVobFarPlaneDefault](engine/objects/zCZoneVobFarPlaneDefault.md)
             * [zCZoneZFog](engine/objects/zCZoneZFog.md)
                 * [zCZoneZFogDefault](engine/objects/zCZoneZFogDefault.md)
-            * [zCTouchDamage](engine/objects/zCTouchDamage.md)
-                * [oCTouchDamage](engine/objects/oCTouchDamage.md)
         * [zCVisual](engine/objects/zCVisual.md)
             * [zCDecal](engine/objects/zCDecal.md)
         * [oCSavegameInfo](engine/objects/oCSavegameInfo.md)

diff --git a/docs/engine/objects/zCEffect.md b/docs/engine/objects/zCEffect.md
@@ -0,0 +1,49 @@
+# zCEffect
+
+!!! abstract inline end "Quick Infos"
+    **Type:** Virtual Object<br/>
+    **Format Name:** ZenGin Archive<br/>
+    **File Extension:** `.ZEN`<br/>
+    **Class Name:** `zCEffect`<br/>
+    **Version Identifiers:**<br />
+    — Gothic I: `12289`<br/>
+    — Gothic II: `52224`<br/>
+    **ZenKit Class:** —<br/>
+
+The base class for many visual and sound effects.
+
+=== "Gothic 1"
+
+    - [zCVob](zCVob.md)
+      {: .sp-class}
+    - zCEffect
+      {: .sp-class}
+        - &lt;empty&gt;
+          {: .sp-empty}
+
+=== "Gothic 2"
+
+    - [zCVob](zCVob.md)
+      {: .sp-class}
+    - zCEffect
+      {: .sp-class}
+        - &lt;empty&gt;
+          {: .sp-empty}
+
+=== "Gothic 1 (Save)"
+
+    - [zCVob](zCVob.md)
+      {: .sp-class}
+    - zCEffect
+      {: .sp-class}
+        - &lt;empty&gt;
+          {: .sp-empty}
+
+=== "Gothic 2 (Save)"
+
+    - [zCVob](zCVob.md)
+      {: .sp-class}
+    - zCEffect
+      {: .sp-class}
+        - &lt;empty&gt;
+          {: .sp-empty}
diff --git a/docs/engine/objects/zCPFXController.md b/docs/engine/objects/zCPFXController.md
@@ -20,6 +20,8 @@ events.
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [zCEffect](zCEffect.md)
+      {: .sp-class}
     - zCPFXController
       {: .sp-class}
         - [pfxName](#pfxname) = ""
@@ -33,6 +35,8 @@ events.
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [zCEffect](zCEffect.md)
+      {: .sp-class}
     - zCPFXController
       {: .sp-class}
         - [pfxName](#pfxname) = ""
@@ -46,6 +50,8 @@ events.
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [zCEffect](zCEffect.md)
+      {: .sp-class}
     - zCPFXController
       {: .sp-class}
         - [pfxName](#pfxname) = ""
@@ -59,6 +65,8 @@ events.
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [zCEffect](zCEffect.md)
+      {: .sp-class}
     - zCPFXController
       {: .sp-class}
         - [pfxName](#pfxname) = ""

diff --git a/docs/engine/objects/zCTouchDamage.md b/docs/engine/objects/zCTouchDamage.md
@@ -19,6 +19,8 @@ A VObject which damages other VObjects colliding with it.
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [zCEffect](zCEffect.md)
+      {: .sp-class}
     - zCTouchDamage
       {: .sp-class}
         - TouchDamage
@@ -54,6 +56,8 @@ A VObject which damages other VObjects colliding with it.
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [zCEffect](zCEffect.md)
+      {: .sp-class}
     - zCTouchDamage
       {: .sp-class}
         - TouchDamage
@@ -89,6 +93,8 @@ A VObject which damages other VObjects colliding with it.
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [zCEffect](zCEffect.md)
+      {: .sp-class}
     - zCTouchDamage
       {: .sp-class}
         - TouchDamage
@@ -124,6 +130,8 @@ A VObject which damages other VObjects colliding with it.
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [zCEffect](zCEffect.md)
+      {: .sp-class}
     - zCTouchDamage
       {: .sp-class}
         - TouchDamage

diff --git a/docs/engine/objects/zCVobAnimate.md b/docs/engine/objects/zCVobAnimate.md
@@ -22,6 +22,8 @@ and stopped using `OnTrigger` and `OnUntrigger` events.
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [zCEffect](zCEffect.md)
+      {: .sp-class}
     - zCVobAnimate
       {: .sp-class}
         - [startOn](#starton) = ""
@@ -31,6 +33,8 @@ and stopped using `OnTrigger` and `OnUntrigger` events.
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [zCEffect](zCEffect.md)
+      {: .sp-class}
     - zCVobAnimate
       {: .sp-class}
         - [startOn](#starton) = ""
@@ -40,6 +44,8 @@ and stopped using `OnTrigger` and `OnUntrigger` events.
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [zCEffect](zCEffect.md)
+      {: .sp-class}
     - zCVobAnimate
       {: .sp-class}
         - [startOn](#starton) = ""
@@ -51,6 +57,8 @@ and stopped using `OnTrigger` and `OnUntrigger` events.
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [zCEffect](zCEffect.md)
+      {: .sp-class}
     - zCVobAnimate
       {: .sp-class}
         - [startOn](#starton) = ""

diff --git a/docs/engine/objects/zCVobLensFlare.md b/docs/engine/objects/zCVobLensFlare.md
@@ -19,6 +19,8 @@ Represents a lens flare effect. Behaves exactly like the base [`zCVob`](zCVob.md
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [zCEffect](zCEffect.md)
+      {: .sp-class}
     - zCVobLensFlare
       {: .sp-class}
         - [lensflareFX](#lensflarefx) = ""
@@ -28,6 +30,8 @@ Represents a lens flare effect. Behaves exactly like the base [`zCVob`](zCVob.md
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [zCEffect](zCEffect.md)
+      {: .sp-class}
     - zCVobLensFlare
       {: .sp-class}
         - [lensflareFX](#lensflarefx) = ""
@@ -37,6 +41,8 @@ Represents a lens flare effect. Behaves exactly like the base [`zCVob`](zCVob.md
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [zCEffect](zCEffect.md)
+      {: .sp-class}
     - zCVobLensFlare
       {: .sp-class}
         - [lensflareFX](#lensflarefx) = ""
@@ -46,6 +52,8 @@ Represents a lens flare effect. Behaves exactly like the base [`zCVob`](zCVob.md
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [zCEffect](zCEffect.md)
+      {: .sp-class}
     - zCVobLensFlare
       {: .sp-class}
         - [lensflareFX](#lensflarefx) = ""

diff --git a/docs/engine/objects/zCVobScreenFX.md b/docs/engine/objects/zCVobScreenFX.md
@@ -20,6 +20,8 @@ for a cinematic feel to the game and other post-processing effects.
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [zCEffect](zCEffect.md)
+      {: .sp-class}
     - zCVobScreenFX
       {: .sp-class}
         - &lt;empty&gt;
@@ -29,6 +31,8 @@ for a cinematic feel to the game and other post-processing effects.
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [zCEffect](zCEffect.md)
+      {: .sp-class}
     - zCVobScreenFX
       {: .sp-class}
         - &lt;empty&gt;
@@ -38,6 +42,8 @@ for a cinematic feel to the game and other post-processing effects.
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [zCEffect](zCEffect.md)
+      {: .sp-class}
     - zCVobScreenFX
       {: .sp-class}
         - &lt;empty&gt;
@@ -47,6 +53,8 @@ for a cinematic feel to the game and other post-processing effects.
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [zCEffect](zCEffect.md)
+      {: .sp-class}
     - zCVobScreenFX
       {: .sp-class}
         - &lt;empty&gt;