Gomoku Five を担当するclassです。

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

クラス説明

クラス直前の Javadoc は見つかりませんでした。ソースとメソッド構成から責務を補完しています。

責務と見どころ

重点クラスの詳細解説

Gomoku Five を担当するclassです。minigame.games パッケージの中でも 628 行規模の中核クラスで、運用中の主ループ・スケジューラが一か所に集まっています。中規模クラス群の中では変更影響が広く、章立てで読む価値が高いため重点解説へ追加しています。

最初に追う読む順番

  1. GomokuFive
    依存オブジェクトと初期状態を束ね、このクラスが担当するランタイムの前提を固めます。
  2. ensureSoloWatchdog
    不足テーブル・設定・内部状態を先に揃える入口です。変更を入れる前提条件の確認地点になります。
  3. loadOrCreateSession
    実体や対象状態を作る段階で、後続フローがどのデータを前提に動くかを掴めます。
  4. join
    実体や対象状態を作る段階で、後続フローがどのデータを前提に動くかを掴めます。
  5. buildBoard
    表示用または出力用のデータを組み立てます。
  6. handleArenaSetupCmd
    運用中の中心ループです。イベント受理から状態更新までの主経路を追えます。
  7. onRightClick
    運用中の中心ループです。イベント受理から状態更新までの主経路を追えます。
  8. onBreak
    運用中の中心ループです。イベント受理から状態更新までの主経路を追えます。
  9. onQuit
    運用中の中心ループです。イベント受理から状態更新までの主経路を追えます。

内部サブシステムの地図

代表フロー詳解

通常運用の中心フロー

  1. handleArenaSetupCmd
  2. onRightClick
  3. onBreak
  4. onQuit

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

変更時の注意点

フィールド

VisibilityTypeName役割
privateJavaPluginpluginプラグイン本体参照です。
privateMinigameDaodaodao の状態を保持します。
privateintQUICK_WIN_BONUS_LIMITQUICK_WIN_BONUS_LIMIT の状態を保持します。
privateintWIN_MULTIPLIERWIN_MULTIPLIER の状態を保持します。
privateintLOSE_MULTIPLIERLOSE_MULTIPLIER の状態を保持します。
privateintSOLO_WAIT_SECONDSSOLO_WAIT_SECONDS の状態を保持します。
privateMap<UUID, Integer>movesPlacedmovesPlaced の状態を保持します。
privateSet<String>arenaIdsarenaIds の状態を保持します。
privateNamespacedKeyKEY_KITKEY_KIT の状態を保持します。
privateNamespacedKeyKEY_FS_ACTIVEKEY_FS_ACTIVE の状態を保持します。
privateNamespacedKeyKEY_FS_GAMEKEY_FS_GAME の状態を保持します。
privateMap<String, Session>sessionssessions の状態を保持します。

コンストラクタ / 初期化

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

メソッド索引

NameVisibilityKind説明
GomokuFivepublicコンストラクタ依存オブジェクトや初期状態を受け取り、このクラスの動作を開始できる状態へ組み立てます。
idpublicメソッドid の主要処理を担当します。
idpublicメソッドid の主要処理を担当します。
idpublicメソッドid の主要処理を担当します。
arenaIdspublicメソッドarenaIds の主要処理を担当します。
arenaIdspublicメソッドarenaIds の主要処理を担当します。
handleArenaSetupCmdpublicメソッド入力やリクエストを受けて、検証・処理・応答までをまとめて担当します。
loadOrCreateSessionprivateメソッド必要な状態を取得し、呼び出し側で利用しやすい形へ返します。
joinpublicメソッドjoin の主要処理を担当します。
ensureSoloWatchdogprivateメソッド必要なテーブル・状態・前提条件が揃っているかを確認し、不足分を補います。
leavepublicメソッドleave の主要処理を担当します。
toppublicメソッドtop の主要処理を担当します。
buildBoardprivateメソッド表示用または出力用のデータを組み立てます。
starPointsprivateメソッドstarPoints の主要処理を担当します。
cleanupBoardprivateメソッドcleanupBoard の主要処理を担当します。
onRightClickpublicイベント処理イベント発生時の分岐と後続処理を担当します。
computeGomokuScoreprivateメソッドcomputeGomokuScore の主要処理を担当します。
onBreakpublicイベント処理イベント発生時の分岐と後続処理を担当します。
onQuitpublicイベント処理イベント発生時の分岐と後続処理を担当します。
finishWithWinnerprivateメソッドfinishWithWinner の主要処理を担当します。
finishNoWinnerprivateメソッドfinishNoWinner の主要処理を担当します。
finishAndScoreprivateメソッドfinishAndScore の主要処理を担当します。
inBoardprivateメソッドinBoard の主要処理を担当します。
isFiveprivateメソッド条件判定を行い、後続処理の分岐に使える真偽値を返します。
countDirprivateメソッドcountDir の主要処理を担当します。
countOneprivateメソッドcountOne の主要処理を担当します。
giveKitprivateメソッドgiveKit の主要処理を担当します。
tagKitprivateメソッドtagKit の主要処理を担当します。
isKitprivateメソッド条件判定を行い、後続処理の分岐に使える真偽値を返します。
stripKitprivateメソッドstripKit の主要処理を担当します。
findSessionByPlayerprivateメソッド必要な状態を取得し、呼び出し側で利用しやすい形へ返します。
announcePlayersprivateメソッドannouncePlayers の主要処理を担当します。
announceTurnprivateメソッドannounceTurn の主要処理を担当します。
broadcastToprivateメソッドbroadcastTo の主要処理を担当します。

メソッド詳細

GomokuFive

コンストラクタpublic
public GomokuFive(JavaPlugin plugin, MinigameDao dao)

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

引数

throws

なし

主要な呼び出し順

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

id

メソッドpublic
public String id()

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

引数

throws

なし

主要な呼び出し順

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

id

メソッドpublic
public String id() { return "arena_gomoku"; } public String displayName()

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

引数

throws

なし

主要な呼び出し順

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

id

メソッドpublic
public String id() { return "arena_gomoku"; } public String displayName() { return "五目並べ"; } public void onRegistered(Plugin pl)

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

引数

throws

なし

主要な呼び出し順

getServergetPluginManagerregisterEvents

arenaIds

メソッドpublic
public List<String> arenaIds()

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

引数

throws

なし

主要な呼び出し順

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

arenaIds

メソッドpublic
public List<String> arenaIds() { return new ArrayList<>(arenaIds); } public void reloadArenas()

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

引数

throws

なし

主要な呼び出し順

cleargetDataFolderexistslistFilesendsWithgetNamesubstringlength

handleArenaSetupCmd

メソッドpublic
public boolean handleArenaSetupCmd(Plugin plugin, CommandSender sender, String arenaId, String subCmd)

入力やリクエストを受けて、検証・処理・応答までをまとめて担当します。

引数

throws

なし

主要な呼び出し順

equalsIgnoreCasereloadArenassendMessage

loadOrCreateSession

メソッドprivate
private Session loadOrCreateSession(String arena, Player context)

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

引数

throws

なし

主要な呼び出し順

getDataFolderexistsloadConfigurationgetWorldrequireNonNullgetStringgetDoublegetInt

join

メソッドpublic
public void join(Player p, String arenaId)

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

引数

throws

なし

主要な呼び出し順

loadOrCreateSessionsendMessagegetUniqueIdcontainsKeysizecontainsValuegiveKitgetPersistentDataContainer

ensureSoloWatchdog

メソッドprivate
private void ensureSoloWatchdog(Session s)

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

引数

throws

なし

主要な呼び出し順

sizecancelmaxrunbroadcastTogetPlayergetPersistentDataContainerremove

leave

メソッドpublic
public void leave(Player player)

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

引数

throws

なし

主要な呼び出し順

findSessionByPlayergetUniqueIdremovestripKitsizekeySetiteratornext

top

メソッドpublic
public List<String> top(String arenaId, String season, int limit)

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

引数

throws

なし

主要な呼び出し順

equalsIgnoreCasecurrentSeasontopLinesDescid

buildBoard

メソッドprivate
private void buildBoard(Session s)

表示用または出力用のデータを組み立てます。

引数

throws

なし

主要な呼び出し順

getWorldgetBlockAtsetTypeisEmptystarPoints

starPoints

メソッドprivate
private int[] starPoints(int size)

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

引数

throws

なし

主要な呼び出し順

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

cleanupBoard

メソッドprivate
private void cleanupBoard(Session s)

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

引数

throws

なし

主要な呼び出し順

setTypeclear

onRightClick

イベント処理public
public void onRightClick(PlayerInteractEvent e)

イベント発生時の分岐と後続処理を担当します。

引数

throws

なし

主要な呼び出し順

getActiongetPlayerfindSessionByPlayergetUniqueIdgetClickedBlockgetYgetXgetZ

computeGomokuScore

メソッドprivate
private long computeGomokuScore(boolean win, int myMoves)

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

引数

throws

なし

主要な呼び出し順

max

onBreak

イベント処理public
public void onBreak(BlockBreakEvent e)

イベント発生時の分岐と後続処理を担当します。

引数

throws

なし

主要な呼び出し順

getPlayerfindSessionByPlayergetUniqueIdgetBlockgetYinBoardgetXgetZ

onQuit

イベント処理public
public void onQuit(PlayerQuitEvent e)

イベント発生時の分岐と後続処理を担当します。

引数

throws

なし

主要な呼び出し順

leavegetPlayer

finishWithWinner

メソッドprivate
private void finishWithWinner(Session s, UUID winner, String reason)

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

引数

throws

なし

主要な呼び出し順

cancelbroadcastTofinishAndScore

finishNoWinner

メソッドprivate
private void finishNoWinner(Session s, String reason)

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

引数

throws

なし

主要な呼び出し順

cancelbroadcastTofinishAndScore

finishAndScore

メソッドprivate
private void finishAndScore(Session s, .jetbrains.annotations.Nullable UUID winner)

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

引数

throws

なし

主要な呼び出し順

currentSeasonkeySetgetPlayerequalsgetOrDefaultcomputeGomokuScorerecordScoreid

inBoard

メソッドprivate
private boolean inBoard(Session s, int x, int z)

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

引数

throws

なし

主要な呼び出し順

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

isFive

メソッドprivate
private boolean isFive(int[][] bd, int x, int y, int color)

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

引数

throws

なし

主要な呼び出し順

countDir

countDir

メソッドprivate
private int countDir(int[][] bd, int x, int y, int dx, int dy, int c)

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

引数

throws

なし

主要な呼び出し順

countOne

countOne

メソッドprivate
private int countOne(int[][] bd, int x, int y, int dx, int dy, int c)

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

引数

throws

なし

主要な呼び出し順

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

giveKit

メソッドprivate
private void giveKit(Player p, int color)

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

引数

throws

なし

主要な呼び出し順

tagKitgetInventoryaddItem

tagKit

メソッドprivate
private void tagKit(ItemStack it)

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

引数

throws

なし

主要な呼び出し順

getItemMetagetPersistentDataContainersetItemMeta

isKit

メソッドprivate
private boolean isKit(ItemStack it)

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

引数

throws

なし

主要な呼び出し順

getItemMetagetPersistentDataContainerhas

stripKit

メソッドprivate
private void stripKit(Player p)

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

引数

throws

なし

主要な呼び出し順

getInventorygetSizegetItemisKitsetItemgetItemInOffHandsetItemInOffHand

findSessionByPlayer

メソッドprivate
private Session findSessionByPlayer(UUID u)

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

引数

throws

なし

主要な呼び出し順

valuescontainsgetPlayerisOnlinegetWorldequalsgetLocationdistanceSquared

announcePlayers

メソッドprivate
private void announcePlayers(Session s)

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

引数

throws

なし

主要な呼び出し順

entrySetstreammapofNullablegetOfflinePlayergetKeygetNameorElse

announceTurn

メソッドprivate
private void announceTurn(Session s)

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

引数

throws

なし

主要な呼び出し順

entrySetstreamfiltergetValuemapofNullablegetOfflinePlayergetKey

broadcastTo

メソッドprivate
private void broadcastTo(Session s, String msg)

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

引数

throws

なし

主要な呼び出し順

getPlayersendMessage

代表的な処理フロー

  1. onBreak フロー
    onBreak → getPlayer → findSessionByPlayer → getUniqueId → getBlock → getY
    イベント発生時の分岐と後続処理を担当します。
  2. onRightClick フロー
    onRightClick → getAction → getPlayer → findSessionByPlayer → getUniqueId → getClickedBlock
    イベント発生時の分岐と後続処理を担当します。
  3. onQuit フロー
    onQuit → leave → getPlayer
    イベント発生時の分岐と後続処理を担当します。
  4. handleArenaSetupCmd フロー
    handleArenaSetupCmd → equalsIgnoreCase → reloadArenas → sendMessage
    入力やリクエストを受けて、検証・処理・応答までをまとめて担当します。
  5. loadOrCreateSession フロー
    loadOrCreateSession → getDataFolder → exists → loadConfiguration → getWorld → requireNonNull
    必要な状態を取得し、呼び出し側で利用しやすい形へ返します。

外部との接点

Web ルート

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

SQL / テーブル

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

関連クラス

補足