From 5ac4c19f57a8f00a2efa45d534e67e1175c30e32 Mon Sep 17 00:00:00 2001 From: Luis Michaelis Date: Sat, 24 Feb 2024 09:12:10 +0100 Subject: [PATCH] Add the abstract `zCZone` --- .../worlds/Classes/zCVob/zCZone/index.md | 52 +++++++++++++++++++ .../zCVob/{ => zCZone}/oCZoneMusic/index.md | 18 +++++-- .../oCZoneMusic/oCZoneMusicDefault.md | 16 ++++-- .../zCVob/{ => zCZone}/zCVobSound/index.md | 16 ++++-- .../zCVobSound/zCVobSoundDaytime.md | 16 ++++-- .../{ => zCZone}/zCZoneVobFarPlane/index.md | 16 ++++-- .../zCZoneVobFarPlaneDefault.md | 16 ++++-- .../zCVob/{ => zCZone}/zCZoneZFog/index.md | 16 ++++-- .../zCZoneZFog/zCZoneZFogDefault.md | 16 ++++-- 9 files changed, 148 insertions(+), 34 deletions(-) create mode 100644 docs/zengin/worlds/Classes/zCVob/zCZone/index.md rename docs/zengin/worlds/Classes/zCVob/{ => zCZone}/oCZoneMusic/index.md (92%) rename docs/zengin/worlds/Classes/zCVob/{ => zCZone}/oCZoneMusic/oCZoneMusicDefault.md (81%) rename docs/zengin/worlds/Classes/zCVob/{ => zCZone}/zCVobSound/index.md (95%) rename docs/zengin/worlds/Classes/zCVob/{ => zCZone}/zCVobSound/zCVobSoundDaytime.md (90%) rename docs/zengin/worlds/Classes/zCVob/{ => zCZone}/zCZoneVobFarPlane/index.md (83%) rename docs/zengin/worlds/Classes/zCVob/{ => zCZone}/zCZoneVobFarPlane/zCZoneVobFarPlaneDefault.md (82%) rename docs/zengin/worlds/Classes/zCVob/{ => zCZone}/zCZoneZFog/index.md (90%) rename docs/zengin/worlds/Classes/zCVob/{ => zCZone}/zCZoneZFog/zCZoneZFogDefault.md (80%) diff --git a/docs/zengin/worlds/Classes/zCVob/zCZone/index.md b/docs/zengin/worlds/Classes/zCVob/zCZone/index.md new file mode 100644 index 0000000000..4a326afa10 --- /dev/null +++ b/docs/zengin/worlds/Classes/zCVob/zCZone/index.md @@ -0,0 +1,52 @@ +# zCZone + +!!! abstract inline end "Quick Infos" + **Class Name:** `zCZone`
+ **Version Identifiers:**
+ — Gothic I: `12289`
+ — Gothic II: `52224`
+ **Sources:**
+ — [zk.gothickit.dev](https://zk.gothickit.dev/engine/objects/zCZone/) + +The base class for effect zones. + +!!! warning + This object is an abstract base class and cannot be instantiated by itself. + +## Class members + +=== "Gothic 1" + + - [zCVob](../index.md) + {: .sp-class} + - zCZone + {: .sp-class} + - <empty> + {: .sp-empty} + +=== "Gothic 2" + + - [zCVob](../index.md) + {: .sp-class} + - zCZone + {: .sp-class} + - <empty> + {: .sp-empty} + +=== "Gothic 1 (Save)" + + - [zCVob](../index.md) + {: .sp-class} + - zCZone + {: .sp-class} + - <empty> + {: .sp-empty} + +=== "Gothic 2 (Save)" + + - [zCVob](../index.md) + {: .sp-class} + - zCZone + {: .sp-class} + - <empty> + {: .sp-empty} diff --git a/docs/zengin/worlds/Classes/zCVob/oCZoneMusic/index.md b/docs/zengin/worlds/Classes/zCVob/zCZone/oCZoneMusic/index.md similarity index 92% rename from docs/zengin/worlds/Classes/zCVob/oCZoneMusic/index.md rename to docs/zengin/worlds/Classes/zCVob/zCZone/oCZoneMusic/index.md index 2af299a37e..7cb69e17fa 100644 --- a/docs/zengin/worlds/Classes/zCVob/oCZoneMusic/index.md +++ b/docs/zengin/worlds/Classes/zCVob/zCZone/oCZoneMusic/index.md @@ -15,7 +15,7 @@ A VObject which defines the music to be played within its bounding box. Music zo music zone applies. If no music zone applies the music defined in the optional [`oCZoneMusicDefault`](oCZoneMusicDefault.md) is used. -The name of the music theme to be played is defined by the [`vobName`](../index.md#vobname). +The name of the music theme to be played is defined by the [`vobName`](../../index.md#vobname). !!! tip If the suffix `_NCI` or `_NCO` is added to the end of the zone name, it snows instead of rains in the zone. @@ -24,7 +24,9 @@ The name of the music theme to be played is defined by the [`vobName`](../index. === "Gothic 1" - - [zCVob](../index.md) + - [zCVob](../../index.md) + {: .sp-class} + - [*zCZone*](../index.md) {: .sp-class} - oCZoneMusic {: .sp-class} @@ -43,7 +45,9 @@ The name of the music theme to be played is defined by the [`vobName`](../index. === "Gothic 2" - - [zCVob](../index.md) + - [zCVob](../../index.md) + {: .sp-class} + - [*zCZone*](../index.md) {: .sp-class} - oCZoneMusic {: .sp-class} @@ -62,7 +66,9 @@ The name of the music theme to be played is defined by the [`vobName`](../index. === "Gothic 1 (Save)" - - [zCVob](../index.md) + - [zCVob](../../index.md) + {: .sp-class} + - [*zCZone*](../index.md) {: .sp-class} - oCZoneMusic {: .sp-class} @@ -87,7 +93,9 @@ The name of the music theme to be played is defined by the [`vobName`](../index. === "Gothic 2 (Save)" - - [zCVob](../index.md) + - [zCVob](../../index.md) + {: .sp-class} + - [*zCZone*](../index.md) {: .sp-class} - oCZoneMusic {: .sp-class} diff --git a/docs/zengin/worlds/Classes/zCVob/oCZoneMusic/oCZoneMusicDefault.md b/docs/zengin/worlds/Classes/zCVob/zCZone/oCZoneMusic/oCZoneMusicDefault.md similarity index 81% rename from docs/zengin/worlds/Classes/zCVob/oCZoneMusic/oCZoneMusicDefault.md rename to docs/zengin/worlds/Classes/zCVob/zCZone/oCZoneMusic/oCZoneMusicDefault.md index fa3a321c67..0039ebfb14 100644 --- a/docs/zengin/worlds/Classes/zCVob/oCZoneMusic/oCZoneMusicDefault.md +++ b/docs/zengin/worlds/Classes/zCVob/zCZone/oCZoneMusic/oCZoneMusicDefault.md @@ -16,7 +16,9 @@ volume-related options of the zone are ignored. There may only be one `oCZoneMus === "Gothic 1" - - [zCVob](../index.md) + - [zCVob](../../index.md) + {: .sp-class} + - [*zCZone*](../index.md) {: .sp-class} - [oCZoneMusic](index.md) {: .sp-class} @@ -27,7 +29,9 @@ volume-related options of the zone are ignored. There may only be one `oCZoneMus === "Gothic 2" - - [zCVob](../index.md) + - [zCVob](../../index.md) + {: .sp-class} + - [*zCZone*](../index.md) {: .sp-class} - [oCZoneMusic](index.md) {: .sp-class} @@ -38,7 +42,9 @@ volume-related options of the zone are ignored. There may only be one `oCZoneMus === "Gothic 1 (Save)" - - [zCVob](../index.md) + - [zCVob](../../index.md) + {: .sp-class} + - [*zCZone*](../index.md) {: .sp-class} - [oCZoneMusic](index.md) {: .sp-class} @@ -49,7 +55,9 @@ volume-related options of the zone are ignored. There may only be one `oCZoneMus === "Gothic 2 (Save)" - - [zCVob](../index.md) + - [zCVob](../../index.md) + {: .sp-class} + - [*zCZone*](../index.md) {: .sp-class} - [oCZoneMusic](index.md) {: .sp-class} diff --git a/docs/zengin/worlds/Classes/zCVob/zCVobSound/index.md b/docs/zengin/worlds/Classes/zCVob/zCZone/zCVobSound/index.md similarity index 95% rename from docs/zengin/worlds/Classes/zCVob/zCVobSound/index.md rename to docs/zengin/worlds/Classes/zCVob/zCZone/zCVobSound/index.md index b11f2b83a9..37241122fd 100644 --- a/docs/zengin/worlds/Classes/zCVob/zCVobSound/index.md +++ b/docs/zengin/worlds/Classes/zCVob/zCZone/zCVobSound/index.md @@ -17,7 +17,9 @@ Emits a sound defined by a script instance in a given radius. The sound playback === "Gothic 1" - - [zCVob](../index.md) + - [zCVob](../../index.md) + {: .sp-class} + - [*zCZone*](../index.md) {: .sp-class} - zCVobSound {: .sp-class} @@ -48,7 +50,9 @@ Emits a sound defined by a script instance in a given radius. The sound playback === "Gothic 2" - - [zCVob](../index.md) + - [zCVob](../../index.md) + {: .sp-class} + - [*zCZone*](../index.md) {: .sp-class} - zCVobSound {: .sp-class} @@ -79,7 +83,9 @@ Emits a sound defined by a script instance in a given radius. The sound playback === "Gothic 1 (Save)" - - [zCVob](../index.md) + - [zCVob](../../index.md) + {: .sp-class} + - [*zCZone*](../index.md) {: .sp-class} - zCVobSound {: .sp-class} @@ -114,7 +120,9 @@ Emits a sound defined by a script instance in a given radius. The sound playback === "Gothic 2 (Save)" - - [zCVob](../index.md) + - [zCVob](../../index.md) + {: .sp-class} + - [*zCZone*](../index.md) {: .sp-class} - zCVobSound {: .sp-class} diff --git a/docs/zengin/worlds/Classes/zCVob/zCVobSound/zCVobSoundDaytime.md b/docs/zengin/worlds/Classes/zCVob/zCZone/zCVobSound/zCVobSoundDaytime.md similarity index 90% rename from docs/zengin/worlds/Classes/zCVob/zCVobSound/zCVobSoundDaytime.md rename to docs/zengin/worlds/Classes/zCVob/zCZone/zCVobSound/zCVobSoundDaytime.md index 05548688d9..89de36d45e 100644 --- a/docs/zengin/worlds/Classes/zCVob/zCVobSound/zCVobSoundDaytime.md +++ b/docs/zengin/worlds/Classes/zCVob/zCZone/zCVobSound/zCVobSoundDaytime.md @@ -17,7 +17,9 @@ sound can be defined which is played outside the defined time range (example: bi === "Gothic 1" - - [zCVob](../index.md) + - [zCVob](../../index.md) + {: .sp-class} + - [*zCZone*](../index.md) {: .sp-class} - [zCVobSound](index.md) {: .sp-class} @@ -34,7 +36,9 @@ sound can be defined which is played outside the defined time range (example: bi === "Gothic 2" - - [zCVob](../index.md) + - [zCVob](../../index.md) + {: .sp-class} + - [*zCZone*](../index.md) {: .sp-class} - [zCVobSound](index.md) {: .sp-class} @@ -51,7 +55,9 @@ sound can be defined which is played outside the defined time range (example: bi === "Gothic 1 (Save)" - - [zCVob](../index.md) + - [zCVob](../../index.md) + {: .sp-class} + - [*zCZone*](../index.md) {: .sp-class} - [zCVobSound](index.md) {: .sp-class} @@ -68,7 +74,9 @@ sound can be defined which is played outside the defined time range (example: bi === "Gothic 2 (Save)" - - [zCVob](../index.md) + - [zCVob](../../index.md) + {: .sp-class} + - [*zCZone*](../index.md) {: .sp-class} - [zCVobSound](index.md) {: .sp-class} diff --git a/docs/zengin/worlds/Classes/zCVob/zCZoneVobFarPlane/index.md b/docs/zengin/worlds/Classes/zCVob/zCZone/zCZoneVobFarPlane/index.md similarity index 83% rename from docs/zengin/worlds/Classes/zCVob/zCZoneVobFarPlane/index.md rename to docs/zengin/worlds/Classes/zCVob/zCZone/zCZoneVobFarPlane/index.md index 055a7a6ef2..2b95f7d1de 100644 --- a/docs/zengin/worlds/Classes/zCVob/zCZoneVobFarPlane/index.md +++ b/docs/zengin/worlds/Classes/zCVob/zCZone/zCZoneVobFarPlane/index.md @@ -15,7 +15,9 @@ A VObject which defines the loading range of VObjects within its bounding box. === "Gothic 1" - - [zCVob](../index.md) + - [zCVob](../../index.md) + {: .sp-class} + - [*zCZone*](../index.md) {: .sp-class} - zCZoneVobFarPlane {: .sp-class} @@ -26,7 +28,9 @@ A VObject which defines the loading range of VObjects within its bounding box. === "Gothic 2" - - [zCVob](../index.md) + - [zCVob](../../index.md) + {: .sp-class} + - [*zCZone*](../index.md) {: .sp-class} - zCZoneVobFarPlane {: .sp-class} @@ -37,7 +41,9 @@ A VObject which defines the loading range of VObjects within its bounding box. === "Gothic 1 (Save)" - - [zCVob](../index.md) + - [zCVob](../../index.md) + {: .sp-class} + - [*zCZone*](../index.md) {: .sp-class} - zCZoneVobFarPlane {: .sp-class} @@ -48,7 +54,9 @@ A VObject which defines the loading range of VObjects within its bounding box. === "Gothic 2 (Save)" - - [zCVob](../index.md) + - [zCVob](../../index.md) + {: .sp-class} + - [*zCZone*](../index.md) {: .sp-class} - zCZoneVobFarPlane {: .sp-class} diff --git a/docs/zengin/worlds/Classes/zCVob/zCZoneVobFarPlane/zCZoneVobFarPlaneDefault.md b/docs/zengin/worlds/Classes/zCVob/zCZone/zCZoneVobFarPlane/zCZoneVobFarPlaneDefault.md similarity index 82% rename from docs/zengin/worlds/Classes/zCVob/zCZoneVobFarPlane/zCZoneVobFarPlaneDefault.md rename to docs/zengin/worlds/Classes/zCVob/zCZone/zCZoneVobFarPlane/zCZoneVobFarPlaneDefault.md index 31e9532c72..4ee6e429d4 100644 --- a/docs/zengin/worlds/Classes/zCVob/zCZoneVobFarPlane/zCZoneVobFarPlaneDefault.md +++ b/docs/zengin/worlds/Classes/zCVob/zCZone/zCZoneVobFarPlane/zCZoneVobFarPlaneDefault.md @@ -17,7 +17,9 @@ objects in each world. Its effect can be overridden using [zCZoneVobFarPlane](in === "Gothic 1" - - [zCVob](../index.md) + - [zCVob](../../index.md) + {: .sp-class} + - [*zCZone*](../index.md) {: .sp-class} - [zCZoneVobFarPlane](index.md) {: .sp-class} @@ -28,9 +30,9 @@ objects in each world. Its effect can be overridden using [zCZoneVobFarPlane](in === "Gothic 2" - - [zCVob](../index.md) + - [zCVob](../../index.md) {: .sp-class} - - [zCZoneVobFarPlane](index.md) + - [*zCZone*](../index.md) {: .sp-class} - zCZoneVobFarPlane {: .sp-class} @@ -39,7 +41,9 @@ objects in each world. Its effect can be overridden using [zCZoneVobFarPlane](in === "Gothic 1 (Save)" - - [zCVob](../index.md) + - [zCVob](../../index.md) + {: .sp-class} + - [*zCZone*](../index.md) {: .sp-class} - [zCZoneVobFarPlane](index.md) {: .sp-class} @@ -50,7 +54,9 @@ objects in each world. Its effect can be overridden using [zCZoneVobFarPlane](in === "Gothic 2 (Save)" - - [zCVob](../index.md) + - [zCVob](../../index.md) + {: .sp-class} + - [*zCZone*](../index.md) {: .sp-class} - [zCZoneVobFarPlane](index.md) {: .sp-class} diff --git a/docs/zengin/worlds/Classes/zCVob/zCZoneZFog/index.md b/docs/zengin/worlds/Classes/zCVob/zCZone/zCZoneZFog/index.md similarity index 90% rename from docs/zengin/worlds/Classes/zCVob/zCZoneZFog/index.md rename to docs/zengin/worlds/Classes/zCVob/zCZone/zCZoneZFog/index.md index 05a634e35d..d6a7a2d333 100644 --- a/docs/zengin/worlds/Classes/zCVob/zCZoneZFog/index.md +++ b/docs/zengin/worlds/Classes/zCVob/zCZone/zCZoneZFog/index.md @@ -15,7 +15,9 @@ A VObject which causes fog to appear within its bounding box. === "Gothic 1" - - [zCVob](../index.md) + - [zCVob](../../index.md) + {: .sp-class} + - [*zCZone*](../index.md) {: .sp-class} - zCZoneZFog {: .sp-class} @@ -30,7 +32,9 @@ A VObject which causes fog to appear within its bounding box. === "Gothic 2" - - [zCVob](../index.md) + - [zCVob](../../index.md) + {: .sp-class} + - [*zCZone*](../index.md) {: .sp-class} - zCZoneZFog {: .sp-class} @@ -49,7 +53,9 @@ A VObject which causes fog to appear within its bounding box. === "Gothic 1 (Save)" - - [zCVob](../index.md) + - [zCVob](../../index.md) + {: .sp-class} + - [*zCZone*](../index.md) {: .sp-class} - zCZoneZFog {: .sp-class} @@ -64,7 +70,9 @@ A VObject which causes fog to appear within its bounding box. === "Gothic 2 (Save)" - - [zCVob](../index.md) + - [zCVob](../../index.md) + {: .sp-class} + - [*zCZone*](../index.md) {: .sp-class} - zCZoneZFog {: .sp-class} diff --git a/docs/zengin/worlds/Classes/zCVob/zCZoneZFog/zCZoneZFogDefault.md b/docs/zengin/worlds/Classes/zCVob/zCZone/zCZoneZFog/zCZoneZFogDefault.md similarity index 80% rename from docs/zengin/worlds/Classes/zCVob/zCZoneZFog/zCZoneZFogDefault.md rename to docs/zengin/worlds/Classes/zCVob/zCZone/zCZoneZFog/zCZoneZFogDefault.md index 98ca0709a5..35fbf912ea 100644 --- a/docs/zengin/worlds/Classes/zCVob/zCZoneZFog/zCZoneZFogDefault.md +++ b/docs/zengin/worlds/Classes/zCVob/zCZone/zCZoneZFog/zCZoneZFogDefault.md @@ -16,7 +16,9 @@ Its effect can be overridden using [zCZoneZFog](index.md) objects. === "Gothic 1" - - [zCVob](../index.md) + - [zCVob](../../index.md) + {: .sp-class} + - [*zCZone*](../index.md) {: .sp-class} - [zCZoneZFog](index.md) {: .sp-class} @@ -27,7 +29,9 @@ Its effect can be overridden using [zCZoneZFog](index.md) objects. === "Gothic 2" - - [zCVob](../index.md) + - [zCVob](../../index.md) + {: .sp-class} + - [*zCZone*](../index.md) {: .sp-class} - [zCZoneZFog](index.md) {: .sp-class} @@ -38,7 +42,9 @@ Its effect can be overridden using [zCZoneZFog](index.md) objects. === "Gothic 1 (Save)" - - [zCVob](../index.md) + - [zCVob](../../index.md) + {: .sp-class} + - [*zCZone*](../index.md) {: .sp-class} - [zCZoneZFog](index.md) {: .sp-class} @@ -49,7 +55,9 @@ Its effect can be overridden using [zCZoneZFog](index.md) objects. === "Gothic 2 (Save)" - - [zCVob](../index.md) + - [zCVob](../../index.md) + {: .sp-class} + - [*zCZone*](../index.md) {: .sp-class} - [zCZoneZFog](index.md) {: .sp-class}