nzp-team/documentation
0
0
Fork 0
mirror of https://github.com/nzp-team/documentation.git synced 2025-03-13 06:03:07 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update waypointing.md

Browse source 
- Added explanation of .way file structure
This commit is contained in:
Logan 2025-01-22 14:57:41 +00:00 committed by GitHub
parent 7127737f81
commit b437a38c0e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 13 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
markdown/mapping/waypointing.md
View file

@ -10,6 +10,19 @@ _Nazi Zombies: Portable_ makes use of a waypointing system to define nodes that
Waypoints can be edited directly in-game via the waypoint editing mode, foregoing the need to recompile the map when creating or adjusting waypoints. This mode can be accessed via the command `waypoint_mode` cvar. Waypoints can be edited directly in-game via the waypoint editing mode, foregoing the need to recompile the map when creating or adjusting waypoints. This mode can be accessed via the command `waypoint_mode` cvar.
Saving a set of waypoints via this mode will generate a `.way` file within the maps folder of NZ:P; a plain-text file containing data for each node. Saving a set of waypoints via this mode will generate a `.way` file within the maps folder of NZ:P; a plain-text file containing data for each node.
With `.way` files being plain-text, they can be opened in any text editor. Doing so will reveal the following data structure:
![Data structure of a `.way` file when opened in a text editor.](../res/images/waypoint_plain_text.webp)
| Data Identifier | Description |
|---|---|
| Origin | The co-ordinates of the waypoint node. |
| ID | The numerical identifier of the waypoint node. |
| Special | The associated `wayTarget` ID of a valid `nzp_func_door` that has been correctly linked to the waypoint node. |
| Target 1-8 | 8 Possible waypoint nodes that are connected to the waypoint node. |
Another limitation of the waypoint system is that there is a hard limit of 256 total nodes.
## Interacting with Waypoints ## Interacting with Waypoints
![(Left to right) Blue-Default, Yellow-Selected, Red-Linked to Current, Special-Used for Doors (Same 3 colours as previous). ](../res/images/waypoint_types.webp) ![(Left to right) Blue-Default, Yellow-Selected, Red-Linked to Current, Special-Used for Doors (Same 3 colours as previous). ](../res/images/waypoint_types.webp)