docs(objects): migrate initial batch of files to doc generator

docs/engine/objects/oCCSTrigger.md

@@ -1,27 +1,24 @@
-# oCCSTrigger
+# `oCCSTrigger`
 
 !!! abstract inline end "Quick Infos"
-    **Type:** Virtual Object<br/>
+    **Type:** Object<br/>
     **Format Name:** ZenGin Archive<br/>
     **File Extension:** `.ZEN`<br/>
     **Class Name:** `oCCSTrigger`<br/>
     **Version Identifiers:**<br />
     — Gothic I: `24577`<br/>
     — Gothic II: `24577`<br/>
-    **ZenKit Class:** `VCutsceneTrigger`<br/>
+    **ZenKit Class:** `VCutsceneTrigger` <br/>
     **Sources:**<br/>
-    — [spacerhilfedatei.sph](https://wiki.worldofgothic.de/doku.php?id=spacer:hilfedatei)<br/>
+    — [spacerhilfedatei.sph](https://wiki.worldofgothic.de/doku.php?id=spacer:hilfedatei)<br />
     — [gothic-library.ru](http://www.gothic-library.ru/publ/class_occstrigger/1-1-0-530)
 
-A special trigger VObject which can start a cutscene. The [`triggerTarget`](zCTrigger.md#triggerTarget) must be the
-name of the cutscene (without the extension) to be started. For this to work, the cutscene must already be loaded.
-`OnUntrigger` events are ignored by `oCCSTrigger`s.
+A special trigger VObject which can start a cutscene. The [`zCTriggerBase:triggerTarget`](zCTriggerBase.md#triggertarget) must be the name of the cutscene (without the extension) to be started. For this to work, the cutscene must already be loaded. `OnUntrigger` events are ignored by `oCCSTrigger`s. 
 
 === "Gothic 1"
-
     - [zCVob](zCVob.md)
       {: .sp-class}
-    - [*zCTriggerBase*](zCTriggerBase.md)
+    - [zCTriggerBase](zCTriggerBase.md)
       {: .sp-class}
     - [zCTrigger](zCTrigger.md)
       {: .sp-class}
@@ -31,10 +28,9 @@ name of the cutscene (without the extension) to be started. For this to work, th
           {: .sp-none}
 
 === "Gothic 2"
-
     - [zCVob](zCVob.md)
       {: .sp-class}
-    - [*zCTriggerBase*](zCTriggerBase.md)
+    - [zCTriggerBase](zCTriggerBase.md)
       {: .sp-class}
     - [zCTrigger](zCTrigger.md)
       {: .sp-class}
@@ -44,10 +40,9 @@ name of the cutscene (without the extension) to be started. For this to work, th
           {: .sp-none}
 
 === "Gothic 1 (Save)"
-
     - [zCVob](zCVob.md)
       {: .sp-class}
-    - [*zCTriggerBase*](zCTriggerBase.md)
+    - [zCTriggerBase](zCTriggerBase.md)
       {: .sp-class}
     - [zCTrigger](zCTrigger.md)
       {: .sp-class}
@@ -57,14 +52,14 @@ name of the cutscene (without the extension) to be started. For this to work, th
           {: .sp-none}
 
 === "Gothic 2 (Save)"
-
     - [zCVob](zCVob.md)
       {: .sp-class}
-    - [*zCTriggerBase*](zCTriggerBase.md)
+    - [zCTriggerBase](zCTriggerBase.md)
       {: .sp-class}
     - [zCTrigger](zCTrigger.md)
       {: .sp-class}
     - oCCSTrigger
       {: .sp-class}
         - &lt;empty&gt;
           {: .sp-none}
+

docs/engine/objects/oCCSTrigger.yml

@@ -0,0 +1,19 @@
+class:
+  name: "oCCSTrigger"
+  bases: [
+      "zCVob",
+      "zCTriggerBase",
+      "zCTrigger",
+  ]
+  description: |
+    A special trigger VObject which can start a cutscene. The [zCTriggerBase:triggerTarget] must be the name
+    of the cutscene (without the extension) to be started. For this to work, the cutscene must already be loaded.
+    `OnUntrigger` events are ignored by `oCCSTrigger`s.
+  zenkit: "VCutsceneTrigger"
+version:
+  gothic1: 24577
+  gothic2: 24577
+sources:
+  spacerhilfedatei.sph: "https://wiki.worldofgothic.de/doku.php?id=spacer:hilfedatei"
+  gothic-library.ru: "http://www.gothic-library.ru/publ/class_occstrigger/1-1-0-530"
+

docs/engine/objects/oCInfo.md

@@ -1,4 +1,4 @@
-# oCInfo
+# `oCInfo`
 
 !!! abstract inline end "Quick Infos"
     **Type:** Object<br/>
@@ -8,53 +8,51 @@
     **Version Identifiers:**<br />
     — Gothic I: `0`<br/>
     — Gothic II: `0`<br/>
-    **ZenKit Class:** *—*
+    **ZenKit Class:** `—` 
 
 === "Gothic 1"
-
     - oCInfo
       {: .sp-class}
         - &lt;empty&gt;
           {: .sp-none}
 
 === "Gothic 2"
-
     - oCInfo
       {: .sp-class}
         - &lt;empty&gt;
           {: .sp-none}
 
 === "Gothic 1 (Save)"
-
     - oCInfo
       {: .sp-class}
         - [Told](#told) = FALSE
           {: .sp-bool}
-        - [InstName](#instname) = ""
+        - [InstName](#instname) = 
           {: .sp-string}
 
 === "Gothic 2 (Save)"
-
     - oCInfo
       {: .sp-class}
         - [Told](#told) = FALSE
           {: .sp-bool}
-        - [InstName](#instname) = ""
+        - [InstName](#instname) = 
           {: .sp-string}
 
 ## Properties
 
 #### `Told` {: .sp-bool}
 
-:   Whether the hero  has already been told this info.
+:   Whether the hero has already been told this info.
 
+    * `False` — The info has not yet been told.
+    * `True` — The info has already been told.
     !!! warning
         This property is only available in saved games.
 
-
-#### `InstName` {: .sp-bool}
+#### `InstName` {: .sp-string}
 
 :   The name of the script instance representing this info.
 
     !!! warning
         This property is only available in saved games.
+

docs/engine/objects/oCInfo.yml

@@ -0,0 +1,24 @@
+class:
+  name: "oCInfo"
+  bases: []
+  description: ""
+  zenkit: "—"
+version:
+  gothic1: 0
+  gothic2: 0
+properties:
+  Told:
+    type: "bool"
+    description: "Whether the hero has already been told this info."
+    default: "FALSE"
+    version: [1, 2]
+    save: true
+    options:
+      FALSE: "The info has not yet been told."
+      TRUE: "The info has already been told."
+  InstName:
+    type: "string"
+    description: "The name of the script instance representing this info."
+    default: ""
+    version: [1, 2]
+    save: true

docs/engine/objects/oCInfoManager.md

@@ -1,4 +1,4 @@
-# oCInfoManager
+# `oCInfoManager`
 
 !!! abstract inline end "Quick Infos"
     **Type:** Object<br/>
@@ -8,38 +8,34 @@
     **Version Identifiers:**<br />
     — Gothic I: `0`<br/>
     — Gothic II: `0`<br/>
-    **ZenKit Class:** *—*
+    **ZenKit Class:** `—` 
 
 === "Gothic 1"
-
     - oCInfoManager
       {: .sp-class}
         - &lt;empty&gt;
           {: .sp-none}
 
 === "Gothic 2"
-
     - oCInfoManager
       {: .sp-class}
         - &lt;empty&gt;
           {: .sp-none}
 
 === "Gothic 1 (Save)"
-
     - oCInfoManager
       {: .sp-class}
         - [NumOfEntries](#numofentries) = 0
           {: .sp-int}
-        - (inline)[^1] [oCInfo](oCInfo.md) ...
+        - [oCInfo](oCInfo.md) ... = NULL
           {: .sp-class}
 
 === "Gothic 2 (Save)"
-
     - oCInfoManager
       {: .sp-class}
         - [NumOfEntries](#numofentries) = 0
           {: .sp-int}
-        - (inline)[^1] [oCInfo](oCInfo.md) ...
+        - [oCInfo](oCInfo.md) ... = NULL
           {: .sp-class}
 
 ## Properties
@@ -51,5 +47,3 @@
     !!! warning
         This property is only available in saved games.
 
-[^1]: "Inline" means, that these objects are not wrapped in an archive object. Rather, their contents are simply
-      all written to the parent object directly without encapsulation.

docs/engine/objects/oCInfoManager.yml

@@ -0,0 +1,21 @@
+class:
+  name: "oCInfoManager"
+  bases: []
+  description: ""
+  zenkit: "—"
+version:
+  gothic1: 0
+  gothic2: 0
+properties:
+  NumOfEntries:
+    type: "int"
+    description: "The number of saved [oCInfo] objects."
+    default: "0"
+    version: [1, 2]
+    save: true
+  oCInfo:
+    type: "class"
+    default: "NULL"
+    version: [1, 2]
+    save: true
+    multi: true

docs/engine/objects/oCItem.md

@@ -1,70 +1,65 @@
-# oCItem
+# `oCItem`
 
 !!! abstract inline end "Quick Infos"
-    **Type:** Virtual Object<br/>
+    **Type:** Object<br/>
     **Format Name:** ZenGin Archive<br/>
     **File Extension:** `.ZEN`<br/>
     **Class Name:** `oCItem`<br/>
     **Version Identifiers:**<br />
     — Gothic I: `0`<br/>
     — Gothic II: `0`<br/>
-    **ZenKit Class:** `VItem`<br/>
+    **ZenKit Class:** `—` <br/>
     **Sources:**<br/>
     — [gothic-library.ru](http://www.gothic-library.ru/publ/class_occstrigger/1-1-0-530)
 
-Represents an item in the game world. Items are special VObjects which are tied to a script instance which defines
-their attributes. They have physics enabled and can be targeted and picked up by the player.
+Represents an item in the game world. Items are special VObjects which are tied to a script instance which defines their attributes. They have physics enabled and can be targeted and picked up by the player. 
 
 === "Gothic 1"
-
     - [zCVob](zCVob.md)
       {: .sp-class}
     - [oCVob](oCVob.md)
       {: .sp-class}
     - oCItem
       {: .sp-class}
-        - [itemInstance](#iteminstance) = ""
+        - [itemInstance](#iteminstance) = 
           {: .sp-string}
 
 === "Gothic 2"
-
     - [zCVob](zCVob.md)
       {: .sp-class}
     - [oCVob](oCVob.md)
       {: .sp-class}
     - oCItem
       {: .sp-class}
-        - [itemInstance](#iteminstance) = ""
+        - [itemInstance](#iteminstance) = 
           {: .sp-string}
 
 === "Gothic 1 (Save)"
-
     - [zCVob](zCVob.md)
       {: .sp-class}
     - [oCVob](oCVob.md)
       {: .sp-class}
     - oCItem
       {: .sp-class}
-        - [itemInstance](#iteminstance) = ""
+        - [itemInstance](#iteminstance) = 
           {: .sp-string}
-        - [amount](#amount) = 0
+        - [amount](#amount) = 
           {: .sp-int}
-        - [flags](#flags) = 0
+        - [flags](#flags) = 
           {: .sp-int}
 
 === "Gothic 2 (Save)"
-
     - [zCVob](zCVob.md)
       {: .sp-class}
     - [oCVob](oCVob.md)
       {: .sp-class}
     - oCItem
       {: .sp-class}
-        - [itemInstance](#iteminstance) = ""
+        - [itemInstance](#iteminstance) = 
           {: .sp-string}
-        - [amount](#amount) = 0
+        - [amount](#amount) = 
           {: .sp-int}
-        - [flags](#flags) = 0
+        - [flags](#flags) = 
           {: .sp-int}
 
 ## Properties
@@ -86,3 +81,4 @@ their attributes. They have physics enabled and can be targeted and picked up by
 
     !!! warning
         This property is only available in saved games.
+

docs/engine/objects/oCItem.yml

@@ -0,0 +1,33 @@
+class:
+  name: "oCItem"
+  bases:
+    - "zCVob"
+    - "oCVob"
+  description: |
+    Represents an item in the game world. Items are special VObjects which are tied to a script instance which defines
+    their attributes. They have physics enabled and can be targeted and picked up by the player.
+  zenkit: "—"
+version:
+  gothic1: 0
+  gothic2: 0
+sources:
+  gothic-library.ru: http://www.gothic-library.ru/publ/class_occstrigger/1-1-0-530
+properties:
+  itemInstance:
+    type: "string"
+    description: "The name of the script instance representing the item."
+    default: ""
+    version: [1, 2]
+    save: false
+  amount:
+    type: "int"
+    description: "Unknown."
+    default: ""
+    version: [1, 2]
+    save: true
+  flags:
+    type: "int"
+    description: "Unknown."
+    default: ""
+    version: [1, 2]
+    save: true