Difference between revisions of "Proc:Neighborhood"
| Line 20: | Line 20: | ||
| PROC_ENABLED | | PROC_ENABLED | ||
| Standard proc key - must be set to 1. | | Standard proc key - must be set to 1. | ||
| + | |- | ||
| + | | RESERVE | ||
| + | | A colon separated list of direction names to reserve for future growth. This will prevent building houses in these directions. The list can contain full names (north, east, south) or abbreviations (w, u, d). If this value does not exist, players will be able to build in any direction where an existing room exit has not been defined. | ||
|} | |} | ||
Revision as of 19:36, 18 September 2021
Overview
The neighborhood procedure allows players to build houses that attach to the current room. It also handles the outdoor portion of keyless entry if purchased in a house.
KVP
The neighborhood proc uses standard KVP to enable it. These KVP values are:
| Key | Description |
|---|---|
| CFG_ID | Standard proc key - must be set to 1. |
| PROC_NUM | Standard proc key - must be set to 3. |
| PROC_ENABLED | Standard proc key - must be set to 1. |
| RESERVE | A colon separated list of direction names to reserve for future growth. This will prevent building houses in these directions. The list can contain full names (north, east, south) or abbreviations (w, u, d). If this value does not exist, players will be able to build in any direction where an existing room exit has not been defined. |
Survey Command
The survey command is enabled by the procedure and is used by players to find available locations for building houses. New houses can only be built in directions that do not currently have an exit. Exits can be reserved for future use by creating an exit in the desired direction to room -1.
Build Command
The build command is enabled by the procedure and allows players to build a house if they are carrying an appropriate hovel object. The command syntax is build <hovel object> <direction> <one or more door names>. If the player has an appropriate hovel object and nothing exists in the direction specified, a new house will be created in that direction. If this is the player's first house, a key will be created and given to the player.
Vault Keyless Entry
The neighborhood proc caches the keyless entry phrases for neighboring house/vault rooms with keyless entry. These cached values can be seen via the command STATPROC ROOM even though they are not stored in KVP. When keyless entry is purchased or modified, the vault proc notifies the neighborhood to update its cache. Similarly, if a player enters a keyless entry phrase, the neighborhood proc checks the neighboring vault procs to make sure the player is on the permitted list of the appropriate vault. If so, the player is teleported inside.
