Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Worlds] Missing vob classes documentation ( zCTriggerTeleport, zCTouchAnimate, zCTouchAnimateSound) #120

Merged
merged 3 commits into from
Jun 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 66 additions & 0 deletions docs/zengin/worlds/Classes/zCVob/zCEffect/zCTouchAnimate/index.md
Original file line number Diff line number Diff line change
@@ -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)


Original file line number Diff line number Diff line change
@@ -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)


Original file line number Diff line number Diff line change
@@ -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.