Skip to content

All About Zone Commands

UndeadNappist edited this page Jan 5, 2022 · 3 revisions

Zone commands are used to set up the game world.

To see the current list of zone commands in your current zone, use the zlist command. This will print a list of strings like this:

 19) (always) load (1) The Incarnation of Knowledge (10013) at (10003)
 20) (always) set (east) door at (10021) to (closed)
 21) (always) set (north) door at (10018) to (closed and locked)
 22) (always) load (5) A GMC Bulldog Security (1324) at (10025)
 23) (always) upgrade (-1) a firmpoint external mount (70501) on A GMC Bulldog Security (1324)
 24) (always) upgrade (-1) an AK-97 assault rifle (837) on A GMC Bulldog Security (1324)
 25) (always) load (-1) A road-raging ganger (10015) into A GMC Bulldog Security (1324)
 26) (always) load (-1) a heavily-armed guard (10002) into A GMC Bulldog Security (1324)

The first number is the zone command's index number. You'll need to care about this if you want to edit a specific zone command (zedit <index>), but otherwise it simply specifies the order of command executions.

The (always) field means that this command is executed every time the zone resets. Resets happen on the schedule specified in the zone's settings, or when a staff member uses zreset <zone number>. The other option for this field is (if last), which means this command will only execute if the previous one executed correctly.

The rest of the string describes what the command does, and the parameters being passed to it. We'll go into more detail about the various command types and their parameters in the next section.

The Zone Command Editing Workflow

Once you've zswitched to your zone, you can create a new zone command with zedit add. This will put you in an interface that allows you to specify your command type.

Zone Command Types

1) MOB (load an NPC at a location in the world)
2) OBJECT (load an object at a location in the world)
3) PUT (put an object inside the previous object you loaded)
4) EQUIP (equip an object to the previous NPC you loaded)
5) GIVE (add an object to the inventory of the previous NPC you loaded)
6) REMOVE (remove an object from a room)
7) DOOR (set the state of a door in your zone)
8) GIVE NUMBER (same as #5, but with a quantity)
9) CYBER/BIOWARE (install an object as cyberware to the previous NPC you loaded)
0) VEHICLE (load a vehicle at a location in the world)
A) DRIVER/PASSENGER (load an NPC into the previous vehicle you loaded)
B) UPGRADE (install an upgrade into the previous vehicle you loaded)
C) CARRIED (put an object into the cargo of the previous vehicle you loaded)
D) HOST (load an object into a Matrix host)
n) NOTHING (does nothing; any command set to this will be deleted at next boot)

Zone Conditionals

ALWAYS always happens on reset. IF LAST only happens if the previous zone command succeeded. ONLY set spawn amount to -1 flag when used with IF LAST, because it does not respect count, which can lead to flood.