Skip to content

Commit

Permalink
Add documentation for zCTriggerWorldStart
Browse files Browse the repository at this point in the history
  • Loading branch information
lmichaelis committed Feb 23, 2024
1 parent 9f6929e commit 63fe3a9
Showing 1 changed file with 73 additions and 0 deletions.
73 changes: 73 additions & 0 deletions docs/zengin/worlds/Classes/zCTriggerWorldStart.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
# zCTriggerWorldStart

!!! abstract inline end "Quick Infos"
**Class Name:** `zCTriggerWorldStart`<br/>
**Version Identifiers:**<br />
— Gothic I: `52224`<br/>
— Gothic II: `52224`<br/>
**Sources:**<br/>
[spacerhilfedatei.sph](https://wiki.worldofgothic.de/doku.php?id=spacer:hilfedatei)<br/>
[zk.gothickit.dev](https://zk.gothickit.dev/engine/objects/zCTriggerUntouch/)

A special trigger which fires an `OnTrigger` event to its [target](#triggertarget) when the world is loaded and started.

## Class members

=== "Gothic 1"

- [zCVob](zCVob.md)
{: .sp-class}
- zCTriggerWorldStart
{: .sp-class}
- [triggerTarget](#triggertarget) = ""
{: .sp-string}
- [fireOnlyFirstTime](#fireonlyfirsttime) = FALSE
{: .sp-bool}

=== "Gothic 2"

- [zCVob](zCVob.md)
{: .sp-class}
- zCTriggerWorldStart
{: .sp-class}
- [triggerTarget](#triggertarget) = ""
{: .sp-string}
- [fireOnlyFirstTime](#fireonlyfirsttime) = FALSE
{: .sp-bool}

=== "Gothic 1 (Save)"

- [zCVob](zCVob.md)
{: .sp-class}
- zCTriggerWorldStart
{: .sp-class}
- [triggerTarget](#triggertarget) = ""
{: .sp-string}
- [fireOnlyFirstTime](#fireonlyfirsttime) = FALSE
{: .sp-bool}

=== "Gothic 2 (Save)"

- [zCVob](zCVob.md)
{: .sp-class}
- zCTriggerWorldStart
{: .sp-class}
- [triggerTarget](#triggertarget) = ""
{: .sp-string}
- [fireOnlyFirstTime](#fireonlyfirsttime) = FALSE
{: .sp-bool}

## Class member overview

### `triggerTarget` {: .sp-string}

The name of VObject to send an `OnTrigger` event to when the world is loaded and started.

### `fireOnlyFirstTime` {: .sp-bool}

Determines whether to fire the `OnTrigger` event only the first time the world is loaded.

**Accepted values:**

* `TRUE` — Only fire the event if this is the first time the world is loaded.
* `FALSE` — Fire the event every time the world is loaded.

0 comments on commit 63fe3a9

Please sign in to comment.