Drainage

-- A Kotlin DSL to write inventory UI for Spigot 1.13.2

概要

Spigot上でインベントリを使ったUIを簡単に構築するためのライブラリとなるSpigotプラグインです.

例

player.openInventory(SampleUI) // これでインベントリを開かせる お手軽!

// objectを作成しInventoryUIを実装する UIの実装はlayoutへbuildを使って記述する
object SampleUI : InventoryUI {

    // チェストタイプのUIを構築 標準は9x3
    // 大きさの値を入れることでサイズを指定したチェストタイプのUIも作成できる by build(27)...とこれは等価
    override val layout by build(InventoryType.CHEST) {

        // この階層のthisはInventoryUI型. (この階層含む)以下のブロックではplayerプロパティが使える

        title = "${ChatColor.DARK_BLUE}SampleUI" // インベントリのタイトル

        // UIが開いたときの処理を書く 無くても良い
        // イベントの登録などの処理は全てDrainage側で行うのでここに記述するだけでOK
        onOpen {
            player.world.playSound(player.location, Sound.BLOCK_ENDER_CHEST_OPEN, 1.0f, 1.0f)
        }

        // onOpen同様、UIが閉じたときの処理を書く
        onClose {
            player.world.playSound(player.location, Sound.BLOCK_ENDER_CHEST_CLOSE, 1.0f, 1.0f)
        }

        // デフォルトのスロット putによって埋められなかったスロットは標準でこのスロットになる
        defaultSlot {
            // 名前が1スペースの黒い板ガラス
            icon(Material.BLACK_STAINED_GLASS_PANE) {
                name = " "
            }

            // これはなくてもよい putと同じことを記述できるということを示すために書いた
            // UIの中のItemStackはクリックした際自動で全てイベントキャンセルされる
            onClick {}
        }

        // 8番目のスロットを, 閉じるという名前のバリアブロックの見た目にしてクリックするとUIを閉じるようにする
        put(8) {
            icon(Material.BARRIER) {
                name = "${ChatColor.RED}閉じる"

                // 説明文には文字リテラルを用いる
                // 改行することでItemStack側でも改行される
                lore {
                    """
                        ${ChatColor.GRAY}クリックすることで
                        ${ChatColor.GRAY}このウインドウを閉じます
                    """.trimIndent() // <- IDEAによって自動挿入される
                }

                lore += "${ChatColor.RED}ほげほげ" // += で付け加えることもできます
            }

            // クリックされたときの処理を書く
            // onOpen同様、イベントの登録などの処理は全てDrainage側で行うのでここに記述するだけでOK
            onClick {

                // この階層のthisはInventoryClickEvent型.

                whoClicked.closeInventory() // player.closeInventory()でも良い(はず)
            }
        }

        // 9-17番目のスロットを少し耐久の減ったきらめく鉄の剣にする クリックするとテキストが届く
        // IntRangeも使えるので put(9 until 18) や put(9..17) としても良い
        put(9, 10, 11, 12, 13, 14, 15, 16, 17) { slotIndex ->
            // slotの場所を示す 書かず使わなくても良い

            // IconはItemStackをもとにして作ることもできる
            icon(ItemStack(Material.IRON_SWORD)) {
                damage = (Math.random() * 60.0).toInt()

                gleam() // 光らせるためのユーティリティ
                // やっていることはenchantments += Enchantment.ARROW_INFINITE to 1 と flags += ItemFlag.HIDE_ENCHANTSと同じ

                // rawブロックを使えば 生のItemStackを触ることもできる
                raw {

                    // この階層のthisはItemStack型.

                    itemMeta = itemMeta.apply {
                        displayName = "${ChatColor.RED}rawブロックで名前を書き換えた"
                    }
                }
            }

            filter {
                slotIndex > 13 // slotの場所が13より大きければ有効になる それ以外の場合はdefaultSlotになる
            }

            onClick {
                player.sendMessage("${slot}番目のスロットにある剣をクリックした")
            }
        }
    }

}

環境

• Minecraft 1.13.2 (probably 1.13+)
• Kotlin 1.3.21

導入

1. Releasesからjarファイルをダウンロードし, Spigotサーバのplugins下に配置する
2. 利用するプラグインのGradle/Mavenで依存関係に追加する 詳しくは下記に
3. 利用するプラグインのplugin.ymlのdependsにDrainageを加える
4. Drainageを楽しむ

注釈

• Drainageは利用するプラグインの内包したKotlinに依存します 最新のKotlinを利用してください

Gradle

repositories {
    // ...
    maven { url 'https://jitpack.io' }
}

dependencies {
    // ...
    compileOnly 'com.github.blackbracken:Drainage:<Drainageのバージョン>'
}

Maven

<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>

<dependency>
    <groupId>com.github.blackbracken</groupId>
    <artifactId>Drainage</artifactId>
    <version>Drainageのバージョン</version>
</dependency>

ライセンス

• MIT License