Class: DiscordXpService

Discordボイス接続時間でEXPを付与し、レベルに応じて Minecraft の最大体力を増やす。

23Fields
1Constructors
17Methods
402Lines
Package
com.example.rankingplugin.discordxp
Source
discordxp/DiscordXpService.java
Kind
class
Roles
非同期 / スケジューラ初期化 / ブートストラップサービス層
このクラスにも章立て解説を追加しています。 自動抽出の一覧だけでなく、下の『重点クラスの詳細解説』で読む順番・内部サブシステム・変更時の注意点まで追えます。 全クラス章立てガイドを見る

クラス説明

Discordボイス接続時間でEXPを付与し、レベルに応じて Minecraft の最大体力を増やす。

責務と見どころ

重点クラスの詳細解説

Discordボイス接続時間でEXPを付与し、レベルに応じて Minecraft の最大体力を増やす。discordxp パッケージの中でも 402 行規模の中核クラスで、スケジューラが一か所に集まっています。中規模クラス群の中では変更影響が広く、章立てで読む価値が高いため重点解説へ追加しています。

最初に追う読む順番

  1. DiscordXpService
    依存オブジェクトと初期状態を束ね、このクラスが担当するランタイムの前提を固めます。
  2. ensureTables
    不足テーブル・設定・内部状態を先に揃える入口です。変更を入れる前提条件の確認地点になります。
  3. start
    定期処理や公開 API の起動地点で、外部から見える挙動がここから立ち上がります。
  4. loadOrDefault
    実体や対象状態を作る段階で、後続フローがどのデータを前提に動くかを掴めます。
  5. applyHealthBonus
    結果を反映・永続化する境界です。表示だけ直って保存が壊れる系の切り分けに向きます。
  6. updateBossBars
    結果を反映・永続化する境界です。表示だけ直って保存が壊れる系の切り分けに向きます。
  7. shutdown
    後片付けと停止の出口です。残骸や再ログイン後の不整合はここを確認します。
  8. migrateOnlineHealthBonuses
    migrateOnlineHealthBonuses の主要処理を担当します。
  9. addXpSync
    addXpSync の主要処理を担当します。

内部サブシステムの地図

代表フロー詳解

通常運用の中心フロー

  1. updateBossBars
  2. removeBossBar
  3. applyHealthBonus

イベント受理、判定、状態更新、通知までの主経路です。体感不具合や想定外の分岐はこの流れのどこで止まるかを見ると切り分けやすいです。

反映・保存・終了の流れ

  1. updateBossBars
  2. removeBossBar
  3. applyHealthBonus
  4. shutdown

結果を保持し、必要なら永続化し、最後に掃除まで行う出口です。画面更新だけ合って保存が壊れるケースや残骸が残るケースの確認に向きます。

変更時の注意点

  • Bukkit 実体やワールド状態を触る処理はスレッド境界を崩さないようにしてください。重い計算だけを分離し、実体操作は既存の同期経路へ寄せるのが安全です。

フィールド

VisibilityTypeName役割
privateStringserverIdserverId の状態を保持します。
publiclongBASE_REQBASE_REQ の状態を保持します。
publiclongREQ_INCREQ_INC の状態を保持します。
publicintHEALTH_PER_LEVELHEALTH_PER_LEVEL の状態を保持します。
privateStringHEALTH_MOD_KEYHEALTH_MOD_KEY の状態を保持します。
privateUUIDLEGACY_HEALTH_MOD_UUIDLEGACY_HEALTH_MOD_UUID の状態を保持します。
privateJavaPluginpluginプラグイン本体参照です。
privateDiscordLinkServicelinklink の状態を保持します。
privateDiscordXpDaodaodao の状態を保持します。
privateSet<UUID>dirtydirty の状態を保持します。
privateMap<UUID, DiscordXpDao.Stats>cacheキャッシュまたは直近計算結果を保持します。
privateMap<UUID, BossBarRenderCache>bossBarRenderCacheキャッシュまたは直近計算結果を保持します。
privateDiscordVoicePresenceListenerpresencepresence の状態を保持します。
privateinttickTaskId非同期処理やスケジューラ制御に使うハンドルです。
privateintflushTaskId非同期処理やスケジューラ制御に使うハンドルです。
privatelongexpPerSecondexpPerSecond の状態を保持します。
privateJDAjdajda の状態を保持します。
privatebooleanpauseOnStatusEnabledpauseOnStatusEnabled の状態を保持します。
privateSet<OnlineStatus>pauseStatusespauseStatuses の状態を保持します。
privatebooleanbossBarEnabledbossBarEnabled の状態を保持します。
privateintbossBarTaskId非同期処理やスケジューラ制御に使うハンドルです。
privateMap<UUID, BossBar>bossBarsbossBars の状態を保持します。
privatelonglastForcedFlushAtlastForcedFlushAt の状態を保持します。

コンストラクタ / 初期化

Signature説明主要呼び出し
public DiscordXpService(JavaPlugin plugin, DataSource ds, DiscordLinkService link, String serverId)依存オブジェクトや初期状態を受け取り、このクラスの動作を開始できる状態へ組み立てます。trim

メソッド索引

NameVisibilityKind説明
DiscordXpServicepublicコンストラクタ依存オブジェクトや初期状態を受け取り、このクラスの動作を開始できる状態へ組み立てます。
ensureTablespublicメソッド必要なテーブル・状態・前提条件が揃っているかを確認し、不足分を補います。
startpublicメソッド初期化と各種登録を行い、機能を有効化します。
migrateOnlineHealthBonusesprivateメソッドmigrateOnlineHealthBonuses の主要処理を担当します。
addXpSyncprivateメソッドaddXpSync の主要処理を担当します。
shutdownpublicメソッド動作中の処理やリソースを安全に停止・解放します。
isPausedByStatusprivateメソッドDiscordのプレゼンス状態（退席中/取り込み中など）でXP加算を停止する。
updateBossBarsprivateメソッド状態を永続化または更新し、最新状態へ反映します。
removeBossBarprivateメソッド対象データや登録状態を削除・解除します。
clearBossBarsprivateメソッドclearBossBars の主要処理を担当します。
flushNowpublicメソッドDB への問い合わせまたは更新処理を担当します。
loadOrDefaultprivateメソッド必要な状態を取得し、呼び出し側で利用しやすい形へ返します。
getXppublicメソッド必要な状態を取得し、呼び出し側で利用しやすい形へ返します。
getLevelpublicメソッド必要な状態を取得し、呼び出し側で利用しやすい形へ返します。
getRequiredpublicメソッド必要な状態を取得し、呼び出し側で利用しやすい形へ返します。
requiredExpForNextpublicメソッドrequiredExpForNext の主要処理を担当します。
applyHealthBonuspublicメソッドapplyHealthBonus の主要処理を担当します。

メソッド詳細

DiscordXpService

コンストラクタpublic
public DiscordXpService(JavaPlugin plugin, DataSource ds, DiscordLinkService link, String serverId)

依存オブジェクトや初期状態を受け取り、このクラスの動作を開始できる状態へ組み立てます。

引数

  • JavaPlugin plugin
  • DataSource ds
  • DiscordLinkService link
  • String serverId

throws

なし

主要な呼び出し順

trim

ensureTables

メソッドpublic
public void ensureTables()

必要なテーブル・状態・前提条件が揃っているかを確認し、不足分を補います。

引数

  • 引数なし

throws

なし

主要な呼び出し順

getLoggerseveregetMessage

start

メソッドpublic
public void start(JDA jda, Set<String> targetVoiceChannelIds, long expPerSecond, int flushSeconds, boolean pauseOnStatusEnabled, Set<OnlineStatus> pauseStatuses, boolean bossBarEnabled)

初期化と各種登録を行い、機能を有効化します。

引数

  • JDA jda
  • Set<String> targetVoiceChannelIds
  • long expPerSecond
  • int flushSeconds
  • boolean pauseOnStatusEnabled
  • Set<OnlineStatus> pauseStatuses
  • boolean bossBarEnabled

throws

なし

主要な呼び出し順

maxisEmptycopyOfnoneOfaddEventListenergetGuildsforEachgetVoiceStates

migrateOnlineHealthBonuses

メソッドprivate
private void migrateOnlineHealthBonuses()

migrateOnlineHealthBonuses の主要処理を担当します。

引数

  • 引数なし

throws

なし

主要な呼び出し順

getOnlinePlayersisOnlinegetLevelgetUniqueIdapplyHealthBonusgetLoggerwarninggetName

addXpSync

メソッドprivate
private void addXpSync(Player p, UUID uuid, long add)

addXpSync の主要処理を担当します。

引数

  • Player p
  • UUID uuid
  • long add

throws

なし

主要な呼び出し順

computeIfAbsentrequiredExpForNextapplyHealthBonus

shutdown

メソッドpublic
public void shutdown()

動作中の処理やリソースを安全に停止・解放します。

引数

  • 引数なし

throws

なし

主要な呼び出し順

getSchedulercancelTaskflushNowclearBossBars

isPausedByStatus

メソッドprivate
private boolean isPausedByStatus(long discordId)

Discordのプレゼンス状態（退席中/取り込み中など）でXP加算を停止する。

引数

  • long discordId

throws

なし

主要な呼び出し順

isEmptygetGuildIdForgetGuildByIdgetMemberByIdgetOnlineStatuscontains

updateBossBars

メソッドprivate
private void updateBossBars()

状態を永続化または更新し、最新状態へ反映します。

引数

  • 引数なし

throws

なし

主要な呼び出し順

keySetgetPlayerisOnlineremoveBossBargetOnlinePlayersgetUniqueIdgetDiscordIdisEmpty

removeBossBar

メソッドprivate
private void removeBossBar(UUID uuid)

対象データや登録状態を削除・解除します。

引数

  • UUID uuid

throws

なし

主要な呼び出し順

removeremoveAllsetVisible

clearBossBars

メソッドprivate
private void clearBossBars()

clearBossBars の主要処理を担当します。

引数

  • 引数なし

throws

なし

主要な呼び出し順

keySetremoveBossBarclear

flushNow

メソッドpublic
public void flushNow()

DB への問い合わせまたは更新処理を担当します。

引数

  • 引数なし

throws

なし

主要な呼び出し順

isEmptyremoveAllbatchUpsertgetLoggerwarninggetMessage

loadOrDefault

メソッドprivate
private DiscordXpDao.Stats loadOrDefault(UUID uuid)

必要な状態を取得し、呼び出し側で利用しやすい形へ返します。

引数

  • UUID uuid

throws

なし

主要な呼び出し順

loadorElseGet

getXp

メソッドpublic
public long getXp(UUID uuid)

必要な状態を取得し、呼び出し側で利用しやすい形へ返します。

引数

  • UUID uuid

throws

なし

主要な呼び出し順

computeIfAbsent

getLevel

メソッドpublic
public int getLevel(UUID uuid)

必要な状態を取得し、呼び出し側で利用しやすい形へ返します。

引数

  • UUID uuid

throws

なし

主要な呼び出し順

computeIfAbsent

getRequired

メソッドpublic
public long getRequired(UUID uuid)

必要な状態を取得し、呼び出し側で利用しやすい形へ返します。

引数

  • UUID uuid

throws

なし

主要な呼び出し順

getLevelrequiredExpForNext

requiredExpForNext

メソッドpublicstatic
public static long requiredExpForNext(int currentLevel)

requiredExpForNext の主要処理を担当します。

引数

  • int currentLevel

throws

なし

主要な呼び出し順

目立つ内部呼び出しは抽出されませんでした。

applyHealthBonus

メソッドpublicstatic
public static void applyHealthBonus(Player p, int level)

applyHealthBonus の主要処理を担当します。

引数

  • Player p
  • int level

throws

なし

主要な呼び出し順

getAttributemaxreplacegetValuegetHealthsetHealth

代表的な処理フロー

  1. 初期化フロー
    DiscordXpService → trim
    依存オブジェクトや初期状態を受け取り、このクラスの動作を開始できる状態へ組み立てます。
  2. start フロー
    start → max → isEmpty → copyOf → noneOf → addEventListener
    初期化と各種登録を行い、機能を有効化します。
  3. updateBossBars フロー
    updateBossBars → keySet → getPlayer → isOnline → removeBossBar → getOnlinePlayers
    状態を永続化または更新し、最新状態へ反映します。
  4. loadOrDefault フロー
    loadOrDefault → load → orElseGet
    必要な状態を取得し、呼び出し側で利用しやすい形へ返します。
  5. ensureTables フロー
    ensureTables → getLogger → severe → getMessage
    必要なテーブル・状態・前提条件が揃っているかを確認し、不足分を補います。
  6. shutdown フロー
    shutdown → getScheduler → cancelTask → flushNow → clearBossBars
    動作中の処理やリソースを安全に停止・解放します。

外部との接点

Web ルート

このクラス内に目立つ Web ルート定義は見つかりませんでした。

SQL / テーブル

テーブル名の抽出はありませんでした。

関連クラス

補足