4everCraft Mod/com.evermod.minigames.arena/EverArenas

EverArenas

Persistent arena definitions and template export utilities.

Arenas are defined by:

a stable key (lowercase a-z0-9_-),
the source dimension id, and
at least two points (inclusive bounds are derived from all points).

Templates are exported to .nbt files compatible with Nucleoid map-templates.

Types

data class ArenaDefinition(val key: String, val dimension: String, val pos1: EverArenas.ArenaPos, val pos2: EverArenas.ArenaPos, val extraPoints: List<EverArenas.ArenaPos>? = null, val spawnMarkers: List<EverArenas.ArenaPos>? = null, val yBounds: EverArenas.ArenaYBounds? = null)

Stored arena definition.

ArenaExtras

data class ArenaExtras(val extraPoints: List<BlockPos> = emptyList(), val spawnMarkers: List<BlockPos> = emptyList(), val yBounds: EverArenas.ArenaYBounds? = null)

Additional arena data beyond bounds: extra boundary points and spawn markers.

ArenaPos

data class ArenaPos(val x: Int, val y: Int, val z: Int)

JSON-serializable position.

ArenaYBounds

data class ArenaYBounds(val minY: Int, val maxY: Int)

Manual Y bounds used for template export scanning.

DefineResult

sealed interface DefineResult

Result of defining an arena.

DeleteResult

sealed interface DeleteResult

Result of deleting an arena definition.

RefreshAllResult

data class RefreshAllResult(val ok: Int, val failed: Int, val results: Map<String, EverArenas.RefreshResult>)

Aggregated result for refreshing all templates.

RefreshResult

sealed interface RefreshResult

Result of refreshing a single template.

Functions

all

fun all(): List<EverArenas.ArenaDefinition>

Returns all configured arenas sorted by key.

define

fun define(key: String, dimension: Identifier, pos1: BlockPos, pos2: BlockPos, yBounds: EverArenas.ArenaYBounds? = null): EverArenas.DefineResult

Creates or updates an arena definition.

defineWithExtraPoints

fun defineWithExtraPoints(key: String, dimension: Identifier, pos1: BlockPos, pos2: BlockPos, extras: EverArenas.ArenaExtras = ArenaExtras()): EverArenas.DefineResult

Creates or updates an arena definition with additional points.

delete

fun delete(key: String, deleteTemplate: Boolean = true): EverArenas.DeleteResult

Deletes an arena definition and (optionally) its exported template file.

exists

fun exists(key: String): Boolean

Returns true if an arena definition exists for the given key.

find

fun find(key: String): EverArenas.ArenaDefinition?

Returns a single arena definition if present.

loadTemplate

fun loadTemplate(server: MinecraftServer, key: String): MapTemplate?

Loads a previously exported template by key.

maxExportBlocks

fun maxExportBlocks(): Long

Returns the current maximum allowed export volume in blocks.

refreshAll

fun refreshAll(server: MinecraftServer): EverArenas.RefreshAllResult

Exports all stored arenas.

refreshTemplate

fun refreshTemplate(server: MinecraftServer, key: String): EverArenas.RefreshResult

Exports an arena to config/evermod/arenas/templates/<key>.nbt.

validateKeyForUserInput

fun validateKeyForUserInput(key: String): String?

Validates an arena key and returns a human-readable error message, or null if valid.