Warps
Publishing a protection as a public warp, the warps list and its sorting, visiting by menu or by name, how visits are counted, star ratings, and the warps keys.
With submodules.warps, a protection can be published as a public warp: a place anybody may visit from a
list or by name, and rate from one to five stars. A protection has at most one warp. Warps are off by
default.
Publishing a warp
Public warp in a protection's Extras section opens its warp screen. It needs the role permission
manage-warp, which no default role has, so only the owner manages the warp until a role is given it.
| Button | What it does |
|---|---|
| Publish | Publishes the warp, or takes it down. Publishing needs the protection to have a home |
| Land here | Moves where visitors land to where you stand, inside the protection, on its server and world |
| Rename | Types the warp's name |
| Icon | Chooses the item the warp shows in the list |
| Description | Types a line shown under the warp in the list |
A new warp lands on the protection's home, is named after the protection and shows default-icon. Names and
descriptions are stored as plain text: colour codes and tags are stripped, and anything past
name-max-length or description-max-length is cut. A name does not have to be unique.
Taking a warp down, or deleting its protection, deletes its visits and ratings with it. Every change is written to the protection's log.
The warp keeps the spot it was given. Moving the protection's core, or setting a new home, leaves visitors landing where the warp was; press Land here inside the protection again after moving it.
The warps list
/protections warps, or Public warps in /protections, lists the warps of every server.
| Click | What it does |
|---|---|
| Left-click a warp | Visits it |
| Right-click a warp | Rates it, one to five stars. Your current rating is offered first |
| Sort | Cycles Most visited → Best rated → Newest |
Each row shows the warp's name and stars, its description, the owner, the protection, its server and world, the visits, the average rating and how many players rated it. Ties in visits or rating go to the newest; a tie in the average goes to the warp with more ratings first.
With hide-unavailable on, warps a player cannot enter right now are left out of their list: the protection is
locked or they are banned from it, or it is raidable or abandoned. With it off they are listed, and the visit is
refused.
Visiting
A visit from the list, or /protections warp <name>, teleports the player to the warp's spot with the home
warmup, settings.home-warmup-seconds, on whichever server the protection is. Names are matched ignoring case;
when several warps share one, the most visited wins. The command completes the names of the warps the player's
list shows.
Members of the protection may always visit its warp. Anybody else only while they could walk in: not while it is locked to them, they are banned, or it is raidable or abandoned.
Counting visits. A visit counts once per player per day, after the teleport arrives, whichever server they
arrive from. Members' visits never count, and neither does a refused one. The day is the calendar day in UTC.
Each new visit adds one to the warp's running total, which every server adds to at once without overwriting
each other. With the survival core installed, each counted visit also counts protections.warp_visits for the
visitor.
The total keeps every visit ever. The per-day records that stop a second count are only needed until the day ends: every six hours, records older than yesterday are deleted. A warp published before the running total existed gets its total counted once from its records, on the first start after updating.
Ratings
Anybody but the owner rates a warp, members included, with one to five stars from the list. A player has one rating per warp; rating again replaces it. A player does not need to have visited it.
The average is shown with one decimal, and the stars rounded to the nearest whole one, so an average of 4.5 shows five filled stars.
Placeholders
These read the warp of the protection the player stands in, and are blank when it has none.
| Placeholder | What it returns |
|---|---|
%exyliaprotections_protections_warp_rating% | Its average rating, with one decimal |
%exyliaprotections_protections_warp_visits% | Its total visits |
Keys
| Key | Default | What it does |
|---|---|---|
submodules.warps | false | Turns warps on |
warps.name-max-length | 24 | The longest name a warp may have |
warps.description-max-length | 64 | The longest description a warp may have |
warps.hide-unavailable | true | Whether warps a player cannot enter right now are hidden from their list. Off: listed, and the visit refused |
warps.default-icon | LODESTONE | The icon a new warp starts with |
submodules:
warps: false
warps:
name-max-length: 24
description-max-length: 64
hide-unavailable: true
default-icon: LODESTONETurning warps off hides the list, the command and the warp screen, and keeps every warp, visit and rating for
when they are turned back on. Warps are stored in protections_warps, ratings in protections_warp_ratings,
the per-day visit records in protections_warp_visits and the running totals in protections_warp_totals.
Something missing on this page? Tell us on Discord