Arenas - Phoenix Duels - Docs

Arenas

Add-on

Building an FFA arena, from its regions and style to kits, rules, regeneration, Grid Mode and groups.

On this page

Template
Arena Style
Loadout and Kits
Rules
Sub Regions
Time and Weather
Scoreboard and Tablist
Regeneration
Grid Mode
Arena Groups

Arenas are created and edited from Arenas in /ffa editor. A disabled arena is switched off completely: players inside it are not tracked, and the selector, kit signs, /ffa randomtp and game modes skip it.

#Template

The template holds the arena's regions and locations. Create Template only succeeds once the universal region, the battle region, at least one spawn location and the lobby location are set, and Grid Mode stays locked until it has.

Part	What it does
Universal Region	The arena itself. Walking or teleporting into it joins the arena, leaving it leaves the arena. Setting it the first time also sets the battle region to the same box.
Battle Region	Must sit fully inside the universal region. With the Premade Kit loadout, the kit is handed out when a player enters it. It is also where the Hunger Games border starts and where Mob Killing mobs are kept.
Safe Region	No player can hurt another while either of them stands in it, and no kit is handed out there.
Spawn Locations	Random entry points when the arena has no lobby location, the Hunger Games starting spots and the Mob Killing mob spawns.
Lobby Location	Where the arena selector, kit signs, /ffa randomtp and /leave send players, and where refused players are pushed back to. Players who log in inside the arena are moved here.
Spectator Location	Where /ffaspectate and eliminated game mode players go. Spectating is off without it. Must be inside the universal region.
Loot Chest Locations	The Hunger Games chests. Each one needs a real chest block.

#Arena Style

A Public arena has no limits: anyone can walk in. A Restricted arena unlocks four more settings on right-click.

Setting	What it does
Max Players	Players allowed in at once, spectators not counted. 0 means no limit. phoenixffa.arena.bypassfull ignores it.
Minimum Players	Players a Mob Killing or Hunger Games game waits for before its countdown starts. Hunger Games always waits for at least 2.
Start Countdown	Seconds that countdown lasts.
Join Permission	A permission every player needs to get in.

Minimum Players and Start Countdown only matter to Mob Killing and Hunger Games. Only Restricted arenas take part in those game modes when they are linked through a group.

#Loadout and Kits

Loadout	What players fight with
Premade Kit	A kit linked to the arena, handed out when they enter the battle region. Their inventory is cleared on entry.
Player Inventory	Whatever they walk in with.
None	Nothing. Their inventory is cleared on entry.

Linked Kits decides which kits an arena offers. Players pick one through the kit selector or a kit sign. A player who picked nothing, or picked a kit whose permission they lack, gets the arena's fallback kit, and no kit at all when there is no fallback either. After a death the same kit is handed out again on the next entry to the battle region.

Kits are built under Kits in the editor: items per slot including armor and off-hand, display icon, an optional permission, and kit rules that apply while that kit is the one the player was given.

Kit items belong to the arena that handed them out. They disappear when dropped outside it, cannot be picked up by players outside it or by hoppers, and are taken away when the player leaves.

#Rules

Rules change how fighting works, from cooldowns and extra hearts to soup, golden heads and Heal on Kill, which heals the killer by a share of their maximum health. The full list, with each rule's own options, is under Rules in the arena editor.

Rules can sit on three levels: the arena, a sub-region, where they only apply while the player stands inside it, and a kit.

#Sub Regions

Sub regions are boxes inside the universal region, each with its own rules, a regeneration toggle and actions that run when a player enters or leaves it. The universal, battle and safe regions appear in the list on their own, so they can carry rules and actions as well. When regions overlap, the player is in all of them: each region's rules apply and its actions run on entering and leaving it. The smallest one counts as the player's current region.

The arena itself also has enter and leave actions, on the second page of the arena editor. Action lines use the [TYPE] value format, with the types ACTION_BAR, BROADCAST, CLOSE_INVENTORY, COMMAND, GAMEMODE, MESSAGE, SOUND and TITLE. %player% and PlaceholderAPI placeholders work in them.

#Time and Weather

Each arena can lock the time to sunrise, day, noon, sunset, night or midnight, and the weather to clear or rain. Only players inside the arena see it, and it goes back to normal when they leave.

#Scoreboard and Tablist

Both are set per arena on the second page of the arena editor, and both accept PlaceholderAPI placeholders and MiniMessage.

The scoreboard has a header that cycles through its lines as an animation, and up to 15 lines. The tablist has a header, a footer, a refresh rate and a prefix in front of each player's name.

Placeholder	Scoreboard	Tablist	Value
%arena%	Yes	Yes	The arena's display name.
%arena_players%	Yes	Yes	Players in the arena, spectators excluded.
%kills%	Yes		The player's kills in this arena.
%deaths%	Yes		The player's deaths in this arena.
%kdr%	Yes		The player's kill/death ratio in this arena.
%streak%	Yes	Yes	The player's current kill streak in this arena.
%max_streak%	Yes		The player's best kill streak in this arena.
%player%		Yes	The player's name.
%online%		Yes	Players online on the server.
%max_online%		Yes	The server's player limit.

#Regeneration

Regeneration is what lets players build and break blocks in an arena. While it is on, every region with its own regeneration toggle on is restored every few minutes, set by the timer. The battle region starts with its toggle on.

Engine	How it restores
Internal	Built in. Restores only the blocks that changed, spread over several ticks.
WorldEdit	Pastes a schematic. Needs WorldEdit or FastAsyncWorldEdit, and is heavy on large arenas without FAWE.

Turning regeneration on, or a region's toggle on, captures the current state of the regions, and Generate Schematics captures it again after you change the build. A region with nothing captured is skipped.

Inside an enabled arena, blocks can only be placed or broken, and containers such as chests only opened, inside a region whose regeneration toggle is on, and only while the arena's regeneration is on. This applies to staff as well, so disable the arena while you build it. Explosions never break the protected blocks.

%phoenixffa_ffa_regeneration_<arena>% shows the seconds left until the next restore.

#Grid Mode

Grid Mode copies a finished arena into a grid of new arenas. Each copy gets the build, the arena's settings, and its regions, spawns, loot chests, lobby and spectator locations moved to the new spot. You choose the number of columns and rows, the original counting as the first cell, and the blocks of space between copies. The copy uses the arena's regeneration engine, so the WorldEdit engine needs WorldEdit installed here too.

The new arenas go into the original arena's group, or into a new group named after it when it has none.

/ffa undogrid, or the clickable message sent when the grid finishes, removes the new arenas and puts back what was there before. It works for five minutes, and only for the admin who generated the grid.

#Arena Groups

A group bundles arenas, usually copies of the same map. Turn on grouping in the arena list, then click two arenas to group them, or an arena and a group to add it. An arena can only be in one group.

The first arena in a group is its main arena. Its editor gets Enforce Changes, which copies its settings onto every other arena in the group while each keeps its own identifier.

A group can be linked to a Mob Killing or Hunger Games game mode instead of linking its arenas one by one. Only its Restricted arenas take part, see Game Modes.