4everCraft Mod/com.evermod.lorekeeper/LorekeeperOutpostService

LorekeeperOutpostService

Handles permanent Lorekeeper outposts (HQ + settlement newsies) backed by world persistence.

Types

data class ForceRespawnResult(val hqConfigured: Boolean, val hqRespawned: Boolean, val newsieSitesConsidered: Int, val newsiesRespawned: Int, val staleSitesRemoved: Int)

Summary of one force-respawn operation.

ForceRespawnTarget

enum ForceRespawnTarget : Enum<LorekeeperOutpostService.ForceRespawnTarget>

Scope selector for forced outpost respawn operations.

PlacementKind

enum PlacementKind : Enum<LorekeeperOutpostService.PlacementKind>

Kind of permanent outpost lectern placement to apply.

Functions

buildHqLocationMessage

fun buildHqLocationMessage(player: ServerPlayer): String

Returns a lorekeeper-style message guiding the player to HQ.

canPlaceOutpostLectern

fun canPlaceOutpostLectern(player: ServerPlayer, level: ServerLevel, placementKind: LorekeeperOutpostService.PlacementKind): Boolean

Validates whether this player can place an outpost lectern now.

forceRespawn

fun forceRespawn(level: ServerLevel, target: LorekeeperOutpostService.ForceRespawnTarget): LorekeeperOutpostService.ForceRespawnResult

Force-respawns outpost NPCs for the provided dimension.

grantHqLectern

fun grantHqLectern(player: ServerPlayer)

Grants an HQ lectern placement item to an admin player.

grantNewsieLectern

fun grantNewsieLectern(player: ServerPlayer)

Grants a settlement newsie lectern placement item to an admin player.

isHqLorekeeper

fun isHqLorekeeper(entity: LorekeeperEntity): Boolean

Returns true when this Lorekeeper entity is the HQ Lorekeeper.

isNewsie

fun isNewsie(entity: LorekeeperEntity): Boolean

Returns true when this Lorekeeper entity is a settlement newsie.

isOutpostLorekeeper

fun isOutpostLorekeeper(entity: LorekeeperEntity): Boolean

Returns true when this Lorekeeper entity is a permanent outpost NPC.

onOutpostLecternPlaced

fun onOutpostLecternPlaced(level: ServerLevel, player: ServerPlayer, clickedPos: BlockPos, face: Direction, placementKind: LorekeeperOutpostService.PlacementKind)

Finalizes outpost placement from a successful lectern item placement.

fun register()

Registers outpost penalties and maintenance ticking.

sendHqLocation

fun sendHqLocation(player: ServerPlayer)

Sends the local-dimension HQ coordinates, if configured.