Regen zones
Areas that put themselves back from a snapshot on a fixed timer or once players stop changing them: creating a zone, Fixed and Idle modes, warnings, what happens to players inside, flags, re-saving and deleting.
A regen zone is a box of the world with a saved snapshot of its blocks. On a timer, or once players have stopped touching it for a while, the zone is put back exactly as the snapshot says: whatever was built is removed and whatever was broken comes back. Each zone is also a region, so the same box can carry flags (PvP, build, break, item drops...) and work as a protected area that resets itself.
The module is on by default (modules.regen-zones in config.yml). Everything is set up in game from
/regenzonesadmin (permission exyliawarzone.regenzones.admin) or the Regen zones card of
/warzoneadmin (exyliawarzone.admin, which includes it).
Creating a zone
Create it
In /regenzonesadmin, click Create and type an id: lowercase letters, digits, _ and -, up
to 64 characters (spaces become _). The id must be free on every server sharing the database. The zone's
screen opens; Display name sets the name players see in warnings.
Select the region
Click Zone region. You are handed the selector (a golden axe by default): left-click one corner, right-click the opposite one, then shift + left-click to confirm. Both corners are inside the box.
Take the snapshot
Build the area the way it should always look, then click Schematic. The blocks in the box are saved as they are now; entities are not part of it. Chat says when the save is done, or why it failed.
Choose when it regenerates
Open Regeneration: pick the mode, then the interval (Fixed) or the idle delay (Idle), and for Fixed
zones the warning. Times are typed as 30s, 5m, 1h30m or 1d.
A new zone starts on, in Fixed mode, with the defaults from the module's configuration: every 5 minutes, a 1 minute idle delay and a 10 second warning, with Lift trapped players and Clean entities on. It does nothing until it has both a region and a snapshot.
Fixed and Idle
| Mode | Regenerates | Warning |
|---|---|---|
| Fixed (fixed timer) | Every interval, whether or not anything changed. The interval is at least 5 seconds. | Yes |
| Idle (after changes stop) | Once the zone has gone the idle delay without a block change. Every change starts the delay over. | No |
Fixed suits arenas and builds that should reset on a schedule. The timer starts when the region is selected and on every server start, and starts over when the zone is turned on, switched to Fixed, given a new interval or regenerated by hand.
Idle suits areas players use now and then: a zone being fought over keeps postponing its reset until everybody leaves it alone. A change is a block broken, placed, burnt or blown up inside the zone, also by an explosion that started outside it. A zone nobody touched never regenerates; its screen says After the next change. Changes made while the server was off are never seen, so after a restart each Idle zone is put back once, an idle delay later. Switching a zone to Idle or turning an Idle zone on does the same.
The warning
A Fixed zone warns the players standing inside it warning seconds before it regenerates: a title, a
short sound and a boss bar counting down to the regeneration. Only players inside when the warning starts
get it. Set the warning to 0s to turn it off. The title and boss bar are under visuals in the module's
messages file, the sound in its config.yml.
What happens during a regeneration
- With Clean entities on, every entity in the box that is not a player is removed: dropped items, arrows, but also mobs, armour stands and item frames.
- The blocks go back as the snapshot has them, air included. Chests and other containers get back exactly what they held in the snapshot.
- With Lift trapped players on, anyone the new blocks would bury is moved up to the nearest free space. Players themselves are never removed.
- Players inside hear the regen sound.
The plugin also forgets which blocks players had placed in the zone, so a temporary block (from the
TEMPORARY_BLOCKS flag) never vanishes later out of the freshly pasted build.
A regeneration only runs while every chunk of the zone is loaded. When it is due and nobody is near, the screen says Due (when its chunks load) and it runs as soon as somebody comes close enough to load them. A failed regeneration leaves the zone as it was and writes the reason to the console.
With FastAsyncWorldEdit installed, snapshots are saved and pasted through it. Without it, ExyliaLib's
built-in engine does the work. Both read and write the same .schem files, so installing or removing FAWE
never means re-saving. The built-in engine keeps blocks, container contents, sign text and spawner types,
but not banner patterns, head owners, lectern books or command block commands, and it handles boxes up to
512 × 256 × 512 blocks. Use FAWE for anything bigger.
The zone's screen
| Card | What it does |
|---|---|
| Status | Turns the zone on or off. Shows the next regeneration and how many players are inside, live. |
| Display name | The name shown in warnings and confirmations. |
| Zone region | Selects the box. |
| Region flags | Opens the zone's flag editor (needs a region first). |
| Schematic | Takes the snapshot, or replaces it. |
| Regeneration | Mode, interval or idle delay, and warning. |
| Lift trapped players | Moves buried players up after a regeneration. |
| Clean entities | Removes every non-player entity before a regeneration. |
| Regenerate now | Puts the zone back right away, after a confirmation. |
| Delete | Removes the zone, after a confirmation. |
Next regen reads as a time, None (off, no region or no snapshot), After the next change (an untouched Idle zone), Due or Regenerating.... The zone list shows the same for every zone, along with its mode, region, snapshot and state. Left-click a zone to edit it, right-click to delete it.
Region flags
A zone's box is one of Warzone's regions, so its flags apply to everyone inside it except players in creative mode. Select the region first, then click Region flags: the editor opens over the zone's current flags and they apply as soon as you save. Every flag, and the block list and temporary block time that go with them, is explained on Region flags.
Changing a zone later
- New snapshot: after changing the build, click Schematic again. You are asked first, because the old snapshot is lost.
- New region: re-selecting keeps the zone's flags, block list and temporary block time. It does not take a new snapshot: save one right after, or the next regeneration pastes the old build at the new spot.
- Turning it off: no regenerations and no warnings while it is off. Its region and flags stay in place.
- Regenerate now: undoes whatever was built or broken since the snapshot. Refused while the zone is already regenerating. On a Fixed zone the timer starts over.
- Deleting: removes the zone, its flags and its saved snapshot. The blocks in the world stay as they are, and a new zone with the same id starts with no snapshot.
Where things are kept
- Snapshots:
plugins/ExyliaWarzone/schematics/regenzone_<id>.schem. Files inschematics/regions/are read too. - Zones: the
sc_regen_zonestable. On a database shared by several servers, each server loads and lists only its own zones. A zone whose world is not loaded shows its region as Not set and does nothing. - Creating, deleting and Regenerate now are recorded in the staff log,
/exylialib logs. - Zones and snapshots from ExyliaSurvivalCore are picked up on their own; see Migrating.
Something missing on this page? Tell us on Discord