-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(VirtualObject): add documentation for
zCVob
- Loading branch information
1 parent
4c866e3
commit 3fac84e
Showing
6 changed files
with
413 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,227 @@ | ||
| # zCVob | ||
|
|
||
| !!! abstract inline end "Quick Infos" | ||
| **Type:** Virtual Object<br/> | ||
| **Format Name:** ZenGin Archive<br/> | ||
| **File Extension:** `.ZEN`<br/> | ||
| **Class Name:** `zCVob`<br/> | ||
| **Version Identifier:**<br /> | ||
| — Gothic I: `12289`<br/> | ||
| — Gothic II: `52224`<br/> | ||
| **ZenKit Class:** `VirtualObject` | ||
|
|
||
| Represents so-called virtual objects which appear in the game world. `zCVob` is the base class for all virtual | ||
| objects which include everything from static models like boxes to interactive elements like doors and chests and | ||
| invisible trigger objects. They are also referred to as VObjects in this documentation. | ||
|
|
||
| <ul class="sp-list"> | ||
| <li class="sp-type"> | ||
| <span>zCVob</span> | ||
| <ul class="sp-list"> | ||
| <li class="sp-folder"> | ||
| <span>Internals</span> | ||
| <ul class="sp-list"> | ||
| <li class="sp-int"><a href="#pack">pack</a> = 0</li> | ||
| <li class="sp-string"><a href="#presetname">presetName</a> = ""</li> | ||
| <li class="sp-misc"><a href="#bbox3dws">bbox3DWS</a> = 0 0 0 0 0 0</li> | ||
| <li class="sp-misc"><a href="#trafoostowsrot">trafoOSToWSRot</a> = 0</li> | ||
| <li class="sp-vec"><a href="#trafoostowspos">trafoOSToWSPOS</a> = 0 0 200</li> | ||
| </ul> | ||
| </li> | ||
| <li class="sp-folder"> | ||
| <span>Vob</span> | ||
| <ul class="sp-list"> | ||
| <li class="sp-string"><a href="#vobname">vobName</a> = ""</li> | ||
| <li class="sp-string"><a href="#visual">visual</a> = ""</li> | ||
| <li class="sp-bool"><a href="#showvisual">showVisual</a> = TRUE</li> | ||
| <li class="sp-enum"><a href="#visualcamalign">visualCamAlign</a> = NONE</li> | ||
| <li class="sp-enum"><a href="#visualanimode">visualAniMode</a> = NONE</li> | ||
| <li class="sp-float"><a href="#visualanimodestrength">visualAniModeStrength</a> = 0.0</li> | ||
| <li class="sp-float"><a href="#vobfarclipzscale">vobFarClipZScale</a> = 1.0</li> | ||
| <li class="sp-bool"><a href="#cdstatic">cdStatic</a> = FALSE</li> | ||
| <li class="sp-bool"><a href="#cddyn">cdDyn</a> = FALSE</li> | ||
| <li class="sp-bool"><a href="#staticvob">staticVob</a> = FALSE</li> | ||
| <li class="sp-enum"><a href="#dynshadow">dynShadow</a> = DS_NONE</li> | ||
| <li class="sp-int"><a href="#zbias">zbias</a> = 1</li> | ||
| <li class="sp-bool"><a href="#isambient">isAmbient</a> = FALSE</li> | ||
| </ul> | ||
| </li> | ||
| <li class="sp-type">visual = NULL</li> | ||
| <li class="sp-type">ai = NULL</li> | ||
| </ul> | ||
| </li> | ||
| </ul> | ||
|
|
||
| ## Properties | ||
|
|
||
| <a name="pack" class="t-int"></a> `pack` | ||
|
|
||
| : Internal property which indicates how the data associated with this VObject is stored. Can not be changed in the | ||
| Spacer and is inaccessible in *ZenKit*. | ||
|
|
||
| <a name="presetname" class="t-str"></a> `presetName` | ||
|
|
||
| : The name of the template used to create this VObject in the Spacer. Exposed as a normal field by *ZenKit*. | ||
|
|
||
|
|
||
| <a name="bbox3dws" class="t-raw"></a> `bbox3DWS` | ||
|
|
||
| : The 3-dimensional bounding box of this VObject to be used for collision detection. This is used in conjunction with | ||
| [`cdStatic`](#cdstatic) and [`cdDyn`](#cddyn) to detect whether two VObject are colliding. Depending on the kind of | ||
| VObject collision with it may do different things which are documented for each VObject separately. | ||
|
|
||
| The bounding box is described by two opposite diagonal points in 3D world space coordinates. | ||
|
|
||
| <a name="trafoostowsrot" class="t-raw"></a> `trafoOSToWSRot` | ||
|
|
||
| : The rotation of this VObject in world space, represented by a 3x3 rotation matrix. | ||
|
|
||
| <a name="trafoostowspos" class="t-vec"></a> `trafoOSToWSPos` | ||
|
|
||
| : The coordinates of this VObject in world space. | ||
|
|
||
| <a name="vobname" class="t-str"></a> `vobName` | ||
|
|
||
| : The name of this VObject. VObject names are not necessarily unique but are sometimes helpful for identifying them. | ||
| For some VObjects, like [zCVobSpot](zCVobSpot.md) or [zCTrigger](zCTrigger.md) setting the `vobName` is required | ||
|
|
||
| <a name="visual" class="t-str"></a> `visual` | ||
|
|
||
| : The name of the visual component associated with this VObject. This is usually the name of a file containing the | ||
| data for a visual object. The following file formats are supported: | ||
|
|
||
| * `*.3DS` — Static models | ||
| * `*.PFX` — Particle effects | ||
| * `*.TGA` — Textures | ||
| * `*.MDS`, `.ASC` — Interactive or rigged models | ||
| * `*.MMS` — Morph-mesh animated models | ||
|
|
||
| <a name="showvisual" class="t-bool"></a> `showVisual` | ||
|
|
||
| : Indicates whether this VObject should display its associated visual. | ||
| <br /> `TRUE` — Display the visual. `FALSE` — Hide the visual. | ||
|
|
||
| <a name="visualcamalign" class="t-enum"></a> `visualCamAlign` | ||
|
|
||
| : Indicates how this VObject should be aligned in relation to the camera. This may be used with grass or flowers | ||
| which only consist of a 2-dimensional sprite to have it always face the camera, for example. Possible value are | ||
|
|
||
| * `NONE` — The sprite is not affected by the camera's rotation. | ||
| * `YAW` — The sprite rotates with the camera's yaw axis. | ||
| * `FULL` — The sprite rotates alonside the camera. | ||
|
|
||
| <a name="visualanimode" class="t-enum"></a> `visualAniMode` | ||
|
|
||
| : The type of wind animation to apply to the VObject. One of | ||
|
|
||
| * `NONE` — No wave animation. | ||
| * `WIND` — Indicates that the object should be animated as if shifting in strong wind. Used mostly for animating | ||
| grass and other small foliage. | ||
| * `WIND2` — Indicates that the object should be animated as if shifting in light wind. Used mostly for animating trees. | ||
|
|
||
| <a name="visualanimodestrength" class="t-float"></a> `visualAniModeStrength` | ||
|
|
||
| : Indicates the strength of the animation set through [`visualAniMode`](#visualanimode). This value is ignored if | ||
| [`visualAniMode`](#visualanimode) is set to `NONE`. | ||
|
|
||
| <a name="vobfarclipzscale" class="t-float"></a> `vobFarClipZScale` | ||
|
|
||
| : Indicates the draw distance of this VObject. Its value should be between 0 and 2. 0 Means, that this object is | ||
| never drawn on screen but collisions are still calculated. A value of 2 means, that the draw distance of this | ||
| VObject is the same as the draw distance specified in the [`zCZoneVobFarPlane`](zCZoneVobFarPlane.md) object. | ||
|
|
||
| <a name="cdstatic" class="t-bool"></a> `cdStatic` | ||
|
|
||
| : Indicates whether this VObject should collide with other VObjects. This is used for placing the object in the | ||
| ZenGin map editor, the *Spacer*, where it will prevent the VObject being placed wither other VObjects. This setting | ||
| is irrelevant for runtime collision detection. | ||
|
|
||
| * `TRUE` — Collide with all other VObjects. | ||
| * `FALSE` — Don't collide with other static VObjects. | ||
|
|
||
|
|
||
| <a name="cddyn" class="t-bool"></a> `cdDyn` | ||
|
|
||
| : Indicates whether this VObject should collide with dynamic objects. For this purpose, dynamic objects are the | ||
| player, NPCs and items. If this flag is set, implementations should apply collision detection to this VObject. | ||
|
|
||
| * `TRUE` — Collide with dynamic VObjects. | ||
| * `FALSE` — Don't collide with dynamic VObjects. | ||
|
|
||
| <a name="staticvob" class="t-bool"></a> `staticVob` | ||
|
|
||
| : Indicates whether this VObject should be included during static lighting calculations. These lighting calculations | ||
| are done at compile-time and will bake VObjects with this flag into the light-maps available from the world mesh. | ||
|
|
||
| * `TRUE` — Exclude this VObject from dynamic lighting calculations. | ||
| * `FALSE` — Include this VObject in dynamic lighting calculations. | ||
|
|
||
| <a name="dynshadow" class="t-enum"></a> `dynShadow` | ||
|
|
||
| : The type of dynamic shadow to be used for this VObject. | ||
|
|
||
| * `DS_NONE` — The VObject does not cast any shadow. | ||
| * `DS_BLOB` — The VObject casts a dark circle at its base. | ||
|
|
||
| <a name="zbias" class="t-int"></a> `zbias` | ||
|
|
||
| : The depth-bias for this VObject. This value is passed directly to Direct3D when rendering the associated visual of | ||
| this VObject. Sadly, because documentation is not available for the very old Direct3D version used by the ZenGin, | ||
| the exact behavior it would have resulted in are unknown. | ||
|
|
||
| <a name="isambient" class="t-bool"></a> `isAmbient` | ||
|
|
||
| : Indicates that this VObject is *ambient*. It looks like this VObject setting was a system used during development | ||
| when access to the game's source code was available. Basically, the global variable `zCWorld::s_bAmbientVobsEnabled` | ||
| could be used to hide or show VObjects which have the `isAmbient` flag set. In release builds, this variable is | ||
| always set to `true`, thus the `isAmbient` flag does not have any perceivable effect on the game. It follows, that | ||
| this field should be ignored by most implementations. | ||
|
|
||
| ## Hierarchy | ||
|
|
||
| The following list shows the virtual object class hierarchy. Click on any of the VObjects to see more details. | ||
|
|
||
| * [zCVob](zCVob.md) | ||
| * [zCVobSpot](zCVobSpot.md) | ||
| * [zCVobStair](zCVobStair.md) | ||
| * [zCVobStartpoint](zCVobStartpoint.md) | ||
| * [zCVobLevelCompo](zCVobLevelCompo.md) | ||
| * [zCCSCamera](zCCSCamera.md) | ||
| * [zCCamTrj_KeyFrame](zCCamTrj_KeyFrame.md) | ||
| * [zCVobLight](zCVobLight.md) | ||
| * [zCVobAnimate](zCVobAnimate.md) | ||
| * [oCItem](oCItem.md) | ||
| * [zCVobLensFlare](zCVobLensFlare.md) | ||
| * [zCPFXController](zCPFXController.md) | ||
| * [zCMessageFilter](zCMessageFilter.md) | ||
| * [zCCodeMaster](zCCodeMaster.md) | ||
| * [zCMoverController](zCMoverController.md) | ||
| * [oCTouchDamage](oCTouchDamage.md) | ||
| * [zCEarthquake](zCEarthquake.md) | ||
| * [oCNpc](oCNpc.md) | ||
| * [zCVobScreenFX](zCVobScreenFX.md) | ||
| * [oCMOB](oCMOB.md) | ||
| * [oCMobInter](oCMobInter.md) | ||
| * [oCMobFire](oCMobFire.md) | ||
| * [oCMobContainer](oCMobContainer.md) | ||
| * [oCMobDoor](oCMobDoor.md) | ||
| * [oCMobLadder](oCMobLadder.md) | ||
| * [oCMobSwitch](oCMobSwitch.md) | ||
| * [oCMobWheel](oCMobWheel.md) | ||
| * [oCMobBed](oCMobBed.md) | ||
| * [zCVobSound](zCVobSound.md) | ||
| * [zCVobSoundDaytime](zCVobSoundDaytime.md) | ||
| * [zCTrigger](zCTrigger.md) | ||
| * [oCCSTrigger](oCCSTrigger.md) | ||
| * [zCMover](zCMover.md) | ||
| * [zCTriggerList](zCTriggerList.md) | ||
| * [oCTriggerScript](oCTriggerScript.md) | ||
| * [oCTriggerChangeLevel](oCTriggerChangeLevel.md) | ||
| * [zCTriggerWorldStart](zCTriggerWorldStart.md) | ||
| * [zCTriggerUntouch](zCTriggerUntouch.md) | ||
| * [oCZoneMusic](oCZoneMusic.md) | ||
| * [oCZoneMusicDefault](oCZoneMusicDefault.md) | ||
| * [zCZoneVobFarPlane](zCZoneVobFarPlane.md) | ||
| * [zCZoneVobFarPlaneDefault](zCZoneVobFarPlaneDefault.md) | ||
| * [zCZoneZFog](zCZoneZFog.md) | ||
| * [zCZoneZFogDefault](zCZoneZFogDefault.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.