Add documentation for zCEffect

Gothic-Modding-Community · Feb 23, 2024 · 7ea46dd · 7ea46dd
1 parent 23e99f2
commit 7ea46dd
Show file tree

Hide file tree

Showing 6 changed files with 85 additions and 0 deletions.
diff --git a/docs/zengin/worlds/Classes/zCEffect.md b/docs/zengin/worlds/Classes/zCEffect.md
@@ -0,0 +1,45 @@
+# zCEffect
+
+!!! abstract inline end "Quick Infos"
+    **Class Name:** `zCEffect`<br/>
+    **Version Identifiers:**<br />
+    — Gothic I: `12289`<br/>
+    — Gothic II: `52224`
+
+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/zengin/worlds/Classes/zCPFXControler.md b/docs/zengin/worlds/Classes/zCPFXControler.md
@@ -19,6 +19,8 @@ events.
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [zCEffect](zCEffect.md)
+      {: .sp-class}
     - zCPFXController
       {: .sp-class}
         - [pfxName](#pfxname) = ""
@@ -32,6 +34,8 @@ events.
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [zCEffect](zCEffect.md)
+      {: .sp-class}
     - zCPFXController
       {: .sp-class}
         - [pfxName](#pfxname) = ""
@@ -45,6 +49,8 @@ events.
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [zCEffect](zCEffect.md)
+      {: .sp-class}
     - zCPFXController
       {: .sp-class}
         - [pfxName](#pfxname) = ""
@@ -58,6 +64,8 @@ events.
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [zCEffect](zCEffect.md)
+      {: .sp-class}
     - zCPFXController
       {: .sp-class}
         - [pfxName](#pfxname) = ""

diff --git a/docs/zengin/worlds/Classes/zCTouchDamage.md b/docs/zengin/worlds/Classes/zCTouchDamage.md
@@ -18,6 +18,8 @@ A VObject which damages other VObjects colliding with it.
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [zCEffect](zCEffect.md)
+      {: .sp-class}
     - zCTouchDamage
       {: .sp-class}
         - TouchDamage
@@ -53,6 +55,8 @@ A VObject which damages other VObjects colliding with it.
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [zCEffect](zCEffect.md)
+      {: .sp-class}
     - zCTouchDamage
       {: .sp-class}
         - TouchDamage
@@ -88,6 +92,8 @@ A VObject which damages other VObjects colliding with it.
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [zCEffect](zCEffect.md)
+      {: .sp-class}
     - zCTouchDamage
       {: .sp-class}
         - TouchDamage
@@ -123,6 +129,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/zengin/worlds/Classes/zCVobAnimate.md b/docs/zengin/worlds/Classes/zCVobAnimate.md
@@ -21,6 +21,8 @@ and `OnUntrigger` events.
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [zCEffect](zCEffect.md)
+      {: .sp-class}
     - zCVobAnimate
       {: .sp-class}
         - [startOn](#starton) = ""
@@ -30,6 +32,8 @@ and `OnUntrigger` events.
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [zCEffect](zCEffect.md)
+      {: .sp-class}
     - zCVobAnimate
       {: .sp-class}
         - [startOn](#starton) = ""
@@ -39,6 +43,8 @@ and `OnUntrigger` events.
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [zCEffect](zCEffect.md)
+      {: .sp-class}
     - zCVobAnimate
       {: .sp-class}
         - [startOn](#starton) = ""
@@ -50,6 +56,8 @@ and `OnUntrigger` events.
 
     - [zCVob](zCVob.md)
       {: .sp-class}
+    - [zCEffect](zCEffect.md)
+      {: .sp-class}
     - zCVobAnimate
       {: .sp-class}
         - [startOn](#starton) = ""

diff --git a/docs/zengin/worlds/Classes/zCVobLensFlare.md b/docs/zengin/worlds/Classes/zCVobLensFlare.md
@@ -18,6 +18,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) = ""
@@ -27,6 +29,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) = ""
@@ -36,6 +40,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) = ""
@@ -45,6 +51,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/zengin/worlds/Classes/zCVobScreenFX.md b/docs/zengin/worlds/Classes/zCVobScreenFX.md
@@ -19,6 +19,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;
@@ -28,6 +30,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;
@@ -37,6 +41,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;
@@ -46,6 +52,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;