Skip to content

Using the creation script

Michael Afrin edited this page Dec 8, 2020 · 6 revisions

Using the creation script

The creation script allows you to easily generate the code for PolyZone, BoxZone, and CircleZone instances. It has a certain level of interactivity to it as well, which can help you tweak these zones prior to them being serialized out to code.

Start creating a zone

The /pzcreate {poly,box,circle} [options] command starts the creation of a PolyZone, BoxZone, or CircleZone. Depending on which of these you choose, the script will ask you to fill out some information if you don't include the options in the command. Each will ask you for the name of the zone, while BoxZone will ask you for length and width as well, and CircleZone will ask for a radius. This command will also turn on the drawing of the zone you are creating, and enable the interactivity controls.

Options for creation (in order)

  • CircleZone
    • name
    • radius
  • BoxZone
    • name
    • length
    • width
  • PolyZone
    • name

Examples

/pzcreate circle - Because this doesn't include any options, the resource will prompt you for some information
/pzcreate circle name_of_circle 2.0 - This will start creating a CircleZone with the name 'name_of_circle' and a radius of 2.0

Editing a zone during creation

There are several ways to tweak the zone you are trying to create, depending on which type of zone it is. The controls to do so are as follows:

CircleZone

Z - Changes useZ option to switch between circle and sphere modes
Scroll Wheel - Changes radius
Alt + Scroll Wheel - Changes height/Z (if in sphere mode)
Arrow keys - Moves center based on camera rotation (up is always forward from the camera, down is towards the camera, etc.)
Ctrl - Hold with any of the above to make them slower

BoxZone

Arrow keys - Same as CircleZone
Ctrl + Arrow keys - Same as CircleZone
Z - Changes between "Scale and rotation" and "Height" modes

Scale and rotation mode

Scroll Wheel - Changes heading/rotation
Alt + Scroll Wheel - Changes width
Shift + Scroll Wheel - Changes length
Ctrl - Hold with any of the above to make them slower

Height mode

Scroll Wheel - Changes Z position of the center of the zone
Alt + Scroll Wheel - Changes minZ of the zone
Shift + Scroll Wheel - Changes maxZ of the zone
Ctrl - Hold with any of the above to make them slower

PolyZone

/pzadd - Adds a point to the zone
/pzundo - Undoes the last point added
Arrow keys - Same as CircleZone, but moves the last placed point in the PolyZone
Ctrl + Arrow keys - Same as above (slower)

Finish creating a zone

Once you are done tweaking the zone, you can finalize the creation by using the /pzfinish command. This will send the finalized zone to the server where it will be serialized into code and put in the polyzone_created_zones.txt file, in the root of your server directory. Open the file up and at the bottom will be the code for your zone!

Cancel creating a zone

If you want to stop creation of the zone, just use the /pzcancel command.

Reusing the last created zone

If you want to create many similar zones in a row, just with different positions, there is a command for you! /pzlast will start creation of a zone using a copy of the last zone that /pzfinish was called on. The only difference is this zone will start at your current position. This only works on BoxZone and CircleZone for now.