Skip to content

Commit

Permalink
docs(VBed): add documentation for oCMobBed
Browse files Browse the repository at this point in the history
  • Loading branch information
lmichaelis committed Dec 30, 2023
1 parent 8fe820b commit 6eddc50
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 0 deletions.
31 changes: 31 additions & 0 deletions docs/engine/objects/oCMobBed.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# oCMobBed

!!! abstract inline end "Quick Infos"
**Type:** Virtual Object<br/>
**Format Name:** ZenGin Archive<br/>
**File Extension:** `.ZEN`<br/>
**Class Name:** `oCMobBed`<br/>
**Version Identifiers:**<br />
— Gothic I: `35585`<br/>
— Gothic II: `35585`<br/>
**ZenKit Class:** `VBed`

VObject marking beds for NPCs and the player to sleep on. In the original Gothic I, there is a bug which prevents
`oCMobBed`s from working correctly, so it is recommended to instead use [`oCMobDoor`](oCMobDoor.md) and attach the
visual of a bed when targeting that platform.

<ul class="sp-list">
<li class="sp-type"><a href="../zCVob/">zCVob</a></li>
<li class="sp-type"><a href="../oCMOB/">oCMOB</a></li>
<li class="sp-type"><a href="../oCMOBInter/">oCMOBInter</a></li>
<li class="sp-type">
<span>oCMobBed</span>
<ul class="sp-list">
<li class="sp-none">&lt;empty&gt;</li>
</ul>
</li>
</ul>

## Sources

The help file for the Spacer, found [here](https://wiki.worldofgothic.de/doku.php?id=spacer:hilfedatei).
2 changes: 2 additions & 0 deletions include/zenkit/vobs/MovableObject.hh
Original file line number Diff line number Diff line change
Expand Up @@ -292,6 +292,8 @@ namespace zenkit {
ZK_OBJECT(ObjectType::oCMobWheel);
};

/// \brief VObject marking beds for NPCs and the player to sleep on.
/// \see https://zk.gothickit.dev/engine/objects/oCMobBed/
struct VBed : VInteractiveObject {
ZK_OBJECT(ObjectType::oCMobBed);

Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ nav:
- 'zCVobStartpoint': 'engine/objects/zCVobStartpoint.md'
- 'oCMOB': 'engine/objects/oCMOB.md'
- 'oCMobInter': 'engine/objects/oCMobInter.md'
- 'oCMobBed': 'engine/objects/oCMobBed.md'
- 'oCMobContainer': 'engine/objects/oCMobContainer.md'
- 'oCMobDoor': 'engine/objects/oCMobDoor.md'
- 'oCMobFire': 'engine/objects/oCMobFire.md'
Expand Down

0 comments on commit 6eddc50

Please sign in to comment.