Merge pull request #120 from muczc1wek/vobs

[Worlds] Missing vob classes documentation ( zCTriggerTeleport, zCTouchAnimate, zCTouchAnimateSound)
Gothic-Modding-Community · Jun 28, 2024 · a56914d · a56914d
2 parents 4f73579 + c8a7837
commit a56914d
Show file tree

Hide file tree

Showing 3 changed files with 222 additions and 0 deletions.
diff --git a/docs/zengin/worlds/Classes/zCVob/zCEffect/zCTouchAnimate/index.md b/docs/zengin/worlds/Classes/zCVob/zCEffect/zCTouchAnimate/index.md
@@ -0,0 +1,66 @@
+# zCTouchAnimate
+
+!!! abstract inline end "Quick Infos"
+    **Class Name:** `zCTouchAnimate`<br/>
+    **Version Identifiers:**<br />
+    — Gothic I: `12289`<br/>
+    — Gothic II: `20483`<br/>
+    **Sources:**<br/>
+    — [spacerhilfedatei.sph](https://wiki.worldofgothic.de/doku.php?id=spacer:hilfedatei)<br/>
+    — [gothic-library.ru](http://gothic-library.ucoz.org/publ/zctouchanimate/1-1-0-519)
+
+
+A VObject that plays its animation when it receives an `OnTick` event (basically when something touches it).
+
+## Class members
+
+=== "Gothic 1"
+
+    - [zCVob](../../index.md)
+      {: .sp-class}
+    - [*zCEffect*](../index.md)
+      {: .sp-class}
+    - zCTouchAnimate
+      {: .sp-class}
+        - &lt;empty&gt;
+          {: .sp-empty}
+
+=== "Gothic 2"
+
+    - [zCVob](../../index.md)
+      {: .sp-class}
+    - [*zCEffect*](../index.md)
+      {: .sp-class}
+    - zCTouchAnimate
+      {: .sp-class}
+        - &lt;empty&gt;
+          {: .sp-empty}
+
+=== "Gothic 1 (Save)"
+
+    - [zCVob](../../index.md)
+      {: .sp-class}
+    - [*zCEffect*](../index.md)
+      {: .sp-class}
+    - zCTouchAnimate
+      {: .sp-class}
+        - &lt;empty&gt;
+          {: .sp-empty}
+
+=== "Gothic 2 (Save)"
+
+    - [zCVob](../../index.md)
+      {: .sp-class}
+    - [*zCEffect*](../index.md)
+      {: .sp-class}
+    - zCTouchAnimate
+      {: .sp-class}
+        - &lt;empty&gt;
+          {: .sp-empty}
+
+## Presentation
+Following video shows the behaviour of this VObject.
+
+![type:video](https://youtube.com/embed/ad6ECvO7EbY)
+
+
diff --git a/docs/zengin/worlds/Classes/zCVob/zCEffect/zCTouchAnimate/zCTouchAnimateSound.md b/docs/zengin/worlds/Classes/zCVob/zCEffect/zCTouchAnimate/zCTouchAnimateSound.md
@@ -0,0 +1,79 @@
+# zCTouchAnimateSound
+
+!!! abstract inline end "Quick Infos"
+    **Class Name:** `zCTouchAnimateSound`<br/>
+    **Version Identifiers:**<br />
+    — Gothic I: `12289`<br/>
+    — Gothic II: `20483`<br/>
+    **Sources:**<br/>
+    — [spacerhilfedatei.sph](https://wiki.worldofgothic.de/doku.php?id=spacer:hilfedatei)<br/>
+    — [gothic-library.ru](http://gothic-library.ucoz.org/publ/1-1-0-520)
+
+
+Object similar to [`zCTouchAnimate`](../index.md), but allowing to specify a sound that plays on the event activation.
+
+## Class members
+
+=== "Gothic 1"
+
+    - [zCVob](../../index.md)
+      {: .sp-class}
+    - [*zCEffect*](../index.md)
+      {: .sp-class}
+    - [zCTouchAnimate](index.md)
+      {: .sp-class}
+    - zCTouchAnimateSound
+      {: .sp-class}
+        - [sfxTouch](#sfxtouch)
+        {: .sp-string}
+
+=== "Gothic 2"
+
+    - [zCVob](../../index.md)
+      {: .sp-class}
+    - [*zCEffect*](../index.md)
+      {: .sp-class}
+    - [zCTouchAnimate](index.md)
+      {: .sp-class}
+    - zCTouchAnimateSound
+      {: .sp-class}
+        - [sfxTouch](#sfxtouch)
+        {: .sp-string}
+
+=== "Gothic 1 (Save)"
+
+    - [zCVob](../../index.md)
+      {: .sp-class}
+    - [*zCEffect*](../index.md)
+      {: .sp-class}
+    - [zCTouchAnimate](index.md)
+      {: .sp-class}
+    - zCTouchAnimateSound
+      {: .sp-class}
+        - [sfxTouch](#sfxtouch)
+        {: .sp-string}
+
+=== "Gothic 2 (Save)"
+
+    - [zCVob](../../index.md)
+      {: .sp-class}
+    - [*zCEffect*](../index.md)
+      {: .sp-class}
+    - [zCTouchAnimate](index.md)
+      {: .sp-class}
+    - zCTouchAnimateSound
+      {: .sp-class}
+        - [sfxTouch](#sfxtouch)
+        {: .sp-string}
+
+## Class member overview
+
+### `sfxTouch` {: .sp-string}
+The name of the sound produced upon contact with an object.
+
+## Presentation
+Following video shows the behaviour of this VObject.
+
+![type:video](https://youtube.com/embed/47ToeRNHKIU)
+
+
diff --git a/docs/zengin/worlds/Classes/zCVob/zCTriggerBase/zCTrigger/zCTriggerTeleport.md b/docs/zengin/worlds/Classes/zCVob/zCTriggerBase/zCTrigger/zCTriggerTeleport.md
@@ -0,0 +1,77 @@
+# zCTriggerTeleport
+
+!!! abstract inline end "Quick Infos"
+    **Class Name:** `zCTriggerTeleport`<br/>
+    **Version Identifiers:**<br />
+    — Gothic I: `59776`<br/>
+    — Gothic II: `45570`<br/>
+    **Sources:**<br/>
+    — [spacerhilfedatei.sph](https://wiki.worldofgothic.de/doku.php?id=spacer:hilfedatei)<br/>
+    — [gothic-library.ru](http://www.gothic-library.ru/publ/class_zctriggerteleport/1-1-0-535)
+
+This VObject allows teleporting a hero to the waypoint.
+
+!!! Note
+    To make trigger work, you must set the value of the [`cdDyn`](../../index.md#cddyn) parameter to `True` and specify the Waypoint in [`triggerTarget`](../index.md#triggertarget) parameter.
+
+
+## Class members
+
+=== "Gothic 1"
+
+    - [zCVob](../../index.md)
+      {: .sp-class}
+    - [*zCTriggerBase*](../index.md)
+      {: .sp-class}
+    - [zCTrigger](index.md)
+      {: .sp-class}
+    - zCTriggerTeleport
+      {: .sp-class}
+        - [sfxTeleport](#sfxteleport) = LP_ALL
+          {: .sp-string}
+
+=== "Gothic 2"
+
+    - [zCVob](../../index.md)
+      {: .sp-class}
+    - [*zCTriggerBase*](../index.md)
+      {: .sp-class}
+    - [zCTrigger](index.md)
+      {: .sp-class}
+    - zCTriggerTeleport
+      {: .sp-class}
+        - [sfxTeleport](#sfxteleport) = LP_ALL
+          {: .sp-string}
+
+=== "Gothic 1 (Save)"
+
+    - [zCVob](../../index.md)
+      {: .sp-class}
+    - [*zCTriggerBase*](../index.md)
+      {: .sp-class}
+    - [zCTrigger](index.md)
+      {: .sp-class}
+    - zCTriggerTeleport
+      {: .sp-class}
+        - [sfxTeleport](#sfxteleport) = LP_ALL
+          {: .sp-string}
+
+=== "Gothic 2 (Save)"
+
+    - [zCVob](../../index.md)
+      {: .sp-class}
+    - [*zCTriggerBase*](../index.md)
+      {: .sp-class}
+    - [zCTrigger](index.md)
+      {: .sp-class}
+    - zCTriggerTeleport
+      {: .sp-class}
+        - [sfxTeleport](#sfxteleport) = LP_ALL
+          {: .sp-string}
+
+
+## Class member overview
+
+### `sfxTeleport` {: .sp-string}
+
+Sound accompaniment of character teleport.