Document nzp_xmas2 features

Author: MotoLegacy

markdown/internal/weapon-ids.md

@@ -57,6 +57,7 @@ Note that Pack-A-Punch variants of weapons do not contain a string identifier at
 - Panzerschreck - `panzerschreck` - `17`
 - Ray Gun - `ray_gun` - `20`
 - Wunderwaffe DG-2 - `wunderwaffe` - `56`
+- Ray Gun Mk II - `ray_gun_2` - `60`
 
 ## Pack-A-Punch Weapons
 
@@ -105,4 +106,5 @@ Note that Pack-A-Punch variants of weapons do not contain a string identifier at
 - F1W Nitrogen Cooled (M2 Flamethrower) - `35`
 - Longinus (Panzerschreck) - `50`
 - The Krauss Refibrillator (Ballistic Knife) - `53`
-- Wunderwaffe DG-3 JZ (Wunderwaffe DG-2) - `57`
+- Wunderwaffe DG-3 JZ (Wunderwaffe DG-2) - `57`
+- Porter's Mark II Ray Gun (Ray Gun Mk II) - `61`

markdown/landing/index.md

@@ -70,7 +70,12 @@ Documentation and by extension headers/categories are a work in progress.
 - [Zombie Horde Points](../mapping/zombie-horde-points.md)
 - [Random Perk-A-Cola Machines](../mapping/random-perks.md)
 
+### Point Entities
+- [info_changesky](../mapping/info_changesky.md)
+- [game_screenflash](../mapping/game_screenflash.md)
+
 ### Map Triggers
+- [Trigger and Target Extensions](../mapping/trigger-extensions.md)
 - [trigger_setfire](../mapping/trigger_setfire.md)
 - [trigger_awardpoints](../mapping/trigger_awardpoints.md)
 - [trigger_interact](../mapping/trigger_interact.md)

markdown/mapping/game_screenflash.md

@@ -0,0 +1,23 @@
+% game_screenflash - NZ:P Mapping Documentation
+# game_screenflash
+
+## Introduction
+
+`game_screenflash` is a point entity used to flash all Client's screens for a specified amount of time, useful for cinematic events.
+
+## Features
+
+### Fields
+
+| Field Name | Field ID | Default Value | Description |
+|---|---|---|---|
+| Sound to Play on Trigger | `noise` | `""` | Sound played during the screen flash.
+| Screen Flash Color | `weapon` | `0` | Color to flash the screen (`0` for white, `1` for black).
+| Flash Duration | `ltime` | `2` | Amount of seconds the flash lasts, including fade in and fade out.
+| Round Delay | `currentammo` | `10` | Delay before next round starts (if spawnflag `1` is set).
+
+### Spawnflags
+
+| Spawnflag Name | Spawnflag ID | Default Value | Description |
+|---|---|---|---|
+| End Current Round | `1` | `false` | Whether the screen flash should end the current Round.

markdown/mapping/info_changesky.md

@@ -0,0 +1,14 @@
+% info_changesky - NZ:P Mapping Documentation
+# info_changesky
+
+## Introduction
+
+`info_changesky` is a point entity used to update the Sky Box across all clients. Upon activation, the current skybox textures will be freed and the specified ones will be streamed and loaded. Due to this overhead, there may be a performance cost for the act of changing the sky and as such it should be used conservatively.
+
+## Features
+
+### Fields
+
+| Field Name | Field ID | Default Value | Description |
+|---|---|---|---|
+| Sky Name | `name` | `""` | Sky box name (e.g. `"ndu"`)

markdown/mapping/trigger-extensions.md

@@ -0,0 +1,22 @@
+% Trigger and Target Extensions - NZ:P Mapping Documentation
+# Trigger and Target Extensions
+
+## Introduction
+
+_Nazi Zombies: Portable_ contains several extensions and changes on top of Quake/Half-Life triggers to cater to the co-operative nature of the game and it's feature set.
+
+## Changes
+
+### `message` Key
+
+When an entity is _used_, the `message` will be presented to all clients alive, as opposed to the client who was responsible for the target firing.
+
+## Extensions
+
+### Multi-Targets
+
+Entities can target multiple entities different `targetname`s. There can be up to 8, the additional 7 being activated via `target2` - `target8`. Standard functionality of activating multiple entities with the same `targetname` is still supported on top of this.
+
+### Round-based Delays
+
+Introduced via the `round_delay` key, upon firing a target you can insert a Round-based delay before it is activated. This takes presidence over `delay`.

markdown/mapping/trigger_interact.md

@@ -3,4 +3,10 @@
 
 ## Introduction
 
-`trigger_interact` is a brush-based trigger used to fire targets when a Client in its collision box presses their Interact button. There is no Use String provided, making it optimal for "secrets".
+`trigger_interact` is a brush-based trigger used to fire targets when a Client in its collision box presses their Interact button. There is no Use String provided, making it optimal for "secrets".
+
+### Spawnflags
+
+| Spawnflag Name | Spawnflag ID | Default Value | Description |
+|---|---|---|---|
+| Inactive until Triggered | `1` | `false` | Sets whether the `trigger_interact` should be disabled until activated via target.

markdown/mapping/wall-weapons.md

@@ -13,6 +13,8 @@ Nazi Zombies: Portable features purchaseable weapons off-the-wall in the same ve
 
 `buy_weapon` triggers have three important fields. The weapon you wish to be purchaseable (`weapon`), the cost of the weapon (`cost`), and the cost of ammunition after initial weapon purchase (`cost2`).
 
+Using the _"Inactive until Triggered"_ spawnflag (`1`), you can disable the ability to purchase the off-the-wall weapon until it is activated via target.
+
 ### _Call of Duty_'s Defined Weapon Costs
 
 _Call of Duty: World at War_ and _Call of Duty: Black Ops_ use consistent prices for their off-the-wall weapons in game. These prices, sorted from highest to lowest, are as follows (any weapon not listed here is a weapon not available off-the-wall in an official capacity):