Class: RankingPluginApi

RankingPlugin 専用 API。

0Fields
0Constructors
15Methods
35Lines
Package
com.example.rankingplugin.api
Source
api/RankingPluginApi.java
Kind
interface
Roles
自動抽出なし
このクラスにも章立て解説を追加しています。 自動抽出の一覧だけでなく、下の『重点クラスの詳細解説』で読む順番・内部サブシステム・変更時の注意点まで追えます。 全クラス章立てガイドを見る

クラス説明

RankingPlugin 専用 API。

他プラグインからは Bukkit ServicesManager 経由で取得できます。
例:
  RankingPluginApi api = Bukkit.getServicesManager().load(RankingPluginApi.class);

責務と見どころ

重点クラスの詳細解説

RankingPlugin 専用 API。api パッケージの 小規模クラスで、契約/値オブジェクトを確認する起点です。全面展開版では、他の重点クラスと同じ章立てで読めるように補強しています。

最初に追う読む順番

  1. getServerId
    必要な状態を取得し、呼び出し側で利用しやすい形へ返します。
  2. getScore
    必要な状態を取得し、呼び出し側で利用しやすい形へ返します。
  3. addScore
    addScore の主要処理を担当します。
  4. setScore
    setScore の主要処理を担当します。
  5. getRank
    必要な状態を取得し、呼び出し側で利用しやすい形へ返します。
  6. getTopScores
    必要な状態を取得し、呼び出し側で利用しやすい形へ返します。
  7. getMonthlyTop
    必要な状態を取得し、呼び出し側で利用しやすい形へ返します。
  8. getCurrency
    必要な状態を取得し、呼び出し側で利用しやすい形へ返します。

内部サブシステムの地図

状態反映と永続化

メモリ状態と保存状態を揃え、結果を次の呼び出しや画面表示へ繋ぐ部分です。

主なメソッド
setScore setCurrency
主なフィールド
なし

代表フロー詳解

初期化と起動の流れ

  1. getServerId
  2. getScore
  3. getRank
  4. getTopScores
  5. getMonthlyTop

このクラスが前提状態を揃え、外部から利用可能な形まで立ち上がる流れです。新規依存の追加や起動失敗の調査はまずここから追います。

通常運用の中心フロー

  1. setScore
  2. setCurrency

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

反映・保存・終了の流れ

  1. setScore
  2. setCurrency

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

変更時の注意点

  • この型は実装より契約やデータ形状が重要です。追加変更時は利用側との整合を先に確認すると安全です。

フィールド

VisibilityTypeName役割
フィールドは抽出されませんでした。

コンストラクタ / 初期化

Signature説明主要呼び出し
明示コンストラクタは抽出されませんでした。

メソッド索引

NameVisibilityKind説明
getServerIdpackageメソッド必要な状態を取得し、呼び出し側で利用しやすい形へ返します。
getScorepackageメソッド必要な状態を取得し、呼び出し側で利用しやすい形へ返します。
addScorepackageメソッドaddScore の主要処理を担当します。
setScorepackageメソッドsetScore の主要処理を担当します。
getRankpackageメソッド必要な状態を取得し、呼び出し側で利用しやすい形へ返します。
getTopScorespackageメソッド必要な状態を取得し、呼び出し側で利用しやすい形へ返します。
getMonthlyToppackageメソッド必要な状態を取得し、呼び出し側で利用しやすい形へ返します。
getCurrencypackageメソッド必要な状態を取得し、呼び出し側で利用しやすい形へ返します。
addCurrencypackageメソッドaddCurrency の主要処理を担当します。
setCurrencypackageメソッドsetCurrency の主要処理を担当します。
isOnlineHerepackageメソッド条件判定を行い、後続処理の分岐に使える真偽値を返します。
isOnlineElsewherepackageメソッド条件判定を行い、後続処理の分岐に使える真偽値を返します。
getOnlineServerspackageメソッド必要な状態を取得し、呼び出し側で利用しやすい形へ返します。
getJackpotPoolpackageメソッド必要な状態を取得し、呼び出し側で利用しやすい形へ返します。
getMiniJackpotPoolpackageメソッド必要な状態を取得し、呼び出し側で利用しやすい形へ返します。

メソッド詳細

getServerId

メソッドpackage
String getServerId()

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

引数

  • 引数なし

throws

なし

主要な呼び出し順

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

getScore

メソッドpackage
long getScore(String playerName)

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

引数

  • String playerName

throws

なし

主要な呼び出し順

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

addScore

メソッドpackage
long addScore(String playerName, long delta)

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

引数

  • String playerName
  • long delta

throws

なし

主要な呼び出し順

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

setScore

メソッドpackage
void setScore(String playerName, long score)

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

引数

  • String playerName
  • long score

throws

なし

主要な呼び出し順

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

getRank

メソッドpackage
int getRank(String playerName)

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

引数

  • String playerName

throws

なし

主要な呼び出し順

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

getTopScores

メソッドpackage
List<RankingEntry> getTopScores(int limit)

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

引数

  • int limit

throws

なし

主要な呼び出し順

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

getMonthlyTop

メソッドpackage
List<RankingEntry> getMonthlyTop(YearMonth month, int limit)

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

引数

  • YearMonth month
  • int limit

throws

なし

主要な呼び出し順

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

getCurrency

メソッドpackage
long getCurrency(String playerName)

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

引数

  • String playerName

throws

なし

主要な呼び出し順

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

addCurrency

メソッドpackage
long addCurrency(String playerName, long amount)

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

引数

  • String playerName
  • long amount

throws

なし

主要な呼び出し順

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

setCurrency

メソッドpackage
void setCurrency(String playerName, long amount)

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

引数

  • String playerName
  • long amount

throws

なし

主要な呼び出し順

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

isOnlineHere

メソッドpackage
boolean isOnlineHere(String playerName)

条件判定を行い、後続処理の分岐に使える真偽値を返します。

引数

  • String playerName

throws

なし

主要な呼び出し順

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

isOnlineElsewhere

メソッドpackage
boolean isOnlineElsewhere(String playerName)

条件判定を行い、後続処理の分岐に使える真偽値を返します。

引数

  • String playerName

throws

なし

主要な呼び出し順

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

getOnlineServers

メソッドpackage
Set<String> getOnlineServers(String playerName)

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

引数

  • String playerName

throws

なし

主要な呼び出し順

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

getJackpotPool

メソッドpackage
long getJackpotPool()

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

引数

  • 引数なし

throws

なし

主要な呼び出し順

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

getMiniJackpotPool

メソッドpackage
long getMiniJackpotPool()

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

引数

  • 引数なし

throws

なし

主要な呼び出し順

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

代表的な処理フロー

  1. 明確な処理フローは抽出されませんでした。

外部との接点

Web ルート

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

SQL / テーブル

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

関連クラス

補足