Files
Cites_Plugins/docs/diagrams/moderation-class-diagram.puml
T
Antone Barbaud 4efaa5bbde feat: moderation feature skeleton (/core admin + mod mode + tools)
New feature fr.luc.crcore.features.moderation, opt-in via
CRCoreConfig.setupModeration() (also enabled by setupAll()).

Core abstractions:
- ModerationState: full player snapshot (inv + armor + offhand, XP,
  health, food, location, gamemode, allowFlight/flying, walk/fly speed).
  Immutable, restoreTo(player) restores everything.
- ModerationService interface + ModerationServiceImpl (with
  protected onAfterEnter/onAfterExit hooks) +
  BukkitEventFiringModerationServiceImpl (fires ModerationEnterEvent /
  ModerationExitEvent).
- ModerationRepository interface + InMemoryModerationRepository
  (skeleton — SQLite impl with BukkitObjectOutputStream serialization
  planned).
- ModeratorTool interface: getKey/getSlot(0..8)/buildIcon +
  onLeftClick/onRightClick/onInteractEntity. ModeratorToolRegistry
  preserves registration order, slot collision = replace.
- Exceptions: ModerationException base + AlreadyActive + NotActive.
- Events: ModerationEvent base + Enter + Exit.

5 skeleton tools in the hotbar:
- slot 0: TeleportRandomPlayerTool (compass, right-click → tp random)
- slot 1: InventorySpyTool (chest, right-click on player → open inv)
- slot 2: FreezeTool (ice, right-click on player → toggle freeze)
- slot 7: VanishToggleTool (ender eye, click → toggle vanish)
- slot 8: ExitTool (barrier, click → exit mod mode)
Slots 3-6 free for custom tools.

ModerationListener routes interactions and locks hotbar:
- PlayerInteractEvent → tool.onLeftClick / onRightClick (with cancel).
- PlayerInteractEntityEvent → tool.onInteractEntity (with cancel).
- PlayerDropItemEvent / PlayerSwapHandItemsEvent: cancel for mods.
- InventoryClickEvent: cancel only when top inv is the mod's own inv
  (preserves InventorySpyTool's ability to manipulate target's inv).
- PlayerJoinEvent: re-applies vanish for already-vanished mods.
- PlayerQuitEvent: cleanup freeze state.
- PlayerMoveEvent: cancel block-position changes for frozen players,
  keeping head rotation free.

Mod mode lifecycle:
- enter: snapshot + clear inv + populate hotbar + CREATIVE +
  allowFlight + vanish + ModerationEnterEvent.
- exit: state.restoreTo(player) + unvanish + unfreeze + repo delete +
  ModerationExitEvent.

/core admin (perm crcore.admin, player-only): toggle on/off.
Messages moderation.enter.success / moderation.exit.success added
to crcore-messages.yml.

CRCoreConfig.setupModeration() + isModerationEnabled() flag.
CRCore: buildModerationService() and registerDefaultModeratorTools()
override points, moderation() / getModerationService() getters with
IllegalStateException guard. Builds + registers ModerationListener at
enable() when feature on. CoreCommand extended to take ModerationService;
registers AdminToggleSubCommand only when service non-null.

Skeleton limitations documented in features.md:
- In-memory repo only (server crash = lost inv) — SQLite planned.
- InventorySpyTool opens real inv (no read-only wrapping yet).
- TeleportRandomPlayerTool is a placeholder for a future player-picker
  GUI.
- No moderation.*.broadcast keys yet.
- No /core admin <player> (self-toggle only).

Docs: section 11 in features.md, decision logged in decisions.md
(skeleton scope + rationale), setup.md snippet updated,
new moderation-class-diagram.puml, README.md updated.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-06-10 12:19:21 +02:00

177 lines
5.3 KiB
Plaintext

@startuml moderation-class-diagram
title CR-Core — Moderation feature (class diagram, skeleton)
skinparam classAttributeIconSize 0
hide empty members
package "fr.luc.crcore.features.moderation" {
class ModerationState <<final>> {
- playerId: UUID
- enteredAt: Instant
- inventoryContents: ItemStack[]
- armorContents: ItemStack[]
- offhandItem: ItemStack
- xpLevel: int
- xpProgress: float
- health: double
- foodLevel: int
- saturation: float
- location: Location
- gameMode: GameMode
- allowFlight / flying / walkSpeed / flySpeed
--
+ ModerationState(player)
+ restoreTo(player): void
}
interface ModerationRepository {
+ findByPlayer(uuid): Optional<ModerationState>
+ exists(uuid): boolean
+ save(state): void
+ delete(uuid): boolean
+ findAll(): Collection<ModerationState>
}
interface ModeratorTool {
+ getKey(): String
+ getSlot(): int ' 0..8
+ buildIcon(): ItemStack
+ onLeftClick(player): void
+ onRightClick(player): void
+ onInteractEntity(player, target): void
}
class ModeratorToolRegistry {
- bySlot: Map<Integer, ModeratorTool>
- byKey: Map<String, ModeratorTool>
+ register(tool): void
+ unregister(key): boolean
+ get(key): Optional<ModeratorTool>
+ getBySlot(slot): Optional<ModeratorTool>
+ all(): Collection<ModeratorTool>
}
interface ModerationService {
+ enter(player): void
+ exit(player): void
+ isInModeration(uuid): boolean
+ getState(uuid): Optional<ModerationState>
+ getActiveModerators(): Set<UUID>
--
+ vanish(player) / unvanish / isVanished / getVanishedPlayers
+ freeze(uuid) / unfreeze / isFrozen / getFrozenPlayers
+ getToolRegistry(): ModeratorToolRegistry
}
package "fr.luc.crcore.features.moderation.impl" {
class InMemoryModerationRepository
InMemoryModerationRepository ..|> ModerationRepository
class ModerationServiceImpl {
# plugin: Plugin
# repository: ModerationRepository
# toolRegistry: ModeratorToolRegistry
# vanished: Set<UUID>
# frozen: Set<UUID>
--
# onAfterEnter(player) ' hook
# onAfterExit(player)
}
ModerationServiceImpl ..|> ModerationService
class BukkitEventFiringModerationServiceImpl
BukkitEventFiringModerationServiceImpl --|> ModerationServiceImpl
class ModerationListener {
+ registerOn(plugin): void
--
@ onInteract ' route → tool.onLeftClick / onRightClick
@ onInteractEntity ' route → tool.onInteractEntity
@ onDrop / onSwap ' lock hotbar
@ onInventoryClick ' cancel sur self-inv
@ onJoin ' re-hide vanished players
@ onQuit ' unfreeze
@ onMove ' cancel si frozen
}
ModerationListener ..|> "org.bukkit.event.Listener"
ModerationListener --> ModerationService
}
package "fr.luc.crcore.features.moderation.tool" {
class ExitTool ' slot 8
class VanishToggleTool ' slot 7
class FreezeTool ' slot 2 (entity right-click)
class InventorySpyTool ' slot 1 (entity right-click)
class TeleportRandomPlayerTool ' slot 0
ExitTool ..|> ModeratorTool
VanishToggleTool ..|> ModeratorTool
FreezeTool ..|> ModeratorTool
InventorySpyTool ..|> ModeratorTool
TeleportRandomPlayerTool ..|> ModeratorTool
}
package "fr.luc.crcore.features.moderation.event" {
abstract class ModerationEvent {
- moderator: Player
+ getModerator(): Player
}
ModerationEvent --|> "org.bukkit.event.Event"
class ModerationEnterEvent
class ModerationExitEvent
ModerationEnterEvent --|> ModerationEvent
ModerationExitEvent --|> ModerationEvent
}
package "fr.luc.crcore.features.moderation.exception" {
class ModerationException
class ModerationAlreadyActiveException
class ModerationNotActiveException
ModerationException --|> RuntimeException
ModerationAlreadyActiveException --|> ModerationException
ModerationNotActiveException --|> ModerationException
}
package "fr.luc.crcore.features.moderation.command" {
class AdminToggleSubCommand {
+ execute(ctx): CommandResult
}
AdminToggleSubCommand ..> ModerationService
}
ModerationService ..> ModerationState : reads/writes
ModerationService o--> ModerationRepository
ModerationService o--> ModeratorToolRegistry
ModeratorToolRegistry o--> "*" ModeratorTool
}
package "fr.luc.crcore" {
class CRCore {
+ moderation(): ModerationService
# buildModerationService(repo, registry): ModerationService
# registerDefaultModeratorTools(registry, mod): void
}
CRCore "1" *-- "0..1" ModerationService : owns (if setupModeration)
CRCore ..> ModerationListener : registers
}
note bottom of ModerationServiceImpl
enter(player) :
1. ModerationState snapshot → repo.save
2. clear inventory, set tools in hotbar
3. gamemode CREATIVE + allowFlight
4. vanish(player)
5. onAfterEnter() → event fired
exit(player) :
1. state.restoreTo(player) ' inv + xp + loc + gm + flight
2. unvanish(player)
3. unfreeze + repo.delete
4. onAfterExit() → event fired
Skeleton : in-memory repository only.
Persistance SQLite à venir.
end note
@enduml